List Edge Cluster Compatibility

Released in v7.0.0.0

Required	Parameter Name	Type	Description
required	cluster	string	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.
required	distributed_switch	string	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.
optional	filter	NamespaceManagementEdgeClusterCompatibilityFilterSpec	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

Required	Parameter Name	Type	Description
required	vmware-api-session-id	string	Required session ID, obtained by first calling Create Session API

Response

Response 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"
}

Property Name	Type	Description
compatible	boolean	Compatibility of this Edge Cluster with Namespaces feature.
display_name	string	Display name of the Edge Cluster.
edge_cluster	string	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.
incompatibility_reasons	array of Std_LocalizableMessage	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

Code	Returns	Description
404	Error	com.vmware.vapi.std.errors.error : The requested resource could not be found but may be available again in the future. \| com.vmware.vapi.std.errors.not_found : The requested resource could not be found but may be available again in the future.
500	Error	com.vmware.vapi.std.errors.internal_server_error : The server encountered an unexpected condition which prevented it from fulfilling the request.
default	Error	Not available
401	Error	com.vmware.vapi.std.errors.unauthenticated : The request requires user authentication. \| com.vmware.vapi.std.errors.unauthorized : The request requires user authentication.

List Edge Cluster Compatibility

On This Page

Request

URL

Query Parameters