Query parameters that may be used to select which transport nodes status to return in a query.
The tunnel_status and bfd_diagnostic_code parameters are ANDed together if both are provided.
| Name | Description | Type | Notes |
|---|---|---|---|
| bfd_diagnostic_code | BFD diagnostic code of Tunnel The BFD diagnostic code of Tunnel as defined in RFC 5880. If specified, only the status for transport nodes connected via tunnels having the specified BFD diagnostic code are returned. |
string | Enum: 0, NO_DIAGNOSTIC, 1, CONTROL_DETECTION_TIME_EXPIRED, 2, ECHO_FUNCTION_FAILED, 3, NEIGHBOR_SIGNALED_SESSION_DOWN, 4, FORWARDING_PLANE_RESET, 5, PATH_DOWN, 6, CONCATENATED_PATH_DOWN, 7, ADMINISTRATIVELY_DOWN, 8, REVERSE_CONCATENATED_PATH_DOWN |
| cursor | Opaque cursor to be used for getting next page of records (supplied by current result page) | string | |
| included_fields | Comma separated list of fields that should be included in query result | 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 | |
| source | The data source, either realtime or cached. If not provided, cached data is returned. | DataSourceType | |
| tunnel_status | Tunnel Status If specified, only the status for transport nodes connected via tunnels having the specified tunnel status are returned. |
string | Enum: UP, DOWN |