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

included_fields

Optional

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

integer

page_size

Optional

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

string

sort_by

Optional

Field by which records are sorted

string

cursor

Optional

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

string

router_type

Optional

Type of Logical Router

Possible values are : TIER0, TIER1,

boolean

sort_ascending

Optional

sort_ascending

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns LogicalRouterListResult of type(s) application/json

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

{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_revision": 0,
            "_create_user": "string",
            "_schema": "string",
            "_create_time": 0,
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "advanced_config": {
                "internal_transit_network": "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"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

string

module_name

Optional

module_name

string

error_message

Optional

error_message

integer As int64 As int64

error_code

Optional

error_code

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Logical Routing And Services Operations

Create Dhcp Relay Profile

POST

Create Logical Router

POST

Create Logical Router Port

POST

Create Service

POST

Create Service Profile

POST

Create Static Hop Bfd Peer

Delete Dhcp Relay Profile

DELETE

Delete IP Prefix List

DELETE

Delete Logical Router

DELETE

Delete Logical Router Port

Delete Service Profile