List Cluster Compatibility
Returns Namespaces compatibility information for all clusters in vCenter 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
Compatibility criteria for matching the filter. If true, only clusters which are compatible for Namespaces match the filter. If false, all clusters match the filter. If unset, both compatible and incompatible clusters match the filter.
network_provider
Optional
The network provider whose networks will be considered. If unset, this will default to NSXT_CONTAINER_PLUGIN. This field is optional because it was added in a newer version than its parent node.
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 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 cluster.
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
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. | com.vmware.vapi.std.errors.internal_server_error : if the server reports an unknown internal error.
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
