Each row represents one L3 logical router.
Summary:
ports set of Logical_Router_Ports
static_routes set of Logical_Router_Static_Routes
policies set of Logical_Router_Policys
enabled optional boolean
nat set of NATs
load_balancer set of weak reference to
Load_Balancers
Naming:
name string
external_ids : neutron:router_name
optional string
Options:
options : chassis optional string
options : dnat_force_snat_ip
optional string
options : lb_force_snat_ip optional string
Common Columns:
external_ids map of string-string pairs
Details:
ports: set of Logical_Router_Ports
The router's ports.
static_routes: set of Logical_Router_Static_Routes
Zero or more static routes for the router.
policies: set of Logical_Router_Policys
Zero or more routing policies for the router.
enabled: optional boolean
This column is used to administratively set router state.
If this column is empty or is set to true, the router is
enabled. If this column is set to false, the router is
disabled. A disabled router has all ingress and egress
traffic dropped.
nat: set of NATs
One or more NAT rules for the router. NAT rules only work
on Gateway routers, and on distributed routers with one
logical router port with a redirect-chassis specified.
load_balancer: set of weak reference to Load_Balancers
Load balance a virtual ip address to a set of logical port
ip addresses. Load balancer rules only work on the Gateway
routers.
Naming:
These columns provide names for the logical router. From OVN's
perspective, these names have no special meaning or purpose other
than to provide convenience for human interaction with the
northbound database. There is no requirement for the name to be
unique. (For a unique identifier for a logical router, use its
row UUID.)
(Originally, name was intended to serve the purpose of a human-
friendly name, but the Neutron integration used it to uniquely
identify its own router object, in the format neutron-uuid. Later
on, Neutron started propagating the friendly name of a router as
external_ids:neutron:router_name. Perhaps this can be cleaned up
someday.)
name: string
A name for the logical router.
external_ids : neutron:router_name: optional string
Another name for the logical router.
Options:
Additional options for the logical router.
options : chassis: optional string
If set, indicates that the logical router in question is a
Gateway router (which is centralized) and resides in the
set chassis. The same value is also used by ovn-controller
to uniquely identify the chassis in the OVN deployment and
comes from external_ids:system-id in the Open_vSwitch
table of Open_vSwitch database.
The Gateway router can only be connected to a distributed
router via a switch if SNAT and DNAT are to be configured
in the Gateway router.
options : dnat_force_snat_ip: optional string
If set, indicates the IP address to use to force SNAT a
packet that has already been DNATed in the gateway router.
When multiple gateway routers are configured, a packet can
potentially enter any of the gateway router, get DNATted
and eventually reach the logical switch port. For the
return traffic to go back to the same gateway router (for
unDNATing), the packet needs a SNAT in the first place.
This can be achieved by setting the above option with a
gateway specific IP address.
options : lb_force_snat_ip: optional string
If set, indicates the IP address to use to force SNAT a
packet that has already been load-balanced in the gateway
router. When multiple gateway routers are configured, a
packet can potentially enter any of the gateway routers,
get DNATted as part of the load- balancing and eventually
reach the logical switch port. For the return traffic to
go back to the same gateway router (for unDNATing), the
packet needs a SNAT in the first place. This can be
achieved by setting the above option with a gateway
specific IP address.
Common Columns:
external_ids: map of string-string pairs
See External IDs at the beginning of this document.
