Logical-routers diagnosis

Returns information of all logical-routers or specified type of
logical-routers configured on edge.

Request:

Method:

GET

URI Path(s):

/api/v1/node/logical-routers/diagnosis
/api/v1/transport-nodes/<transport-node-id>/node/logical-routers/diagnosis
/api/v1/cluster/<cluster-node-id>/node/logical-routers/diagnosis

Request Headers:

n/a

Query Parameters:

LogicalRouterType+

Name	Description	Type	Notes
fields	Fields to include in query results Comma-separated field names to include in query result	string
router_type	Logical router type Logical router type	string	Enum: SERVICE_ROUTER_TIER0, VRF_SERVICE_ROUTER_TIER0, DISTRIBUTED_ROUTER_TIER0, VRF_DISTRIBUTED_ROUTER_TIER0, SERVICE_ROUTER_TIER1, VRF_SERVICE_ROUTER_TIER1, DISTRIBUTED_ROUTER_TIER1, VRF_DISTRIBUTED_ROUTER_TIER1, TUNNEL, RTEP_TUNNEL_VRF

Request Body:

n/a

Example Request:

GET https://<ip>/api/v1/node/logical-routers/diagnosis (or) GET https://<ip>/api/v1/node/logical-routers/diagnosis?router_type=SERVICE_ROUTER_TIER0

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalRoutersInfo+

Name	Description	Type	Notes
ha_info	Logical router high-availability information Logical router high-availability information	HaInfo	Readonly
logical_router_uuid	Logical router UUID Logical router UUID	string	Readonly
mp_router_uuid	MP logical router UUID MP logical router UUID	string	Readonly
name	Name of the logical router Name of the logical router	string	Readonly
router_type	Logical router type Logical router type	string	Readonly Enum: SERVICE_ROUTER_TIER0, VRF_SERVICE_ROUTER_TIER0, DISTRIBUTED_ROUTER_TIER0, VRF_DISTRIBUTED_ROUTER_TIER0, SERVICE_ROUTER_TIER1, VRF_SERVICE_ROUTER_TIER1, DISTRIBUTED_ROUTER_TIER1, VRF_DISTRIBUTED_ROUTER_TIER1, TUNNEL, RTEP_TUNNEL_VRF

Example Response:

{ "result_count": 3, "results": [ { "logical_router_uuid": "fd5b1cf9-8e31-47d8-87c3-0e5c0f613a02", "router_type": "SERVICE_ROUTER_TIER0", "mp_router_uuid": "7141da82-ecb9-4087-82ba-aed1b0d1dda1", "name": "SR-tier0", "ha_info": { "failover_mode": "PREEMPTIVE", "ha_mode": "ACTIVE_STANDBY", "ha_state": "ACTIVE", ], "rank": 0, "state-history": [ { "event": "Routing Up", "state": "STANDBY", "event_timestamp": "2020-06-18T11:10:45.344657" }, { "event": "Remote State Updated", "state": "SYNC", "event_timestamp": "2020-06-18T11:10:40.344657" }, ] } }, { "router_type": "DISTRIBUTED_ROUTER_TIER0", "logical_router_uuid": "7141da82-ecb9-4087-82ba-aed1b0d1dda1", "mp_router_uuid": "7141da82-ecb9-4087-82ba-aed1b0d1dda1", "name": "DR-tier0" }, { "router_type": "TUNNEL", "logical_router_uuid": "736a80e3-23f6-5a2d-81d6-bbefb2786666", "name": "" } ] }

Logical-routers diagnosis

Request:

LogicalRouterType (schema)

Example Request:

Successful Response:

LogicalRoutersInfo (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: