Managed Object - VsanVcClusterConfigSystem(vim.cluster.VsanVcClusterConfigSystem)

See also: ClusterComputeResource, Task, VimVsanReconfigSpec, VsanConfigInfoEx
Since: vSphere API 6.0

Managed Object Description

This managed object type provides a comprehensive way to manage Virtual SAN cluster configuration in below areas:

Enable or disable Virtual SAN
Enable or disable Autoclaim mode for disk group
Enable or disable data efficiency feature
Manage disk groups
Manage fault domains
Retrieve Virtual SAN generic configuration
Retrieve data efficiency configuration

In this class, ReconfigureEx enhances the legacy API ReconfigureComputeResource_Task. Legacy API ReconfigureComputeResource_Task is deprecated.
The ManagedEntity can be accessed with MOID of 'vsan-cluster-config-system', through Virtual SAN service at vCenter server side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanClusterGetConfig, VsanClusterReconfig

VsanClusterGetConfig(getConfigInfoEx)

Get configInfoEx for a Virtual SAN cluster We can get Virtual SAN configuration information through this method. Currently users can only get generic cluster configuration and data efficiency configuration through this API. This API cannot retrieve fault domain configuration and disk group configuration. Disk group configuration can be retrieved through VsanVcDiskManagementSystem#QueryDiskMappings. Fault domain configuration can be retrieved through config.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterConfigSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target VC cluster

Return Value

Type	Description
VsanConfigInfoEx	The config spec for the VC cluster ConfigInfoEx inherits from VsanClusterConfigInfo. It appends data efficiency configuration.

Faults

Type	Description
InvalidState	Thrown if the virtual SAN is not enabled in current cluster.
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:vim25="urn:vim25" name="VsanClusterGetConfig" type="vim25:VsanClusterGetConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanClusterGetConfigResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanConfigInfoEx"/>
               </sequence>
            </complexType>
         </element>

VsanClusterReconfig(reconfigureEx)

Reconfigure a Virtual SAN cluster. This method is used to set VSAN specific configuration, the method can be used to modify all Virtual SAN related configuration. From Virtual SAN 6.2, this API is the replacement of ReconfigureComputeResource_Task in order to support more configurations such as deduplication and compression, fault domain, disk mapping configuration in the cluster. The legacy API ReconfigureComputeResource_Task is deprecated because new API provide everything that legacy API has. To modify generic Virtual SAN cluster setting such as Virtual SAN enablement and autoclaim enablement, vim.vsan.ReconfigSpecs#vsanClusterConfig needs to be setup. To modify Virtual SAN cluster specific features such as deduplication and compression enablement, vim.vsan.ReconfigSpecs#dataEfficiencyConfig needs to be setup. Currently for Virtual SAN 6.2, deduplication and and compression need to be enable/disable together. To enable/disable deduplication and compression on a Virtual SAN cluster, disk convert process ({@link

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterConfigSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target VC cluster.
vsanReconfigSpec	VimVsanReconfigSpec	The configure spec for Virtual SAN cluster.

Return Value

Type	Description
ManagedObjectReference to a Task	vim.Task

Faults

Type	Description
InvalidState
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:vim25="urn:vim25" name="VsanClusterReconfig" type="vim25:VsanClusterReconfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanClusterReconfigResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>