Get Clusters Enablement Software
Returns whether the given cluster is managed with a single software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
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
SettingsClustersEnablementSoftwareInfo of type application/json
Information about the feature enablement.
{
"enabled": false
}
boolean
enabled
Required
Status of the feature enablement True if feature is enabled, false otherwise
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterEnablementSoftware -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster 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.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0
