Managed Object - VimClusterVsanVcDiskManagementSystem(vim.cluster.VsanVcDiskManagementSystem)

See also: ClusterComputeResource, HostMaintenanceSpec, HostScsiDisk, HostSystem, Task, VimVsanDataEfficiencyCapacityState, VimVsanHostDiskMapInfoEx, VimVsanHostDiskMappingCreationSpec, VimVsanHostVsanHostCapability, VimVsanHostVsanManagedDisksInfo, VsanHostDiskMapping
Since: vSphere API 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

Methods defined in this Managed Object
InitializeDiskMappings, QueryClusterDataEfficiencyCapacityState, QueryDiskMappings, QueryVsanManagedDisks, RebuildDiskMapping, RemoveDiskEx, RemoveDiskMappingEx, RetrieveAllFlashCapabilities, UnmountDiskMappingEx

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 6.0

P Required privilege: spec

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:

Specified host doesn't exist;
User doesn't have Host.Config.Storage privilege on specified host;
Specified host is not connected to vCenter server;
If requests to create all flash disk group but host's ESX software doesn't support this feature;
If requests to create all flash disk group but host is not licensed to support this feature;
If requests to append disks to existing disk group, but specified more than one disks for cache tier;
If none of specified disks for capacity tier is eligible for vSAN;

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="InitializeDiskMappings" type="vsan:InitializeDiskMappingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="InitializeDiskMappingsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

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 6.0

P Required privilege: cluster

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryClusterDataEfficiencyCapacityState" type="vsan:QueryClusterDataEfficiencyCapacityStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryClusterDataEfficiencyCapacityStateResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VimVsanDataEfficiencyCapacityState"/>
                     </sequence>
                  </complexType>
               </element>

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 6.0

P Required privilege: host

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: Specified host doesn't exist; Specified host is not connected to vCenter server; Any unexpected runtime error;

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryDiskMappings" type="vsan:QueryDiskMappingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryDiskMappingsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VimVsanHostDiskMapInfoEx" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryVsanManagedDisks(queryVsanManagedDisks)

Get detailed information of vSAN managed disks, which include the disk groups in vSAN datastore and all of vSAN direct storages for the specified host. 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

P Required privilege: host

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: Specified host doesn't exist; Specified host is not connected to vCenter server; Any unexpected runtime error;

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanManagedDisks" type="vsan:QueryVsanManagedDisksRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanManagedDisksResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VimVsanHostVsanManagedDisksInfo" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

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

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 P	VsanHostDiskMapping	The disk mapping to be rebuilt from VSAN usage. *Since* vSAN API vSAN 6.7U1
maintenanceSpec P	HostMaintenanceSpec	Specifies the data evacuation mode. *Since* vSAN API vSAN 6.7U1

PRequired privilege - see tooltip for details

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: Specified host doesn't exist; User doesn't have Host.Config.Storage privilege on specified host; Specified host is not connected to vCenter server; Resource check completes with "red" status;

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RebuildDiskMapping" type="vsan:RebuildDiskMappingRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RebuildDiskMappingResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

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 thus the data will be lost.

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 P	HostScsiDisk[]	List of vSAN disk(s) to be removed. *Since* vSAN API 7.2
maintenanceSpec P	HostMaintenanceSpec	Specifies the data evacuation mode. It only support noAction for vSAN direct disk(s) removal. If other decommision mode is set, the vSAN direct disk(s) removal will ignore the decommission mode and proceed with noAction mode. *Since* vSAN API 7.2

PRequired privilege - see tooltip for details

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveDiskEx" type="vsan:RemoveDiskExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveDiskExResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

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 P	VsanHostDiskMapping[]	List of disk mapping(s) to be removed. *Since* vSAN API 7.2
maintenanceSpec P	HostMaintenanceSpec	Specifies the data evacuation mode. *Since* vSAN API 7.2

PRequired privilege - see tooltip for details

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveDiskMappingEx" type="vsan:RemoveDiskMappingExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveDiskMappingExResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

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 6.0

P Required privilege: cluster

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RetrieveAllFlashCapabilities" type="vsan:RetrieveAllFlashCapabilitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RetrieveAllFlashCapabilitiesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VimVsanHostVsanHostCapability" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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 P	VsanHostDiskMapping[]	List of disk mapping(s) to be unmounted. *Since* vSAN API 7.2
maintenanceSpec P	HostMaintenanceSpec	Specifies the data evacuation mode. *Since* vSAN API 7.2

PRequired privilege - see tooltip for details

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UnmountDiskMappingEx" type="vsan:UnmountDiskMappingExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UnmountDiskMappingExResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>