List V2 Cluster Compatibility
Returns Namespaces compatibility information for all vSphere clusters that match the #FilterSpecV2 and are associated with the vSphere Zones in the vCenter Server that match the #ZoneFilterSpec. The result contains only visible (subject to permission checks) clusters.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/cluster-compatibility/v2
Query Parameters
Query Parameters
boolean
compatible
Optional
Set this flag to true to only return vSphere clusters that are currently compatible with the Namespaces feature. If set to false, both compatible and incompatible vSphere clusters will be returned. If unset, both compatible and incompatible vSphere clusters will be listed.
network_provider
Optional
The network type that will be considered. A Supervisor can only be enabled with this network type if all hosts are compatible for this specific network type. If unset, this will default to NSXT.
array of
string
zones
Optional
A list of vSphere Zone identifiers which will be used to filter vSphere Zones that correspond to this specific set of identifiers. If unset or empty, results will not be filtered for specific vSphere Zone identifiers.
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
NamespaceManagementClusterCompatibilityZoneCompatibilityInfo
of type application/json
Namespaces compatibility information for vSphere Zones that match the #ZoneFilterSpec and the vSphere clusters associated with them that match the #FilterSpecV2.
{
"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"
}
}
}
],
"zone_summaries": [
{
"cluster_summaries": [
{
"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"
}
}
}
]
}
],
"compatible": false,
"zone": "string"
}
]
}
boolean
compatible
Required
Flag to indicate whether the vSphere Zones are compatible with each other. If false, the list of incompatibility issues will be given in the ClusterCompatibility.ZoneCompatibilityInfo.incompatibility-reasons field.
array of
StdLocalizableMessage
incompatibility_reasons
Required
Reasons for incompatibility between the vSphere Zones.
zone_summaries
Required
Information about the compatibility of a list of vSphere Zones and the vSphere clusters associated with them.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if zoneFilter or clusterFilter contain any errors.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege on the vSphere clusters associated with the vSphere Zones.
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-GetNamespaceManagementClusterCompatibilityV2 -Zones "MyZones" -Compatible $true -NetworkProvider "NSXT"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/cluster-compatibility/v2
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list_v2
Availability
Added in 8.0.0.1
