Managed Object - SmsStorageManager(sms.StorageManager)

Returned by
QueryStorageManager
See also
BackingStoragePool, Datastore, DatastoreBackingPoolMapping, DrsMigrationCapabilityResult, FaultDomainFilter, FaultDomainId, GroupOperationResult, HostSystem, ReplicationGroupFilter, SmsProvider, SmsProviderSpec, StorageArray, StorageCapability, StorageContainerResult, StorageContainerSpec, StorageFileSystem, StorageLun, StoragePort, StorageProcessor
Since
SMS API 2.0


Managed Object Description

The SmsStorageManager managed object (SMS) provides methods to retrieve information about available storage topology, capabilities, and state. SMS establishes and maintains connections with VASA providers. SMS retrieves information about storage availability from the providers, and clients can use the SMS API to perform the following operations.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
QueryArray, QueryArrayAssociatedWithLun, QueryAssociatedBackingStoragePool, QueryDatastoreBackingPoolMapping, QueryDatastoreCapability, QueryDrsMigrationCapabilityForPerformance, QueryDrsMigrationCapabilityForPerformanceEx, QueryFaultDomain, QueryFileSystemAssociatedWithArray, QueryHostAssociatedWithLun, QueryLunAssociatedWithArray, QueryLunAssociatedWithPort, QueryNfsDatastoreAssociatedWithFileSystem, QueryPortAssociatedWithArray, QueryPortAssociatedWithLun, QueryPortAssociatedWithProcessor, QueryProcessorAssociatedWithArray, QueryProvider, QueryReplicationGroupInfo, QueryStorageContainer, QueryVmfsDatastoreAssociatedWithLun, RegisterProvider_Task, SmsRefreshCACertificatesAndCRLs_Task, UnregisterProvider_Task

QueryArray(queryArray)

Get the list of storage arrays managed by all the registered VASA providers.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
providerId*xsd:string[]

List of uid for the VASA provider objects.
*Need not be set

Return Value

Type Description
StorageArray[]List of data objects containing information about StorageArray.

Faults

Type Description
NotFoundThrown if the given providerId does not have any reference.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryArrayAssociatedWithLun(queryArrayAssociatedWithLun)

Get the StorageArray object that is associated with the ScsiLun.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
canonicalNamexsd:string

canonicalName of ScsiLun

Return Value

Type Description
StorageArrayStorageArray for the for the ScsiLun.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryAssociatedBackingStoragePool(queryAssociatedBackingStoragePool)

Query Backing Storage Pools for StorageLun or StorageFileSystem.
Required Privileges
StorageViews.View
Since
SMS API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
entityId*xsd:string

Unique identifier of a StorageLun or StorageFileSystem.
entityType*xsd:string

Entity type of the entity specified using entityId. This can be either StorageLun or StorageFileSystem.
*Need not be set

Return Value

Type Description
BackingStoragePool[]Array of BackingStoragePoolBackingStoragePool associated with specified StorageLun or StorageFileSystem. If entityId is null then API returns all the BackingStoragePools of the specified type. If both entityId and entityType are not specified then API returns all the BackingStoragePools available.

Faults

Type Description
NotFoundThrown if the specified entityId does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryDatastoreBackingPoolMapping(queryDatastoreBackingPoolMapping)

Query BackingStoragePools for the given set of datastores. Available information for all types of BackingStoragePoolssms.storage.BackingStoragePool#BackingStoragePoolType for every input datastore is returned as part of the result. More than one datastore can map to same set of BackingStoragePools.
Required Privileges
StorageViews.View
Since
SMS API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
datastoreManagedObjectReference[]
to a Datastore[]

Array containing references to Datastore objects.

Return Value

Type Description
DatastoreBackingPoolMapping[]DatastoreBackingPoolMapping

Faults

Type Description
NotFoundThrown if any Datastore in the specified input array does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryDatastoreCapability(queryDatastoreCapability)

Get the capability for the given datastore.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
datastoreManagedObjectReference
to a Datastore

reference to Datastore

Return Value

Type Description
StorageCapabilityA data object containing information about StorageCapability. If the VMFS datastore have heterogeneous Luns (in case of VMFS extends), StorageCapability#description will be empty.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryDrsMigrationCapabilityForPerformance(queryDrsMigrationCapabilityForPerformance)

Deprecated. As of SMS API 3.0, use QueryDrsMigrationCapabilityForPerformanceEx

Query the provider to figure out whether Storage DRS should migrate VMDKs between the two given datastores.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
srcDatastoreManagedObjectReference
to a Datastore

Reference to the source Datastore
dstDatastoreManagedObjectReference
to a Datastore

Reference to the destination Datastore

Return Value

Type Description
xsd:booleantrue if VM migration is recommended from srcDatastore to dstDatastore. false if VM migration is not recommended from srcDatastore to dstDatastore.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryDrsMigrationCapabilityForPerformanceEx(queryDrsMigrationCapabilityForPerformanceEx)

Deprecated. As of SMS API 5.0

Query available VASA providers for I/O performance based migration recommendations for all pair combinations of the given set of datastores. Datastore pairs for which a recommendation cannot be obtained are not included in the result.
Required Privileges
StorageViews.View
Since
SMS API 3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
datastoreManagedObjectReference[]
to a Datastore[]

Array containing references to Datastore objects.

Return Value

Type Description
DrsMigrationCapabilityResultDrsMigrationCapabilityResult

Faults

Type Description
NotFoundThrown if any Datastore in the specified input array does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryFaultDomain(queryFaultDomain)

Query for fault domains based on the query spec. If spec is null, SMS will return all the root fault domains only.
Required Privileges
StorageViews.View
Since
SMS API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
filter*FaultDomainFilter

spec for the query operation.
*Need not be set

Return Value

Type Description
FaultDomainId[]All the fault domains based on the query spec.

Faults

Type Description
InvalidArgumentThrown if invalid input is provided.
NotFoundThrown if the specified providerId in the spec does not exist
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryFileSystemAssociatedWithArray(queryFileSystemAssociatedWithArray)

Get the StorageFileSystem data objects for the Array.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StorageFileSystem[]List of data objects containing information about StorageFileSystem.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryHostAssociatedWithLun(queryHostAssociatedWithLun)

Get HostSystem managed entities that share the StorageLun.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
scsi3Idxsd:string

uuid for the StorageLun object.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]
List of HostSystems.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryLunAssociatedWithArray(queryLunAssociatedWithArray)

Get the list of StorageLun data objects that for the Array.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StorageLun[]List of data object containing information about StorageLun.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryLunAssociatedWithPort(queryLunAssociatedWithPort)

Get the StorageLun data objects that are associated with StoragePort.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
portIdxsd:string

uuid for the StoragePort object.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StorageLun[]List of data objects containing information about StorageLun.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryNfsDatastoreAssociatedWithFileSystem(queryNfsDatastoreAssociatedWithFileSystem)

Get NFS datastore managed entity that are associated with StorageFileSystem.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
fileSystemIdxsd:string

uuid for the StorageFileSystem object
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
ManagedObjectReference
to a Datastore
Nas datastore for the storage file system id.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryPortAssociatedWithArray(queryPortAssociatedWithArray)

Get the StoragePort data objects that are associated with Array.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StoragePort[]List of data objects containing information about StoragePort.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryPortAssociatedWithLun(queryPortAssociatedWithLun)

Get the StoragePort data object that is associated with LUN.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
scsi3Idxsd:string

uuid for the StorageLun object.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StoragePortA data object containing information about StoragePort.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryPortAssociatedWithProcessor(queryPortAssociatedWithProcessor)

Get the StoragePort data objects that are associated with Processor.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
processorIdxsd:string

uuid for the StorageProcessor object.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StoragePort[]List of data objects containing information about StoragePort.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryProcessorAssociatedWithArray(queryProcessorAssociatedWithArray)

Get the StorageProcessor data objects that are associated with Array.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
arrayIdxsd:string

uuid for the StorageArray object.

Return Value

Type Description
StorageProcessor[]List of data objects containing information about StorageProcessor.

Faults

Type Description
NotFoundThrown if the specified entity does not exist.
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryProvider(queryProvider)

Get the list of Providers that are currently registered with StorageManager.
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.

Return Value

Type Description
ManagedObjectReference[]
to a SmsProvider[]
List of Providers.

Faults

Type Description
QueryExecutionFaultThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryReplicationGroupInfo(queryReplicationGroupInfo)

Query for replication group details based on the query filter spec. The replication group id list in the filter spec cannot be null or empty.
Required Privileges
StorageViews.View
Since
SMS API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
rgFilterReplicationGroupFilter



Return Value

Type Description
GroupOperationResult[]An array of sms.storage.GroupOperationresult elements. The length of the result array must be the same as the input. In the result array, each entry is either a QueryReplicationGroupSuccessResult (for success), or a GroupErrorResult (for failure).

The following fault may be set in error result entry:

  • NotFound if the replication group cannot be found.
  • ProviderUnavailable if the provider for the entity is temporarily unavailable.
  • InactiveProvider if the provider for the entity is not active.
  • ProviderBusy if the provider for the entity is busy.
  • NotImplemented if the provider does not implement this function.
  • QueryExceptionFault for any other error.

  • Faults

    Type Description
    InvalidArgumentThrown if groupId is null or empty.
    QueryExecutionFaultThrown if an error is encountered while processing the query request.
    RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
    ServiceNotInitializedThrown if SMS service is not initialized.

    Events

    Type
    None

    Show WSDL type definition



    QueryStorageContainer(queryStorageContainer)

    Query storage containers that are retrieved from VASA providers.
    Required Privileges
    StorageViews.View
    Since
    SMS API 5.0

    Parameters

    NameTypeDescription
    _thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
    containerSpec*StorageContainerSpec

    StorageContainerSpec
    *Need not be set

    Return Value

    Type Description
    StorageContainerResultStorageContainerResult

    Faults

    Type Description
    NotFoundThrown if the input provided as part of StorageContainerSpec is not found.
    QueryExecutionFaultThrown if an error is encountered while processing the query request.
    RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

    Events

    Type
    None

    Show WSDL type definition



    QueryVmfsDatastoreAssociatedWithLun(queryVmfsDatastoreAssociatedWithLun)

    Get VMFS Datastore managed entity that are associated with StorageLun.
    Required Privileges
    StorageViews.View

    Parameters

    NameTypeDescription
    _thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
    scsi3Idxsd:string

    uuid for the StorageLun object
    arrayIdxsd:string

    uuid for the StorageArray object.

    Return Value

    Type Description
    ManagedObjectReference
    to a Datastore
    Vmfs datastore for the file system id.

    Faults

    Type Description
    NotFoundThrown if the specified entity does not exist.
    QueryExecutionFaultThrown if an error is encountered while processing the query request.
    RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

    Events

    Type
    None

    Show WSDL type definition



    RegisterProvider_Task(registerProvider)

    Register the provider and issue a sync operation on it.
    Required Privileges
    StorageViews.ConfigureService

    Parameters

    NameTypeDescription
    _thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
    providerSpecSmsProviderSpec

    SmsProviderSpec containing parameters needed to register the provider

    Return Value

    Type Description
    ManagedObjectReference
    to a SmsTask

    Faults

    Type Description
    AlreadyExistsThrown if the provider already exists.
    InvalidArgumentThrown if invalid input is provided.
    ProviderRegistrationFaultThrown if an error is encountered during the registration operation. For instance, IncorrectUsernamePassword is thrown if the login credentials are incorrect. CertificateNotTrusted is thrown if the provider identifies itself with an untrusted certificate.
    RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

    Events

    Type
    None



    SmsRefreshCACertificatesAndCRLs_Task(refreshCACertificatesAndCRLs)

    SMS pushes the latest CA root certificates and CRLs to all registered VASA providers.
    Required Privileges
    StorageViews.ConfigureService
    Since
    SMS API 5.0

    Parameters

    NameTypeDescription
    _thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
    providerId*xsd:string[]

    uid for providers
    *Need not be set

    Return Value

    Type Description
    ManagedObjectReference
    to a SmsTask

    Faults

    Type Description
    CertificateRefreshFailedThrown if an error is encountered while refreshing root certificates and CRLs for any provider.
    InvalidArgumentThrown if a uid in providerId is invalid.
    NotFoundThrown if there exists no provider for a uid in providerId
    RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

    Events

    Type
    None



    UnregisterProvider_Task(unregisterProvider)

    Unregister the provider.

    Required Privileges
    StorageViews.ConfigureService

    Parameters

    NameTypeDescription
    _thisManagedObjectReference A reference to the SmsStorageManager used to make the method call.
    providerIdxsd:string

    uid for the provider

    Return Value

    Type Description
    ManagedObjectReference
    to a SmsTask

    Faults

    Type Description
    InvalidArgumentThrown if invalid input is provided.
    NotFoundThrown if the specified entity does not exist.
    ProviderUnregistrationFaultThrown if provider service is not available or any exception is thrown by the VASA provider during unregister provider.
    RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

    Events

    Type
    None