NSX-T Data Center REST API
RoutesRequestParameters (schema)
Routes request parameters
| Name | Description | Type | Notes |
|---|---|---|---|
| component_type | Define the DR routes. Component type define to take the route from CCP. |
string | Enum: DR_ROUTES |
| cursor | Opaque cursor to be used for getting next page of records (supplied by current result page) | string | |
| edge_id | UUID of edge node UUID of edge node. Edge should be member of enforcement point. |
string | |
| edge_path | Policy path of edge node Policy path of edge node. Edge should be member of enforcement point. |
string | |
| enforcement_point_path | Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format. |
string | |
| 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 | |
| network_prefix | Network address filter parameter IPAddress or CIDR network address to filter entries in the table. |
IPAddressOrCIDRBlock | |
| page_size | Maximum number of results to return in this page (server may return fewer) | integer | Minimum: 0 Maximum: 1000 Default: "1000" |
| route_source | Filter routes based on the source from which route is learned Filter routes based on the source from which route is learned. |
string | Enum: BGP, STATIC, CONNECTED, OSPF |
| sort_ascending | boolean | ||
| sort_by | Field by which records are sorted | string |