Read Logical Router
Returns information about the specified logical router.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/logical-routers/{logical-router-id}
COPY
Path Parameters
string
logical-router-id
Required
logical-router-id
Responses
200
OK
Returns LogicalRouter of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineLogicalRouter1
{
"_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",
"failover_mode": "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
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
403
Returns Forbidden of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
404
Not Found
Operation doesn't return any data structure
412
Returns PreconditionFailed of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
500
Returns InternalServerError of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
503
Returns ServiceUnavailable of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
Logical Routing And Services Operations
POST
Add Bgp Neighbor
POST
Add IP Prefix List
POST
Add Nat Rule
POST
Add Route Map
POST
Add Static Route
POST
Create BGP Community List
POST
Create Dhcp Relay
POST
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
Delete BGP Community List
DELETE
Delete Bgp Neighbor
DELETE
Delete Dhcp Relay
DELETE
Delete Dhcp Relay Profile
DELETE
Delete IP Prefix List
DELETE
Delete Logical Router
DELETE
Delete Logical Router Port
DELETE
Delete Nat Rule
DELETE
Delete Route Map
DELETE
Delete Service
DELETE
Delete Service Profile
DELETE
Delete Static Hop Bfd Peer
DELETE
Delete Static Route
GET
Get Bgp Neighbors Status
GET
Get Logical Router Forwarding Table
GET
Get Logical Router Forwarding Table In Csv Format Csv
GET
Get Logical Router Port Arp Table
GET
Get Logical Router Port Arp Table In Csv Format Csv
GET
Get Logical Router Port Statistics
GET
Get Logical Router Port Statistics Summary
GET
Get Logical Router Route Table
GET
Get Logical Router Route Table In Csv Format Csv
GET
Get Logical Router Routing Table
GET
Get Logical Router Routing Table In Csv Format Csv
GET
Get Logical Router Status
GET
Get Nat Rule
GET
Get Nat Statistics Per Logical Router
GET
Get Nat Statistics Per Rule
GET
Get Nat Statistics Per Transport Node
GET
List BGP Community Lists
GET
List Bgp Neighbors
GET
List Dhcp Relay Profiles
GET
List Dhcp Relays
GET
List IP Prefix Lists
GET
List Logical Router Ports
GET
List Logical Routers
GET
List Nat Rules
GET
List Route Maps
GET
List Service Profiles
GET
List Services
GET
List Static Hop Bfd Peers
GET
List Static Routes
GET
Read Advertisement Config
GET
Read Advertise Rule List
GET
Read BGP Community List
GET
Read Bgp Config
GET
Read Bgp Neighbor
GET
Read Bgp Neighbor With Password Show Sensitive Data
GET
Read Debug Info Text
GET
Read Dhcp Relay
GET
Read Dhcp Relay Profile
GET
Read IP Prefix List
GET
Read Logical Router
GET
Read Logical Router Port
GET
Read Redistribution Config
GET
Read Redistribution Rule List
GET
Read Route Map
GET
Read Routing Bfd Config
GET
Read Routing Config
GET
Read Service
GET
Read Service Profile
GET
Read Static Hop Bfd Peer
GET
Read Static Route
POST
Re Process Logical Router Reprocess
POST
Un Set Password On Bgp Neighbor
PUT
Update Advertisement Config
PUT
Update Advertise Rule List
PUT
Update BGP Community List
PUT
Update Bgp Config
PUT
Update Bgp Neighbor
PUT
Update Dhcp Relay
PUT
Update Dhcp Relay Profile
PUT
Update IP Prefix List
PUT
Update Logical Router
PUT
Update Logical Router Port
PUT
Update Nat Rule
PUT
Update Redistribution Config
PUT
Update Redistribution Rule List
PUT
Update Route Map
PUT
Update Routing Bfd Config
PUT
Update Routing Config
PUT
Update Service
PUT
Update Service Profile
PUT
Update Static Hop Bfd Peer
PUT
Update Static Route