more than half documented
List Edge Cluster Compatibility
DescriptionReturns Namespaces compatibility information of NSX-T Edge Clusters matching the EdgeClusterCompatibility.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/edge-cluster-compatibility
Query Parameters
Query Parameters
string
cluster
Required
Identifier of a vCenter Cluster. Only Edge Clusters that are associated with the particular vCenter Cluster will be considered by the filter.
The parameter must be an identifier for the resource type: ClusterComputeResource.
string
distributed_switch
Required
Identifier of a Distributed Switch. Only Edge Clusters that are associated with the particular Distributed Switch will be considered by the filter.
The parameter must be an identifier for the resource type: vSphereDistributedSwitch.
filter
Optional
Specification of matching Edge Clusters for which information should be returned.
If unset, the behavior is equivalent to a EdgeClusterCompatibility.FilterSpec with all fields unset which means all Edge Clusters match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementEdgeClusterCompatibilitySummary of type application/json
List of summaries of Edge Clusters associated with the given vCenter Cluster and Distributed Switch matching the EdgeClusterCompatibility.FilterSpec.
{
"compatible": false,
"display_name": "string",
"edge_cluster": "string",
"incompatibility_reasons": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
boolean
compatible
Required
Compatibility of this Edge Cluster with Namespaces feature.
string
display_name
Required
Display name of the Edge Cluster.
string
edge_cluster
Required
Identifier of the Edge Cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: NSXEdgeCluster. When operations return a value of this structure as a result, the field will be an identifier for the resource type: NSXEdgeCluster.
array of
StdLocalizableMessage
incompatibility_reasons
Optional
List of reasons for incompatibility. If unset, this Edge Cluster is compatible.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/edge-cluster-compatibility?cluster=string&distributed_switch=string&
Errors
403
com.vmware.vapi.std.errors.unauthorized : The server understood the request, but is refusing to fulfill it.
404
com.vmware.vapi.std.errors.not_found : The requested resource could not be found but may be available again in the future.
500
com.vmware.vapi.std.errors.error : The server encountered an unexpected condition which prevented it from fulfilling the request. | com.vmware.vapi.std.errors.internal_server_error : The server encountered an unexpected condition which prevented it from fulfilling the request.
Availability
Added in 7.0.0.0
