| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
CnsAttachVolume, CnsConfigureVolumeACLs, CnsCreateVolume, CnsDeleteVolume, CnsDetachVolume, CnsExtendVolume, CnsQueryAsync, CnsQueryVolume, CnsUpdateVolumeMetadata |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CnsVolumeManager used to make the method call. |
attachSpecs P | CnsVolumeAttachDetachSpec[] |
Specification for attach operation
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenario. |
InvalidArgument | This API supports input size of 1 only. If more or less than one entries are passed as input, this exception will be thrown and operation will fail. This fault will occur in cases where the volume ID is empty, VM is not present, volume type is FILE etc. |
ManagedObjectNotFound | Thrown if the VM can not be found. |
NotFound | Thrown if the volume can not be found. |
ResourceInUse | Thrown if the volume has been attached a VM and is in use, client needs to first detach the volume from that VM and then retry this operation. |
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 CnsVolumeManager used to make the method call. |
ACLConfigSpecs P | CnsVolumeACLConfigureSpec[] |
Specifications for volumes ACL configuration.
Since vSAN API vSAN 7.0U2 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for any other authorization failure scenrios. |
InvalidArgument | Thrown if: 1) two or more ACLConfigSpec instances are passed; 2) the volume ID is empty; 3) file service reports the invalid inputs. |
NotFound | Thrown if the volume or cluster can not be found by CNS. |
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 CnsVolumeManager used to make the method call. |
createSpecs P | CnsVolumeCreateSpec[] |
Specifications for volumes to be created.
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenario. |
InvalidArgument | Thrown for block volume, if the input spec is invalid like createSpecs size is not equal to 1, backing disk ID in backing object details is empty and datastores is empty, volume metadata in input spec is invalid, backing disk ID in backing object details is not present, datastore is invalid, entityMetadata containing duplicate entity types, profile size is not equal to 1 etc. For file volume, if the input spec is invalid like createSpecs size is not equal to 1, volume metadata in input spec is invalid, backing disk ID in backing object details is not present, entityMetadata containing duplicate entity types, profile size is not equal to 1 etc. |
NotFound | Thrown if the volume can not be found. |
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 CnsVolumeManager used to make the method call. |
volumeIds P | CnsVolumeId[] |
List of CnsVolumeId for the volumes to be
deleted.
Since vSAN API vSAN 6.7U3 |
deleteDisk P | xsd:boolean |
Disk is the backing object for each container volume
specified in volumeIds list. If set to true, the backing
objects specified in volumeIds list will be deleted. If
set to false, the backing objects specified in volumeIds
list will not be deleted but will no longer be a
container volume.
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenario. |
InvalidArgument | This API supports input size of 1 only. If more or less than one entries are passed as input, this exception will be thrown and operation will fail. This exception will be thrown when invalid format for VolumeId vim.cns.VolumeId.id is passed, or volume IDs are empty. |
NotFound | Thrown if the volume can not be found. |
ResourceInUse | Thrown if the volume has been attached to a VM and is in use, client needs to first detach the volume from that VM and then retry this operation. |
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 CnsVolumeManager used to make the method call. |
detachSpecs P | CnsVolumeAttachDetachSpec[] |
Specification for detach operation
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenario. |
InvalidArgument | This API supports input size of 1 only. If more or less than one entries are passed as input, this exception will be thrown and operation will fail. This fault will occur when the volume is not attached to any VM or the volume is not attached to the VM specified or the volume ID is empty etc. |
ManagedObjectNotFound | Thrown if the VM can not be found. |
NotFound | Thrown if the volume can not be found. |
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 CnsVolumeManager used to make the method call. |
extendSpecs P | CnsVolumeExtendSpec[] |
Specifications for volumes to be extended.
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenario. |
InvalidArgument | This API supports input size of 1 only. If more or less than one entries are passed as input, this exception will be thrown and operation will fail. This API requires the new capacity of the volume specified in ExtendSpec is bigger than 0, this exception will be thrown and operation will fail. |
NotFound | Thrown if the volume can not be found. |
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 CnsVolumeManager used to make the method call. |
filter P | CnsQueryFilter |
All container volumes matching the criteria set in the filter
will be returned. See CnsQueryFilter
Since vSAN API vSAN 7.0U3 |
selection* P | CnsQuerySelection |
Selection spec for the query entities to return.
This is an optional parameter. All volume fields would be returned
if the parameter is not specified. See CnsQuerySelection
Since vSAN API vSAN 7.0U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the progress and result of this operation. For result type in task, see CnsAsyncQueryResult |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenarios |
InvalidArgument | Thrown in case of invalid input arguments, like empty strings, invalid formats, invalid combination of inputs |
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 CnsVolumeManager used to make the method call. |
filter P | CnsQueryFilter |
All container volumes matching the criteria set in the filter
will be returned. See CnsQueryFilter
Since vSAN API vSAN 6.7U3 |
selection* P | CnsQuerySelection |
Selection spec for the query entities to return.
This is an optional parameter. All volume fields would be returned
if the parameter is not specified. See CnsQuerySelection
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
CnsQueryResult | Array of CnsVolume matching the input criteria |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenarios |
InvalidArgument | Thrown in case of invalid input arguments, like empty strings, invalid formats, invalid combination of inputs |
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 CnsVolumeManager used to make the method call. |
updateSpecs P | CnsVolumeMetadataUpdateSpec[] |
Specifications for volumes to be updated.
Since vSAN API vSAN 6.7U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task vCenter Task to track the progress and overall state of this operation. |
Faults
Type | Description |
---|---|
CnsFault | Thrown for all other failure scenario. |
CnsNotRegisteredFault | Thrown if the volume exists in VC but not registered as CNS volume. |
InvalidArgument | Thrown if:
|
NotFound | Thrown if the volume can not be found. |
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 |