Check Networks NSX Edges Compatibility
Returns a list of Edges matching the given filter and their compatibility information.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/networks/nsx/edges?action=check_compatibility
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"
Request Body
Request Body
NamespaceManagementNetworksNsxEdgesFilterSpec of mimetype application/json
Optional
Specification of matching Edges for which information should be returned. If unset, the behavior is equivalent to a given filter with all fields unset which means all Edges will be returned.
{
"distributed_switch": [
"string"
]
}
array of
string
distributed_switch
Required
Distributed switch UUID criteria. If distributed switches identifiers are specified, they will be used to filter the Edges. To obtain the available distributed switch UUIDs, use: DistributedSwitches.list. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: vSphereDistributedSwitch. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: vSphereDistributedSwitch.
boolean
compatible
Optional
Compatibility criteria. If true, only Edges which are compatible with vSphere Namespaces will be returned. If false, only Edges incompatible with vSphere Namespaces will be returned. If unset, both compatible and incompatible Edges will be returned.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementNetworksNsxEdgesCompatibilitySummary
of type application/json
List of Edge compatibility summaries matching the given filter.
[
{
"compatible": false,
"edge_cluster": "string",
"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"
}
}
}
],
"name": "string"
}
]
boolean
compatible
Required
Compatibility of this Edge with vSphere Namespaces.
string
edge_cluster
Required
Identifier of the Edge. 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
Required
List of reasons for incompatibility. If empty, this Edge is compatible.
string
name
Required
User-friendly identifier of the Edge.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one or more fields of the given filter is incorrect.
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.
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-CheckCompatibilityNsxEdges
PowerCLI Client SDK All Parameters Example
$NamespaceManagementNetworksNsxEdgesFilterSpec = Initialize-NamespaceManagementNetworksNsxEdgesFilterSpec -Compatible $false -DistributedSwitch "MyDistributedSwitch"
Invoke-CheckCompatibilityNsxEdges -NamespaceManagementNetworksNsxEdgesFilterSpec $NamespaceManagementNetworksNsxEdgesFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"compatible":false,"distributed_switch":["string"]}' https://{api_host}/api/vcenter/namespace-management/networks/nsx/edges?action=check_compatibility
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: check
Availability
Added in 8.0.0.1
