Get Software Clusters
Returns upgrade related information of a specific cluster.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/software/clusters/{cluster}
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster which will be upgraded. 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
NamespaceManagementSoftwareClustersInfo
of type application/json
Information about the upgrade of the specified WCP enabled cluster.
{
"available_versions": [
"string"
],
"current_version": "string",
"last_upgraded_date": "string",
"messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"severity": "INFO"
}
],
"state": "PENDING",
"upgrade_status": {
"desired_version": "string",
"messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"severity": "INFO"
}
],
"progress": {
"completed": 0,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"total": 0
}
}
}
array of
string
available_versions
Required
Set of available versions can be upgraded to.
string
current_version
Required
Current version of the cluster.
messages
Required
Current set of messages associated with the cluster version.
state
Required
The Clusters.State enumerated type describes the state of the upgrade.
PENDING : Upgrade is in progress.
READY : Cluster is ready when there is no upgrade or upgrade is completed.
ERROR : Upgrade failed and need user intervention.
Possible values are: PENDING , READY , ERROR
string
last_upgraded_date
Optional
Date of last successful upgrade. If unset, the cluster has not yet been upgraded.
upgrade_status
Optional
Information about upgrade in progress. If unset, the cluster upgrade is not in progress.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
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-GetClusterNamespaceManagementSoftware -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/software/clusters/{cluster}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
