Vsan Vc Cluster Config System Vsan Cluster Get Config

Vsan Vc Cluster Config System Vsan Cluster Get Config

Get configInfoEx for a vSAN cluster
We can get vSAN 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 QueryDiskMappings. Fault domain configuration can be retrieved through config.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/VsanClusterGetConfig
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
VsanClusterGetConfigRequestType of type(s) application/json
Required 
"VsanClusterGetConfigRequestType Object"
cluster
Required

The target vCenter cluster

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

The configuration spec for the vCenter cluster ConfigInfoEx inherits from VsanClusterConfigInfo. It appends data efficiency configuration.

Returns VsanConfigInfoEx of type(s) application/json
This response body class contains all of the following: InlineVsanConfigInfoEx0 
"VsanConfigInfoEx Object"
dataEfficiencyConfig
Optional

The data efficiency configuration for vSAN.

resyncIopsLimitConfig
Optional

vSAN throttling IOPS limit configuration specification.

iscsiConfig
Optional

vSAN iSCSI configuration.

dataEncryptionConfig
Optional

The data encryption configuration for vSAN.

extendedConfig
Optional

vSAN extended configurations.

datastoreConfig
Optional

vSAN datastore configuration.

perfsvcConfig
Optional

vSAN performance service configuration.

unmapConfig
Optional

SCSI unmap command configuration on vSAN.

vumConfig
Optional

vSAN build recommendation engine configuration for this vSAN cluster.

Build recommendation engine would use it to generate different baselines for this vSAN cluster. See VsanVumConfig

fileServiceConfig
Optional

vSAN file service configurations.

metricsConfig
Optional

vSAN metrics configuration for all monitor clients

rdmaConfig
Optional

RDMA Spec for vSAN.

dataInTransitEncryptionConfig
Optional

Data-in-transit encryption configuration for the vSAN cluster.

vsanHealthConfig
Optional

vSAN Health configuration.

string
mode
Optional

Mode for vSAN.

See also VsanModeEnum.

vsanPMemConfig
Optional

Deprecated as of vSphere 9.0 APIs with no replacement.

vSAN PMem configuration.

vsanEsaConfigInfo
Optional

Configuration info for vSAN ESA.

xvcDatastoreConfig
Optional

vSAN cross VC datastore configuration.

serverClusterConfig
Optional

Server cluster configuration for HCI Mesh.

datastoreDefaultPolicySelectionConfig
Optional

vSAN datastore default policy selection configurations.

Only available for vSAN ESA

snapServiceConfig
Optional

The configuration for vSAN Snapshot service.

The Snapshot service configuration will require specific User role and privileges. TODO: Update required privileges and the implementaiton to include the necessary validations.

Since: 8.0.0.4

deconvergedNetConfig
Optional

De-converged network configuration for vSAN.

siteFaultDomainConfig
Optional

Configuration of site fault domain for compute only cluster.


500

Failure

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}/VsanClusterGetConfig
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