List Cluster Compatibility
Returns Namespaces compatibility information for all vSphere clusters in the vCenter Server matching the ClusterCompatibility.FilterSpec. The result contains only visible (subject to permission checks) clusters.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/cluster-compatibility
Query Parameters
Query Parameters
boolean
compatible
Optional
Set this flag to true to only list vSphere clusters that are currently compatible with the Namespaces feature. If set to false, both compatible and incompatible vSphere clusters will be listed. If unset, both compatible and incompatible vSphere clusters will be listed.
network_provider
Optional
The network provider whose networks will be considered. If unset, this will default to NSXT_CONTAINER_PLUGIN.
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
NamespaceManagementClusterCompatibilitySummary
of type application/json
Namespaces compatibility information for the clusters matching the the ClusterCompatibility.FilterSpec.
[
{
"cluster": "string",
"compatible": false,
"incompatibility_reasons": [
{
"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"
}
}
}
]
}
]
string
cluster
Required
Identifier of the vSphere 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.
boolean
compatible
Required
Compatibility of this vSphere cluster. If false, the list of incompatibility issues will be given in the ClusterCompatibility.Summary.incompatibility-reasons field.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege on the vSphere clusters.
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-ListNamespaceManagementClusterCompatibility -Compatible $true -NetworkProvider "NSXT_CONTAINER_PLUGIN"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/cluster-compatibility
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
