|
| Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| None | ||
Methods
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.
|
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SmsStorageManager used to make the method call. |
| canonicalName | xsd:string |
canonicalName
of ScsiLun
|
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 | |
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.
|
| entityType* | xsd:string |
Entity type of the entity specified using entityId. This can be either
StorageLun or StorageFileSystem.
|
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 | |
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.
|
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 | |
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
|
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 | |
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
|
| dstDatastore | ManagedObjectReference
to a Datastore |
Reference to the destination Datastore
|
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 | |
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.
|
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 | |
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.
|
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 | |
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.
|
| arrayId | xsd:string |
uuid for the StorageArray
object.
|
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 | |
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.
|
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 | |
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.
|
| arrayId | xsd:string |
uuid for the StorageArray
object.
|
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 | |
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
|
| arrayId | xsd: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 |
|---|---|
| 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 | |
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.
|
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 | |
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.
|
| arrayId | xsd:string |
uuid for the StorageArray
object.
|
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 | |
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.
|
| arrayId | xsd:string |
uuid for the StorageArray
object.
|
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 | |
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.
|
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 | |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SmsStorageManager used to make the method call. |
| containerSpec* | StorageContainerSpec |
StorageContainerSpec
|
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 | |
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
|
| arrayId | xsd:string |
uuid for the StorageArray
object.
|
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 | |
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
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a SmsTask |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the provider already exists. |
| InvalidArgument | Thrown if invalid input is provided. |
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SmsStorageManager used to make the method call. |
| providerId* | xsd:string[] |
uid for providers
|
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. |
| InvalidArgument | Thrown if a uid in providerId is invalid. |
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SmsStorageManager used to make the method call. |
| providerId | xsd:string |
uid for
the provider
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a SmsTask |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Thrown if invalid input is provided. |
| 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. |
Events
| Type | |
|---|---|
| None | |
| Top of page | Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |