List Software Clusters
Returns upgrade related information about all WCP enabled clusters.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/software/clusters
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
array of
NamespaceManagementSoftwareClustersSummary
of type application/json
List of upgrade summary of all WCP enabled clusters.
[
{
"available_versions": [
"string"
],
"cluster": "string",
"cluster_name": "string",
"current_version": "string",
"desired_version": "string",
"last_upgraded_date": "string",
"state": "PENDING"
}
]
array of
string
available_versions
Required
Set of versions available for upgrade.
string
cluster
Required
Identifier for the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
string
cluster_name
Required
Name of the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource.name. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.name.
string
current_version
Required
Current version of the cluster.
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
desired_version
Optional
Desired version the cluster will be upgraded to. If unset, the cluster upgrade is not in progress.
string
last_upgraded_date
Optional
Date of last successful upgrade. If unset, the cluster has not yet been upgraded.
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-ListNamespaceManagementSoftwareClusters
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/software/clusters
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0.0
