List Logical Routers

Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-routers

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

router_type

Optional

Type of Logical Router

Possible values are : TIER0, TIER1,

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalRouterListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineLogicalRouterListResult1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_create_user": "string",
            "_protection": "string",
            "_create_time": 0,
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "edge_cluster_member_indices": [
                0
            ],
            "failover_mode": "string",
            "allocation_profile": {
                "allocation_pool": {
                    "allocation_pool_type": "string"
                }
            },
            "firewall_sections": [
                {
                    "target_display_name": "string",
                    "is_valid": false,
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "advanced_config": {
                "internal_transit_network": "string",
                "transport_zone_id": "string",
                "ha_vip_configs": [
                    {
                        "ha_vip_subnets": [
                            {
                                "prefix_length": 0,
                                "active_vip_addresses": [
                                    "string"
                                ]
                            }
                        ],
                        "redundant_uplink_port_ids": [
                            "string"
                        ],
                        "enabled": false
                    }
                ],
                "external_transit_networks": [
                    "string"
                ]
            },
            "router_type": "string",
            "preferred_edge_cluster_member_index": 0,
            "high_availability_mode": "string",
            "edge_cluster_id": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json