Managed Object - VimClusterVsanVcDiskManagementSystem(vim.cluster.VsanVcDiskManagementSystem)

See also: ClusterComputeResource, HostMaintenanceSpec, HostSystem, Task, VimVsanDataEfficiencyCapacityState, VimVsanHostDiskMapInfoEx, VimVsanHostDiskMappingCreationSpec, VimVsanHostVsanHostCapability, 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, RebuildDiskMapping, RetrieveAllFlashCapabilities

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.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Host.Config.Storage	ClusterComputeResource

* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call.
spec	VimVsanHostDiskMappingCreationSpec	The specification to create vSAN disk group. Please reference to VimVsanHostDiskMappingCreationSpec;

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.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target 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.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call.
host	ManagedObjectReference to a HostSystem	Target host to query.

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>

RebuildDiskMapping(rebuildDiskMapping)

This API is used to rebuild existing vSAN disk mapping on specified host. It will firstly remove the existing disk mapping with user specified data evacuation mode, and then create new disk mapping on same disks.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Host.Config.Storage	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read
Since: vSAN API vSAN 6.7U1

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call.
host	ManagedObjectReference to a HostSystem	Target host to rebuild.
mapping	VsanHostDiskMapping	The disk mapping to be rebuilt from VSAN usage.
maintenanceSpec	HostMaintenanceSpec

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;

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>

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.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimClusterVsanVcDiskManagementSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	Target cluster, of which hosts' capabilities will be queried;

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>