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: 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.

Identify VASA providers.
Retrieve information about storage arrays.
Identify vSphere inventory entities (hosts and datastores) which are associated with external storage entities on the storage arrays.

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

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

Name

Type

Description

_this

ManagedObjectReference

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

providerId*

xsd:string[]

List of uid for the VASA provider objects.

Since 2.0

*Need not be set

Return Value

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

Faults

Type	Description
NotFound	Thrown if the given providerId does not have any reference.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryArray" type="sms:QueryArrayRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryArrayResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageArray" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryArrayAssociatedWithLun(queryArrayAssociatedWithLun)

Get the StorageArray object that is associated with the ScsiLun.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

canonicalName

xsd:string

canonicalName of ScsiLun

Since 2.0

Return Value

Type	Description
StorageArray	StorageArray for the for the ScsiLun.

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryArrayAssociatedWithLun" type="sms:QueryArrayAssociatedWithLunRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryArrayAssociatedWithLunResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageArray" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

QueryAssociatedBackingStoragePool(queryAssociatedBackingStoragePool)

Query Backing Storage Pools for StorageLun or StorageFileSystem.

Required Privileges: StorageViews.View
Since: 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

entityId*

xsd:string

Unique identifier of a StorageLun or StorageFileSystem.

Since 5.0

entityType*

xsd:string

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

Since 5.0

*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
NotFound	Thrown if the specified entityId does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryAssociatedBackingStoragePool" type="sms:QueryAssociatedBackingStoragePoolRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryAssociatedBackingStoragePoolResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:BackingStoragePool" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryDatastoreBackingPoolMapping(queryDatastoreBackingPoolMapping)

Query BackingStoragePools for the given set of datastores. Available information for all types of BackingStoragePoolsBackingStoragePoolType 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: 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastore

ManagedObjectReference[]
to a Datastore[]

Array containing references to Datastore objects.

Since 5.0

Return Value

Type	Description
DatastoreBackingPoolMapping[]	DatastoreBackingPoolMapping

Faults

Type	Description
NotFound	Thrown if any Datastore in the specified input array does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDatastoreBackingPoolMapping" type="sms:QueryDatastoreBackingPoolMappingRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDatastoreBackingPoolMappingResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:DatastoreBackingPoolMapping" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryDatastoreCapability(queryDatastoreCapability)

Get the capability for the given datastore.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastore

ManagedObjectReference
to a Datastore

reference to Datastore

Since 2.0

Return Value

Type	Description
StorageCapability	A 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
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDatastoreCapability" type="sms:QueryDatastoreCapabilityRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDatastoreCapabilityResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageCapability" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

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

Name

Type

Description

_this

ManagedObjectReference

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

srcDatastore

ManagedObjectReference
to a Datastore

Reference to the source Datastore

Since 2.0

dstDatastore

ManagedObjectReference
to a Datastore

Reference to the destination Datastore

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDrsMigrationCapabilityForPerformance" type="sms:QueryDrsMigrationCapabilityForPerformanceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDrsMigrationCapabilityForPerformanceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>

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: 3.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastore

ManagedObjectReference[]
to a Datastore[]

Array containing references to Datastore objects.

Since 3.0

Return Value

Type	Description
DrsMigrationCapabilityResult	DrsMigrationCapabilityResult

Faults

Type	Description
NotFound	Thrown if any Datastore in the specified input array does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDrsMigrationCapabilityForPerformanceEx" type="sms:QueryDrsMigrationCapabilityForPerformanceExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryDrsMigrationCapabilityForPerformanceExResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:DrsMigrationCapabilityResult"/>
                     </sequence>
                  </complexType>
               </element>

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: 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filter*

FaultDomainFilter

spec for the query operation.

Since 6.5

*Need not be set

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified providerId in the spec does not exist
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryFaultDomain" type="sms:QueryFaultDomainRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryFaultDomainResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:FaultDomainId" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryFileSystemAssociatedWithArray(queryFileSystemAssociatedWithArray)

Get the StorageFileSystem data objects for the Array.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryFileSystemAssociatedWithArray" type="sms:QueryFileSystemAssociatedWithArrayRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryFileSystemAssociatedWithArrayResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageFileSystem" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryHostAssociatedWithLun(queryHostAssociatedWithLun)

Get HostSystem managed entities that share the StorageLun.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

scsi3Id

xsd:string

uuid for the StorageLun object.

Since 2.0

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryHostAssociatedWithLun" type="sms:QueryHostAssociatedWithLunRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryHostAssociatedWithLunResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryLunAssociatedWithArray(queryLunAssociatedWithArray)

Get the list of StorageLun data objects that for the Array.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryLunAssociatedWithArray" type="sms:QueryLunAssociatedWithArrayRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryLunAssociatedWithArrayResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageLun" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryLunAssociatedWithPort(queryLunAssociatedWithPort)

Get the StorageLun data objects that are associated with StoragePort.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

portId

xsd:string

uuid for the StoragePort object.

Since 2.0

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryLunAssociatedWithPort" type="sms:QueryLunAssociatedWithPortRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryLunAssociatedWithPortResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageLun" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryNfsDatastoreAssociatedWithFileSystem(queryNfsDatastoreAssociatedWithFileSystem)

Get NFS datastore managed entity that are associated with StorageFileSystem.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

fileSystemId

xsd:string

uuid for the StorageFileSystem object

Since 2.0

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryNfsDatastoreAssociatedWithFileSystem" type="sms:QueryNfsDatastoreAssociatedWithFileSystemRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryNfsDatastoreAssociatedWithFileSystemResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

QueryPortAssociatedWithArray(queryPortAssociatedWithArray)

Get the StoragePort data objects that are associated with Array.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPortAssociatedWithArray" type="sms:QueryPortAssociatedWithArrayRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPortAssociatedWithArrayResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StoragePort" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryPortAssociatedWithLun(queryPortAssociatedWithLun)

Get the StoragePort data object that is associated with LUN.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

scsi3Id

xsd:string

uuid for the StorageLun object.

Since 2.0

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

Type	Description
StoragePort	A data object containing information about StoragePort.

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPortAssociatedWithLun" type="sms:QueryPortAssociatedWithLunRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPortAssociatedWithLunResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StoragePort" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

QueryPortAssociatedWithProcessor(queryPortAssociatedWithProcessor)

Get the StoragePort data objects that are associated with Processor.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

processorId

xsd:string

uuid for the StorageProcessor object.

Since 2.0

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPortAssociatedWithProcessor" type="sms:QueryPortAssociatedWithProcessorRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPortAssociatedWithProcessorResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StoragePort" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryProcessorAssociatedWithArray(queryProcessorAssociatedWithArray)

Get the StorageProcessor data objects that are associated with Array.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryProcessorAssociatedWithArray" type="sms:QueryProcessorAssociatedWithArrayRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryProcessorAssociatedWithArrayResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageProcessor" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryProvider(queryProvider)

Get the list of Providers that are currently registered with StorageManager.

Required Privileges: StorageViews.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	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
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryProvider" type="sms:QueryProviderRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryProviderResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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: 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

rgFilter

ReplicationGroupFilter

Since 6.5

Return Value

Type

Description

GroupOperationResult[]

An array of 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.

Faults

Type	Description
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryReplicationGroupInfo" type="sms:QueryReplicationGroupInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryReplicationGroupInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:GroupOperationResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryStorageContainer(queryStorageContainer)

Query storage containers that are retrieved from VASA providers. Stretched container with UNREPORTED sync status is not included in returned result.

Required Privileges: StorageViews.View
Since: 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

containerSpec*

StorageContainerSpec

Since 5.0

*Need not be set

Return Value

Type	Description
StorageContainerResult	StorageContainerResult

Faults

Type	Description
NotFound	Thrown if the input provided as part of StorageContainerSpec is not found.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryStorageContainer" type="sms:QueryStorageContainerRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryStorageContainerResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:StorageContainerResult" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

QueryVmfsDatastoreAssociatedWithLun(queryVmfsDatastoreAssociatedWithLun)

Get VMFS Datastore managed entity that are associated with StorageLun.

Required Privileges: StorageViews.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

scsi3Id

xsd:string

uuid for the StorageLun object

Since 2.0

arrayId

xsd:string

uuid for the StorageArray object.

Since 2.0

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryVmfsDatastoreAssociatedWithLun" type="sms:QueryVmfsDatastoreAssociatedWithLunRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryVmfsDatastoreAssociatedWithLunResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="sms:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

RegisterProvider_Task(registerProvider)

Required Privileges: StorageViews.ConfigureService

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

providerSpec

SmsProviderSpec

SmsProviderSpec containing parameters needed to register the provider

Since 2.0

Return Value

Type	Description
ManagedObjectReference to a SmsTask

Faults

Type	Description
AlreadyExists	Thrown if the provider already exists.
ProviderRegistrationFault	Thrown 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.
RuntimeFault	Thrown 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: 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

providerId*

xsd:string[]

uid for providers

Since 5.0

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a SmsTask

Faults

Type	Description
CertificateRefreshFailed	Thrown if an error is encountered while refreshing root certificates and CRLs for any provider.
NotFound	Thrown if there exists no provider for a uid in providerId
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

providerId

xsd:string

uid for the provider

Since 2.0

Return Value

Type	Description
ManagedObjectReference to a SmsTask

Faults

Type	Description
NotFound	Thrown if the specified entity does not exist.
ProviderUnregistrationFault	Thrown if provider service is not available or any exception is thrown by the VASA provider during unregister provider.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.