Management Plane API > Networking > Logical Routing And Services > Logical Router Ports

Associated URIs:

API Description API Path

List Logical Router Ports


Returns information about all logical router ports. Information includes the
resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort,
LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort);
logical_router_id (the router to which each logical router port is assigned);
and any service_bindings (such as DHCP relay service).
The GET request can include a query parameter (logical_router_id
or logical_switch_id).
GET /api/v1/logical-router-ports (Deprecated)

Create a Logical Router Port


Creates a logical router port. The required parameters include resource_type
(LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort,
LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and
logical_router_id (the router to which each logical router port is assigned).
The service_bindings parameter is optional.
POST /api/v1/logical-router-ports (Deprecated)

Delete a Logical Router Port


Deletes the specified logical router port. You must delete logical router
ports before you can delete the associated logical router. To Delete Tier0
router link port you must have to delete attached tier1 router link port,
otherwise pass "force=true" as query param to force delete the Tier0
router link port.
DELETE /api/v1/logical-router-ports/{logical-router-port-id} (Deprecated)

Read Logical Router Port


Returns information about the specified logical router port.
GET /api/v1/logical-router-ports/{logical-router-port-id} (Deprecated)

Update a Logical Router Port


Modifies the specified logical router port. Required parameters include the
resource_type and logical_router_id. Modifiable parameters include the
resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort,
LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort),
logical_router_id (to reassign the port to a different router), and service_bindings.
PUT /api/v1/logical-router-ports/{logical-router-port-id} (Deprecated)

Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
Logical Router Port of the given id, on a node if a query parameter
"transport_node_id=<transport-node-id>" is given. The transport_node_id
parameter is mandatory if the router port is not uplink type.
Query parameter "source=realtime" is the only supported source.
GET /api/v1/logical-router-ports/{logical-router-port-id}/arp-table (Deprecated)

Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the Logical Router Port of the given id, on a node if a query
parameter "transport_node_id=<transport-node-id>" is given. The
transport_node_id parameter is mandatory if the router port is not uplink
type. Query parameter "source=realtime" is the only supported source.
GET /api/v1/logical-router-ports/{logical-router-port-id}/arp-table?format=csv (Deprecated)

Get the Realized State of a Logical Router Port


Return realized state information of a logical router port.
Any configuration update that affects the logical router port can use this API
to get its realized state by passing a request_id returned by the
configuration change operation. e.g. Update configuration of logical router ports,
dhcp relays, etc.
GET /api/v1/logical-router-ports/{logical-router-port-id}/state (Deprecated)

Get the statistics of a specified logical router port on all or a specified node


Returns the statistics for the Logical Router Port. If query parameter
"transport_node_id=<transport-node-id>" is given, only the statistics
from the given node for the logical router port will be returned.
Otherwise the statistics from each node for the same logical router port
will be returned. The transport_node_id is mandatory if the router port
is not uplink type.
The query parameter "source=cached" will be ignored and it will always return
realtime statistics of the logical router port.
GET /api/v1/logical-router-ports/{logical-router-port-id}/statistics (Deprecated)

Get the statistics summary of a specified logical router port


Returns the summation of statistics from all nodes for the Specified
Logical Router Port.
The query parameter "source=realtime" is not supported.
GET /api/v1/logical-router-ports/{logical-router-port-id}/statistics/summary (Deprecated)