Vsan Vc Cluster Config System Vsan Cluster Reconfig

Vsan Vc Cluster Config System Vsan Cluster Reconfig

Reconfigure a vSAN cluster.

This method is used to set vSAN specific configuration, the method can be used to modify all vSAN related configuration. From vSAN 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 vSAN cluster setting such as vSAN enablement and autoclaim enablement, vsanClusterConfig needs to be setup. To modify vSAN cluster specific features such as deduplication and compression enablement, dataEfficiencyConfig needs to be setup. Currently for vSAN 6.2, deduplication and and compression need to be enable/disable together. To enable/disable deduplication and compression on a vSAN cluster, disk convert process (PerformVsanUpgradeEx for description about disk convert process) will be invoked. This is only supported for all-flash disk groups. To modify vSAN cluster fault domain configuration, faultDomainsSpec needs to be setup. To modify vSAN cluster disk groups reconfiguration, diskMappingSpec needs to be setup. To modify vSAN iSCSI target service configuration, iscsiSpec needs to be setup.

Reconfiguring vSAN cluster requires Host.Inventory.EditCluster privilege on the cluster, extra privileges may be required depending on what is being changed:

  • Cryptographer.ManageEncryptionPolicy and Cryptographer.ManageKeys if changing data encryption configuration.
Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/VsanClusterReconfig
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanVcClusterConfigSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
VsanClusterReconfigRequestType of type(s) application/json
Required 
"VsanClusterReconfigRequestType Object"
cluster
Required

The target VC cluster.

vsanReconfigSpec
Required

The configure spec for vSAN cluster.

Authentication
This operation uses the following authentication methods.
Responses
200

vim.Task

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

500

VsanFault: when turn on data efficiency feature on a cluster which has hybrid disk group.

InvalidState: if the vSAN is not enabled in current cluster.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/VsanClusterReconfig
On This Page
V San Service Api Operations
POST
Vsan Vc Cluster Config System Vsan Cluster Get Claimed Capacity
POST
Vsan Vc Cluster Config System Vsan Cluster Get Config
POST
Vsan Vc Cluster Config System Vsan Cluster Get Runtime Stats
POST
Vsan Vc Cluster Config System Vsan Query Cluster Drs Stats
POST
Vsan Vc Cluster Config System Vsan Cluster Reconfig
POST
Vsan Vc Cluster Config System Vsan Encrypted Cluster Rekey Task
POST
Vsan Vc Cluster Config System Run Lifecycle Check
POST
Vsan Vc Cluster Config System Vsan Validate Config Spec