Get Nsx T Edge Clusters

Get Nsx T Edge Clusters

Returns all the configured NSX-T edge clusters for an Org VDC or a VDC Group or a Provider VDC or NSX-T Manager. Supported filters are:

  • orgVdcId - | The filter orgVdcId must be set equal to the id of the NSX-T backed Org VDC for which we want to get the edge clusters. Example: (orgVdcId==urn:vcloud:vdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • vdcGroupId - | The filter vdcGroupId must be set equal to the id of the NSX-T VDC Group for which we want to get the edge clusters. Example: (vdcGroupId==urn:vcloud:vdcGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • pvdcId - | The filter pvdcId must be set equal to the id of the NSX-T backed Provider VDC for which we want to get the edge clusters. pvdcId filter is supported from version 35.2 Example: (pvdcId==urn:vcloud:providervdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • nsxTManagerRef.id - | The filter nsxTManagerRef.id must be set equal to the id of the NSX-T manager for which we want to get the edge clusters. nsxTManagerRef.id filter is supported from version 39.0 Example: (nsxTManagerRef.id==urn:vcloud:nsxtmanager:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
Use of "_context" filter has been deprecated. Please use supported filters.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/nsxTResources/edgeClusters
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
cursor
Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NsxTEdgeClusters of type(s) application/json;version=39.1 
{
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "nodeCount": 0,
            "nodeType": {},
            "deploymentType": {},
            "alreadyImported": false,
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}
array of values
values
Optional

Information about a configured edge cluster on an NSX-T manager. An Edge cluster is a group of edge transport nodes.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/nsxTResources/edgeClusters?pageSize=v
Availability
Added in 34.0
On This Page
Nsx Tresources Operations
GET
Get Importable Tier0 Routers
GET
Get Tier0 Router Interfaces
GET
Get Importable Transport Zones
GET
Get Nsx T Edge Clusters
GET
Get Importable Segments
GET
Get Importable Segment Subnet
GET
Get Segment Qo S Profiles
GET
Get Segment Mac Discovery Profiles
GET
Get Segment Ip Discovery Profiles
GET
Get Segment Security Profiles
GET
Get Segment Spoof Guard Profiles
GET
Get Gateway Qo S Profiles