vSAN Management API
| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - VimClusterVsanVcDiskManagementSystem(vim.cluster.VsanVcDiskManagementSystem)
- See also
- ClusterComputeResource, HostMaintenanceSpec, HostScsiDisk, HostSystem, Task, VimVsanDataEfficiencyCapacityState, VimVsanHostDiskMapInfoEx, VimVsanHostDiskMappingCreationSpec, VimVsanHostQueryVsanDisksSpec, VimVsanHostVsanHostCapability, VimVsanHostVsanManagedDisksInfo, VsanAddStoragePoolDiskSpec, VsanDeleteStoragePoolDiskSpec, VsanHostDiskMapping
- Since
- vSphere API Release 6.0
Managed Object Description
VimClusterVsanVcDiskManagementSystem enhances vSAN disk management part, provides vSAN all flash disk group support, exposes more detailed information of vSAN disk group, helps on configure and manage vSAN disk group.It deprecates APIs AddDisks_Task and InitializeDisks_Task, exposes VimVsanHostDiskMapInfoEx through API QueryDiskMappings, to present whether a disk group is all flash, and whether deduplication and compression is enabled on this disk group, and deprecates diskMapping exposed by Config.
The ManagedEntity can be accessed through MOID of vsan-disk-management-system, through vSAN service at vCenter server side.
Properties
Name | Type | Description |
---|---|---|
None |
Methods
InitializeDiskMappings(initializeDiskMappings)
This API is used to create new vSAN disk groups or attach more disks into existing vSAN disk group on specified host. It deprecates APIs AddDisks_Task and InitializeDisks_Task, to support creating both hybrid and all flash disk group. Scsi disks eligible for vSAN service, could be retrieved through API QueryDisksForVsan. If the "creationType" of the given spec is set to "vsandirect", then it will create vSAN direct datastores on each specified SSD and HDD.- Required Privileges
- None
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
spec P | VimVsanHostDiskMappingCreationSpec |
The specification to create vSAN disk group. Please
reference to VimVsanHostDiskMappingCreationSpec;
Since vSphere API Release 6.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if below issues exist:
|
Events
Type | |
---|---|
None |
Show WSDL type definition
QueryClusterDataEfficiencyCapacityState(queryClusterDataEfficiencyCapacityState)
Retrieve logical capacity, logical capacity used, physical capacity, physical capacity used and data efficiency metadata of a data efficiency enabled cluster.- Required Privileges
- None
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
The target cluster.
Since vSphere API Release 6.0 |
Return Value
Type | Description |
---|---|
VimVsanDataEfficiencyCapacityState |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault |
Events
Type | |
---|---|
None |
Show WSDL type definition
QueryDiskMappings(queryDiskMappings)
Get detailed information of vSAN disk groups managed by specified host, for each disk group, includes: Disk structure, presents as disk for cache tier, and disks for capacity tier; Whether is in-use for vSAN I/O by this host; Whether is all flash disk group; Whether vSAN deduplication and compression are enabled on this disk group.- Required Privileges
- None
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
host P | ManagedObjectReference
to a HostSystem |
Target host to query.
Since vSphere API Release 6.0 |
Return Value
Type | Description |
---|---|
VimVsanHostDiskMapInfoEx[] | List of DiskMapInfoEx, please reference to VimVsanHostDiskMapInfoEx. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if below issues exist:
|
Events
Type | |
---|---|
None |
Show WSDL type definition
QueryVsanManagedDisks(queryVsanManagedDisks)
Get detailed information of all vSAN managed disks, which include disk groups, storage pool disks in vSAN datastore and all of vSAN direct storages for the specified host. The output can be filtered to show only disk group or storage pool disks or vSAN direct disks. It can also be filtered to show details for an individual disk on the host by specifying filter criteria through VimVsanHostQueryVsanDisksSpec. The API vim.cluster.VsanVcDiskManagementSystem#QueryDiskMappings will be deprecated and replaced with this API.- Required Privileges
- None
- Since
- vSAN API vSAN 7.0U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
host P | ManagedObjectReference
to a HostSystem |
Target host to query.
Since vSAN API vSAN 7.0U1 |
filterSpec* | VimVsanHostQueryVsanDisksSpec |
Specification to filter vSAN disks.
This spec can be used to filter query results by disktype types
(diskGroup/storagePool/directDisk) or by diskName. If this spec is
not specified, it will return all vSAN disks in the cluster.
Refer VimVsanHostQueryVsanDisksSpec for more details.
Since vSAN API vSAN 7.0U1 |
Return Value
Type | Description |
---|---|
VimVsanHostVsanManagedDisksInfo | All of vSAN managed disks including vSAN disk groups and vSAN direct storages |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if below issues exist:
|
Events
Type | |
---|---|
None |
Show WSDL type definition
RebuildDiskMapping(rebuildDiskMapping)
This API is used to rebuild an existing vSAN disk mapping on the specified host. Please note that the API does not support rebuilding unmounted DGs. Rebuild disk mapping is done in two steps: 1. remove the existing disk mapping with user specified data evacuation mode; 2. perform a trim operation on every disk in DG. 3. re-create a new disk mapping with the same set of disks. Removal of a disk mapping may cause data movement so a disk data evacuation resource check vim.vsan.VsanResourceCheckSystem#PerformResourceCheck will be done before removing the disk mapping. Before re-creating new disk mapping, the disks will be trimmed for refreshing possible bad blocks in the meta-data section of the disks.- Required Privileges
- None
- Since
- vSAN API vSAN 6.7U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
host P | ManagedObjectReference
to a HostSystem |
Target host to rebuild.
Since vSAN API vSAN 6.7U1 |
mapping | VsanHostDiskMapping |
The disk mapping to be rebuilt from VSAN usage.
Since vSAN API vSAN 6.7U1 |
maintenanceSpec | HostMaintenanceSpec |
Specifies the data evacuation mode.
Since vSAN API vSAN 6.7U1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if below issues exist:
|
Events
Type | |
---|---|
None |
Show WSDL type definition
RemoveDiskEx(removeDiskEx)
Remove vSAN capacity-tier disk(s) from use in a vSAN cluster with the specified data evacuation mode or remove vSAN direct disk(s). It will auto-detect whether the disk(s) provided belong to vSAN capacity-tier disk or vSAN direct. If the disk(s) belong to vSAN capacity-tier disk, then vSAN disk will be removed. If the disk(s) belong to vSAN direct, then the vSAN direct disk(s) will be removed. For vSAN disk(s) removal, disk(s) will be removed one by one with the specified data evacuation mode. Removing a disk may cause data movement so a disk data evacuation resource check vim.vsan.VsanResourceCheckSystem#PerformResourceCheck will be done before removing each disk. Note: This method cannot be used to remove the cache-tier disk or the last capacity-tier disk of a disk mapping since that will cause the whole disk mapping to be removed. Use VsanVcDiskManagementSystem#RemoveDiskMapping instead if that is the case. For vSAN direct disk(s) removal, the storage system build on top of these vSAN direct disk(s) will be destroyed one by one with the specified data evacuation mode.- Required Privileges
- None
- Since
- vSAN API 7.2
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
The vSAN cluster which owns the given vSAN disk(s)
and(or) vSAN direct disk(s).
Since vSAN API 7.2 |
disks | HostScsiDisk[] |
List of vSAN disk(s) to be removed.
Since vSAN API 7.2 |
maintenanceSpec | HostMaintenanceSpec |
Specifies the data evacuation mode.
Since vSAN API 7.2 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A task to monitor the progress of disk(s) removal operation. If the removal operation includes vSAN disk(s) removal, then upon successful completion of the returned task, its result field will be populated with a VsanHostDiskResult[] filled with details for each vSAN disk. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if resource check completes with "red" status or any other error happens during the resource check stage or actual disk(s) removal stage for vSAN disk(s). If the specified disk is the last capacity-tier disk in a disk mapping, a more specific vim.fault.DiskIsLastRemainingNonSSD (which is a subclass of VsanFault) will be thrown instead. |
Events
Type | |
---|---|
None |
Show WSDL type definition
RemoveDiskMappingEx(removeDiskMappingEx)
Remove vSAN disk mapping(s) from use in a vSAN cluster with the specified data evacuation mode. Disk mapping(s) will be removed one by one with the specified data evacuation mode. Removing a disk mapping may cause data movement so a disk data evacuation resource check vim.vsan.VsanResourceCheckSystem#PerformResourceCheck will be done before removing each disk mapping.- Required Privileges
- None
- Since
- vSAN API 7.2
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
The vSAN cluster which owns the given disk mapping(s).
Since vSAN API 7.2 |
mappings | VsanHostDiskMapping[] |
List of disk mapping(s) to be removed.
Since vSAN API 7.2 |
maintenanceSpec | HostMaintenanceSpec |
Specifies the data evacuation mode.
Since vSAN API 7.2 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A task to monitor the progress of disk mapping(s) removal operation. Upon successful completion of the returned task, its result field will be populated with a VsanHostDiskMapResult[] filled with details for each disk mapping. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if resource check completes with "red" status or any error happens during the resource check stage or actual disk mapping(s) removal stage. |
Events
Type | |
---|---|
None |
Show WSDL type definition
RetrieveAllFlashCapabilities(retrieveAllFlashCapabilities)
Retrieve capabilities for hosts reside in specified cluster, to figure out whether all flash disk group is supported by hosts' ESXi softwares, and whether they are licensed.- Required Privileges
- None
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
Target cluster, of which hosts' capabilities
will be queried;
Since vSphere API Release 6.0 |
Return Value
Type | Description |
---|---|
VimVsanHostVsanHostCapability[] | vim.vsan.host.VsanHostCapability[] |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault |
Events
Type | |
---|---|
None |
Show WSDL type definition
UnmountDiskMappingEx(unmountDiskMappingEx)
Unmount vSAN disk mapping(s) in a vSAN cluster with the specified data evacuation mode. Disk mapping(s) will be unmounted one by one with the specified data evacuation mode. Unmount a disk mapping may cause data movement so a disk data evacuation resource check vim.vsan.VsanResourceCheckSystem#PerformResourceCheck will be done before unmounting each disk mapping.- Required Privileges
- None
- Since
- vSAN API 7.2
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
The vSAN cluster which owns the given disk mapping(s).
Since vSAN API 7.2 |
mappings | VsanHostDiskMapping[] |
List of disk mapping(s) to be unmounted.
Since vSAN API 7.2 |
maintenanceSpec | HostMaintenanceSpec |
Specifies the data evacuation mode.
Since vSAN API 7.2 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A task to monitor the progress of disk mapping(s) unmount operation. Upon successful completion of the returned task, its result field will be populated with a VsanHostDiskMapResult[] filled with details for each disk mapping. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if resource check completes with "red" status or any error happens during the resource check stage or actual disk mapping(s) unmount stage. |
Events
Type | |
---|---|
None |
Show WSDL type definition
VsanAddStoragePoolDisk(addStoragePoolDisks)
This API can be used to add new disk(s) to the storage pool for vSAN ESA consumption. If StoragePoolDiskType is specified as 'SingleTier', disks will be added to 'Single Tier' storagepool. Eligible disks for storagepool can be queried from 'QueryDisksForVsan' QueryDisksForVsan.- Required Privileges
- Host.Config.Storage
- Since
- vSAN API 8.0.0.1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
specs* | VsanAddStoragePoolDiskSpec[] |
The specifications to add disks to vSAN storage pool. Please
reference to VimVsanHostAddStoragePoolDiskSpec.
Multiple specs can be used by AddStoragePoolDisks to add disks
on different hosts in one API call.
All hosts should in same vSAN cluster.
Since vSAN API 8.0.0.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if below issues exist:
|
Events
Type | |
---|---|
None |
Show WSDL type definition
VsanDeleteStoragePoolDisk(deleteStoragePoolDisk)
This API can be used to delete a single or multiple disks from storage pool. The disk(s) can be specified by their uniquely identifiable disk uuid.- Required Privileges
- Host.Config.Storage
- Since
- vSAN API 8.0.0.1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The vSAN cluster which owns the given storage pool disk(s).
Since vSAN API 8.0.0.1 |
spec | VsanDeleteStoragePoolDiskSpec |
The specification to delete vSAN storage pool. Please
reference to VimVsanHostDeleteStoragePoolDiskSpec.
Since vSAN API 8.0.0.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if any error happens during storage pool removal stage. |
Events
Type | |
---|---|
None |
Show WSDL type definition
VsanUnmountStoragePoolDisks(unmountStoragePoolDisks)
This API can be used to unmount a single or multiple disks from the storage pool. The disk(s) can be specified by their uniquely identifiable disk UUID. Storage pool disk(s) will be unmounted with the specified data evacuation mode. Unmount a storage pool disk may cause data movement so a disk data evacuation resource check vim.vsan.VsanResourceCheckSystem#PerformResourceCheck will be done before unmounting each storage pool disk.- Required Privileges
- Host.Config.Storage
- Since
- vSAN API 8.0.0.1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The vSAN cluster which owns the given storage pool disk(s).
Since vSAN API 8.0.0.1 |
spec | VsanDeleteStoragePoolDiskSpec |
The specification to unmount vSAN storage pool. Please
reference to VimVsanHostDeleteStoragePoolDiskSpec.
Since vSAN API 8.0.0.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if resource check completes with "red" status or any error happens during the resource check stage or actual storage disk unmount stage. |
Events
Type | |
---|---|
None |
Show WSDL type definition
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |