Get Clusters Configuration
Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/configuration
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.
string
commit
Required
Identifier of the commit to get. The parameter must be an identifier for the resource type: ClusterComputeResource.
Query Parameters
Query Parameters
doc_structure
Optional
This parameter has no documentation
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClustersConfigurationInfo
of type application/json
{
"config": "string",
"host_info": {
"key": {
"is_vsan_witness": false,
"name": "string"
}
},
"metadata": {
"author": "string",
"creation_time": "string",
"id": "string"
}
}
string
config
Required
Configuration specification associated with the commit, encoded as JSON.
map of
SettingsHostInfo
host_info
Required
A mapping of BIOS UUIDs for every host in the cluster to information about that host. The host-specific/host-override sections of the configuration use BIOS UUIDs to identify hosts, so this information can be useful to get details about hosts mentioned there.
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster or no commit associated with commit in the system.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterConfiguration -Cluster "MyCluster" -Commit "MyCommit" -DocStructure "HOST_ORIENTED"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/configuration
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.1.0
