Transport Node list parameters
| Name | Description | Type | Notes |
|---|---|---|---|
| cursor | Opaque cursor to be used for getting next page of records (supplied by current result page) | string | |
| in_maintenance_mode | maintenance mode flag If the flag is true, transport node with 'ENABLED' or 'FORCE_ENABLED' desired state will be returned, otherwise transport nodes in 'DISABLED' will be returned. |
boolean | |
| included_fields | Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs. |
string | |
| node_id | node identifier This property can be used by itself or along with 'transport_zone_id'. |
string | |
| node_ip | Fabric node IP address This property can only be used alone. It can not be combined with other filtering properties. If the ESX host has both IPv4 and IPv6 addresses, and the NSX Manager has both IPv4 and IPv6 addresses, then this filter will work only on the IPv6 address of the ESX host. In all other cases, this filter will work only on the IPv4 address of ESX host. |
string | |
| node_types | a list of fabric node types separated by comma or a single type The fabric node type is the resource_type of the Node such as HostNode, EdgeNode and PublicCloudGatewayNode. If a list of fabric node types are given, all transport nodes of all given types will be returned. |
string | |
| page_size | Maximum number of results to return in this page (server may return fewer) | integer | Minimum: 0 Maximum: 1000 Default: "1000" |
| sort_ascending | boolean | ||
| sort_by | Field by which records are sorted | string | |
| transport_zone_id | Transport zone identifier This propery can be used along with 'node_id'. |
string |