List Networks NSX Edges
Returns a list of Edges matching the given filter.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/networks/nsx/edges
Query Parameters
Query Parameters
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.
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.
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
NamespaceManagementNetworksNsxEdgesSummary
of type application/json
List of Edge summaries matching the given filter.
[
{
"edge_cluster": "string",
"name": "string"
}
]
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.
string
name
Required
Human-readable identifier of the Edge.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one or more fields of the Edges.FilterSpec 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-ListNetworksNsxEdges -DistributedSwitch "MyDistributedSwitch" -Compatible $true
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/networks/nsx/edges?distributed_switch=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.1
