'\" p .\" -*- nroff -*- .TH "ovn-nb" 5 " DB Schema 5.13.0" "Open vSwitch 2.10.1" "Open vSwitch Manual" .fp 5 L CR \\" Make fixed-width font available as \\fL. .de TQ . br . ns . TP "\\$1" .. .de ST . PP . RS -0.15in . I "\\$1" . RE .. .SH NAME ovn-nb \- OVN_Northbound database schema .PP .PP .PP .PP This database is the interface between OVN and the cloud management system (CMS), such as OpenStack, running above it\[char46] The CMS produces almost all of the contents of the database\[char46] The \fBovn\-northd\fR program monitors the database contents, transforms it, and stores it into the \fBOVN_Southbound\fR database\[char46] .PP .PP We generally speak of ``the\(cq\(cq CMS, but one can imagine scenarios in which multiple CMSes manage different parts of an OVN deployment\[char46] .SS "External IDs" .PP .PP Each of the tables in this database contains a special column, named \fBexternal_ids\fR\[char46] This column has the same form and purpose each place it appears\[char46] .RS .TP \fBexternal_ids\fR: map of string-string pairs Key-value pairs for use by the CMS\[char46] The CMS might use certain pairs, for example, to identify entities in its own configuration that correspond to those in this database\[char46] .RE .SH "TABLE SUMMARY" .PP The following list summarizes the purpose of each of the tables in the \fBOVN_Northbound\fR database. Each table is described in more detail on a later page. .IP "Table" 1in Purpose .TQ 1in \fBNB_Global\fR Northbound configuration .TQ 1in \fBLogical_Switch\fR L2 logical switch .TQ 1in \fBLogical_Switch_Port\fR L2 logical switch port .TQ 1in \fBAddress_Set\fR Address Sets .TQ 1in \fBPort_Group\fR Port Groups .TQ 1in \fBLoad_Balancer\fR load balancer .TQ 1in \fBACL\fR Access Control List (ACL) rule .TQ 1in \fBLogical_Router\fR L3 logical router .TQ 1in \fBQoS\fR QoS rule .TQ 1in \fBMeter\fR Meter entry .TQ 1in \fBMeter_Band\fR Band for meter entries .TQ 1in \fBLogical_Router_Port\fR L3 logical router port .TQ 1in \fBLogical_Router_Static_Route\fR Logical router static routes .TQ 1in \fBNAT\fR NAT rules .TQ 1in \fBDHCP_Options\fR DHCP options .TQ 1in \fBConnection\fR OVSDB client connections\[char46] .TQ 1in \fBDNS\fR Native DNS resolution .TQ 1in \fBSSL\fR SSL configuration\[char46] .TQ 1in \fBGateway_Chassis\fR Gateway_Chassis configuration\[char46] .\" check if in troff mode (TTY) .if t \{ .bp .SH "TABLE RELATIONSHIPS" .PP The following diagram shows the relationship among tables in the database. Each node represents a table. Tables that are part of the ``root set'' are shown with double borders. Each edge leads from the table that contains it and points to the table that its value represents. Edges are labeled with their column names, followed by a constraint on the number of allowed values: \fB?\fR for zero or one, \fB*\fR for zero or more, \fB+\fR for one or more. Thick lines represent strong references; thin lines represent weak references. .RS -1in .ps -3 .PS linethick = 1; linethick = 0.500000; box at 0.386505,0.276075 wid 0.570570 height 0.220860 "NB_Global" box at 0.386505,0.276075 wid 0.515014 height 0.165304 linethick = 1.000000; box at 2.346637,0.441720 wid 0.601225 height 0.220860 "Connection" linethick = 1.000000; box at 2.346637,0.110430 wid 0.331290 height 0.220860 "SSL" linethick = 0.500000; box at 0.386505,2.411040 wid 0.773010 height 0.220860 "Logical_Switch" box at 0.386505,2.411040 wid 0.717454 height 0.165304 linethick = 1.000000; box at 2.346637,3.282245 wid 1.006150 height 0.220860 "Logical_Switch_Port" linethick = 1.000000; box at 2.346637,2.895740 wid 0.331290 height 0.220860 "ACL" linethick = 1.000000; box at 2.346637,2.122730 wid 0.331290 height 0.220860 "QoS" linethick = 0.500000; box at 2.346637,1.785300 wid 0.754590 height 0.220860 "Load_Balancer" box at 2.346637,1.785300 wid 0.699035 height 0.165304 linethick = 0.500000; box at 2.346637,2.454020 wid 0.331290 height 0.220860 "DNS" box at 2.346637,2.454020 wid 0.275734 height 0.165304 linethick = 0.500000; box at 4.478599,3.282245 wid 0.766870 height 0.220860 "DHCP_Options" box at 4.478599,3.282245 wid 0.711315 height 0.165304 linethick = 0.500000; box at 0.386505,3.558320 wid 0.656440 height 0.220860 "Address_Set" box at 0.386505,3.558320 wid 0.600885 height 0.165304 linethick = 0.500000; box at 0.386505,3.227030 wid 0.601225 height 0.220860 "Port_Group" box at 0.386505,3.227030 wid 0.545670 height 0.165304 linethick = 0.500000; box at 0.386505,3.889610 wid 0.368099 height 0.220860 "Meter" box at 0.386505,3.889610 wid 0.312543 height 0.165304 linethick = 1.000000; box at 2.346637,3.889610 wid 0.638020 height 0.220860 "Meter_Band" linethick = 0.500000; box at 0.386505,1.282225 wid 0.766870 height 0.220860 "Logical_Router" box at 0.386505,1.282225 wid 0.711315 height 0.165304 linethick = 1.000000; box at 2.346637,1.104300 wid 1.000010 height 0.220860 "Logical_Router_Port" linethick = 1.000000; box at 2.346637,0.773010 wid 1.380375 height 0.220860 "Logical_Router_Static_Route" linethick = 1.000000; box at 2.346637,1.435590 wid 0.331290 height 0.220860 "NAT" linethick = 1.000000; box at 4.478599,1.104300 wid 0.871160 height 0.220860 "Gateway_Chassis" linethick = 1.000000; spline -> from 0.673623,0.300339 to 0.673623,0.300339 to 1.040471,0.331343 to 1.672573,0.384756 to 2.045870,0.416303 "connections*" at 1.214730,0.420248 linethick = 1.000000; spline -> from 0.672519,0.233847 to 0.672519,0.233847 to 0.741471,0.224606 to 0.815018,0.215524 to 0.883440,0.208589 to 1.352061,0.161109 to 1.907479,0.130992 to 2.179535,0.117935 "ssl?" at 1.214730,0.254603 linethick = 1.000000; spline -> from 0.524277,2.522751 to 0.524277,2.522751 to 0.619866,2.595105 to 0.753044,2.686011 to 0.883440,2.742330 to 1.160929,2.862213 to 1.297420,2.723778 to 1.546020,2.895740 to 1.618771,2.946052 to 1.585819,3.008069 to 1.656450,3.061385 to 1.716215,3.106440 to 1.785476,3.142484 to 1.856593,3.171285 "ports*" at 1.214730,2.941723 linethick = 1.000000; spline -> from 0.773761,2.489092 to 0.773761,2.489092 to 1.080933,2.551286 to 1.470839,2.631105 to 1.546020,2.650320 to 1.767145,2.706904 to 2.018175,2.786370 to 2.179270,2.839376 "acls*" at 1.214730,2.696347 linethick = 1.000000; spline -> from 0.773408,2.310372 to 0.773408,2.310372 to 0.810468,2.302289 to 0.847572,2.294780 to 0.883440,2.288375 to 1.348969,2.204890 to 1.905801,2.155549 to 2.178828,2.134612 "qos_rules*" at 1.214730,2.334358 linethick = 1.000000; spline -> from 0.521671,2.299727 to 0.521671,2.299727 to 0.617215,2.226578 to 0.751277,2.134612 to 0.883440,2.079750 to 1.235270,1.933806 to 1.665505,1.858360 to 1.968083,1.820593 "load_balancer*" at 1.214730,2.125777 linethick = 0.500000; spline -> from 0.773054,2.409185 to 0.773054,2.409185 to 0.998552,2.409053 to 1.288409,2.410599 to 1.546020,2.417180 to 1.765113,2.422790 to 2.017644,2.435423 to 2.179579,2.444346 "dns_records*" at 1.214730,2.463207 linethick = 0.500000; spline -> from 2.851877,3.282245 to 2.851877,3.282245 to 3.232330,3.282245 to 3.746051,3.282245 to 4.093596,3.282245 "dhcpv4_options?" at 3.539900,3.328228 linethick = 0.500000; spline -> from 2.851523,3.197434 to 2.851523,3.197434 to 2.949364,3.184183 to 3.051269,3.172610 to 3.147255,3.165675 to 3.495375,3.140453 to 3.585441,3.129012 to 3.932545,3.165675 to 3.984579,3.171152 to 4.038955,3.179501 to 4.092403,3.189307 "dhcpv6_options?" at 3.539900,3.211658 linethick = 0.500000; spline -> from 0.688465,3.235511 to 0.688465,3.235511 to 0.995593,3.244168 to 1.477023,3.257729 to 1.842149,3.268021 "ports*" at 1.214730,3.303712 linethick = 1.000000; spline -> from 0.688200,3.161037 to 0.688200,3.161037 to 0.752514,3.147697 to 0.820142,3.134268 to 0.883440,3.122695 to 1.351310,3.037399 to 1.907082,2.956830 to 2.179402,2.918709 "acls*" at 1.214730,3.168723 linethick = 1.000000; spline -> from 0.570923,3.889610 to 0.570923,3.889610 to 0.904466,3.889610 to 1.611792,3.889610 to 2.025993,3.889610 "bands+" at 1.214730,3.935593 linethick = 1.000000; spline -> from 0.623090,1.392832 to 0.623090,1.392832 to 0.704323,1.427772 to 0.796686,1.464169 to 0.883440,1.490805 to 1.245076,1.601898 to 1.670143,1.682026 to 1.968658,1.730438 "load_balancer*" at 1.214730,1.696337 linethick = 1.000000; spline -> from 0.771376,1.222239 to 0.771376,1.222239 to 0.809187,1.217248 to 0.847042,1.212566 to 0.883440,1.208590 to 1.203069,1.173562 to 1.563291,1.147721 to 1.846345,1.130538 "ports*" at 1.214730,1.254617 linethick = 1.000000; spline -> from 0.579404,1.171176 to 0.579404,1.171176 to 0.669338,1.123603 to 0.779282,1.071171 to 0.883440,1.036805 to 1.129787,0.955573 to 1.408248,0.897443 to 1.655611,0.856848 "static_routes*" at 1.214730,1.082832 linethick = 1.000000; spline -> from 0.771420,1.312350 to 0.771420,1.312350 to 1.199579,1.345832 to 1.871568,1.398397 to 2.180772,1.422603 "nat*" at 1.214730,1.420262 linethick = 1.000000; spline -> from 2.849182,1.104300 to 2.849182,1.104300 to 3.211702,1.104300 to 3.696269,1.104300 to 4.042533,1.104300 "gateway_chassis*" at 3.539900,1.150327 .ps +3 .PE .RE\} .bp .SH "NB_Global TABLE" .PP .PP .PP Northbound configuration for an OVN system\[char46] This table must have exactly one row\[char46] .SS "Summary: .TQ .25in \fIStatus:\fR .RS .25in .TQ 2.75in \fBnb_cfg\fR integer .TQ 2.75in \fBsb_cfg\fR integer .TQ 2.75in \fBhv_cfg\fR integer .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .TQ .25in \fIConnection Options:\fR .RS .25in .TQ 2.75in \fBconnections\fR set of \fBConnection\fRs .TQ 2.75in \fBssl\fR optional \fBSSL\fR .RE .SS "Details: .ST "Status:" .PP These columns allow a client to track the overall configuration state of the system\[char46] .IP "\fBnb_cfg\fR: integer" Sequence number for client to increment\[char46] When a client modifies any part of the northbound database configuration and wishes to wait for \fBovn\-northd\fR and possibly all of the hypervisors to finish applying the changes, it may increment this sequence number\[char46] .IP "\fBsb_cfg\fR: integer" Sequence number that \fBovn\-northd\fR sets to the value of \fBnb_cfg\fR after it finishes applying the corresponding configuration changes to the \fBOVN_Southbound\fR database\[char46] .IP "\fBhv_cfg\fR: integer" Sequence number that \fBovn\-northd\fR sets to the smallest sequence number of all the chassis in the system, as reported in the \fBChassis\fR table in the southbound database\[char46] Thus, \fBhv_cfg\fR equals \fBnb_cfg\fR if all chassis are caught up with the northbound configuration (which may never happen, if any chassis is down)\[char46] This value can regress, if a chassis was removed from the system and rejoins before catching up\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .ST "Connection Options:" .PP .IP "\fBconnections\fR: set of \fBConnection\fRs" Database clients to which the Open vSwitch database server should connect or on which it should listen, along with options for how these connections should be configured\[char46] See the \fBConnection\fR table for more information\[char46] .IP "\fBssl\fR: optional \fBSSL\fR" Global SSL configuration\[char46] .bp .SH "Logical_Switch TABLE" .PP .PP .PP Each row represents one L2 logical switch\[char46] .PP .PP There are two kinds of logical switches, that is, ones that fully virtualize the network (overlay logical switches) and ones that provide simple connectivity to a physical network (bridged logical switches)\[char46] They work in the same way when providing connectivity between logical ports on same chasis, but differently when connecting remote logical ports\[char46] Overlay logical switches connect remote logical ports by tunnels, while bridged logical switches provide connectivity to remote ports by bridging the packets to directly connected physical L2 segment with the help of \fBlocalnet\fR ports\[char46] Each bridged logical switch has one and only one \fBlocalnet\fR port, which has only one special address \fBunknown\fR\[char46] .SS "Summary: .TQ 3.00in \fBports\fR set of \fBLogical_Switch_Port\fRs .TQ 3.00in \fBload_balancer\fR set of \fBLoad_Balancer\fRs .TQ 3.00in \fBacls\fR set of \fBACL\fRs .TQ 3.00in \fBqos_rules\fR set of \fBQoS\fRs .TQ 3.00in \fBdns_records\fR set of weak reference to \fBDNS\fRs .TQ .25in \fINaming:\fR .RS .25in .TQ 2.75in \fBname\fR string .TQ 2.75in \fBexternal_ids : neutron:network_name\fR optional string .RE .TQ .25in \fIIP Address Assignment:\fR .RS .25in .TQ 2.75in \fBother_config : subnet\fR optional string .TQ 2.75in \fBother_config : exclude_ips\fR optional string .TQ 2.75in \fBother_config : ipv6_prefix\fR optional string .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBports\fR: set of \fBLogical_Switch_Port\fRs" The logical ports connected to the logical switch\[char46] .IP It is an error for multiple logical switches to include the same logical port\[char46] .IP "\fBload_balancer\fR: set of \fBLoad_Balancer\fRs" Load balance a virtual ip address to a set of logical port endpoint ip addresses\[char46] .IP "\fBacls\fR: set of \fBACL\fRs" Access control rules that apply to packets within the logical switch\[char46] .IP "\fBqos_rules\fR: set of \fBQoS\fRs" QoS marking and metering rules that apply to packets within the logical switch\[char46] .IP "\fBdns_records\fR: set of weak reference to \fBDNS\fRs" This column defines the DNS records to be used for resolving internal DNS queries within the logical switch by the native DNS resolver\[char46] Please see the \fBDNS\fR table\[char46] .ST "Naming:" .PP .PP .PP These columns provide names for the logical switch\[char46] From OVN\(cqs perspective, these names have no special meaning or purpose other than to provide convenience for human interaction with the database\[char46] There is no requirement for the name to be unique\[char46] (For a unique identifier for a logical switch, use its row UUID\[char46]) .PP .PP (Originally, \fBname\fR was intended to serve the purpose of a human-friendly name, but the Neutron integration used it to uniquely identify its own switch object, in the format \fBneutron\-\fIuuid\fB\fR\[char46] Later on, Neutron started propagating the friendly name of a switch as \fBexternal_ids:neutron:network_name\fR\[char46] Perhaps this can be cleaned up someday\[char46]) .IP "\fBname\fR: string" A name for the logical switch\[char46] .IP "\fBexternal_ids : neutron:network_name\fR: optional string" Another name for the logical switch\[char46] .ST "IP Address Assignment:" .PP .PP .PP These options control automatic IP address management (IPAM) for ports attached to the logical switch\[char46] To enable IPAM for IPv4, set \fBother_config:subnet\fR and optionally \fBother_config:exclude_ips\fR\[char46] To enable IPAM for IPv6, set \fBother_config:ipv6_prefix\fR\[char46] IPv4 and IPv6 may be enabled together or separately\[char46] .PP .PP To request dynamic address assignment for a particular port, use the \fBdynamic\fR keyword in the \fBaddresses\fR column of the port\(cqs \fBLogical_Switch_Port\fR row\[char46] This requests both an IPv4 and an IPv6 address, if IPAM for IPv4 and IPv6 are both enabled\[char46] .IP "\fBother_config : subnet\fR: optional string" Set this to an IPv4 subnet, e\[char46]g\[char46] \fB192\[char46]168\[char46]0\[char46]0/24\fR, to enable \fBovn\-northd\fR to automatically assign IP addresses within that subnet\[char46] .IP "\fBother_config : exclude_ips\fR: optional string" To exclude some addresses from automatic IP address management, set this to a list of the IPv4 addresses or \fB\[char46]\[char46]\fR-delimited ranges to exclude\[char46] The addresses or ranges should be a subset of those in \fBother_config:subnet\fR\[char46] .IP Whether listed or not, \fBovn\-northd\fR will never allocate the first or last address in a subnet, such as 192\[char46]168\[char46]0\[char46]0 or 192\[char46]168\[char46]0\[char46]255 in 192\[char46]168\[char46]0\[char46]0/24\[char46] .IP Examples: .RS .IP \(bu \fB192\[char46]168\[char46]0\[char46]2 192\[char46]168\[char46]0\[char46]10\fR .IP \(bu \fB192\[char46]168\[char46]0\[char46]4 192\[char46]168\[char46]0\[char46]30\[char46]\[char46]192\[char46]168\[char46]0\[char46]60 192\[char46]168\[char46]0\[char46]110\[char46]\[char46]192\[char46]168\[char46]0\[char46]120\fR .IP \(bu \fB192\[char46]168\[char46]0\[char46]110\[char46]\[char46]192\[char46]168\[char46]0\[char46]120 192\[char46]168\[char46]0\[char46]25\[char46]\[char46]192\[char46]168\[char46]0\[char46]30 192\[char46]168\[char46]0\[char46]144\fR .RE .IP "\fBother_config : ipv6_prefix\fR: optional string" Set this to an IPv6 prefix to enable \fBovn\-northd\fR to automatically assign IPv6 addresses using this prefix\[char46] The assigned IPv6 address will be generated using the IPv6 prefix and the MAC address (converted to an IEEE EUI64 identifier) of the port\[char46] The IPv6 prefix defined here should be a valid IPv6 address ending with \fB::\fR\[char46] .IP Examples: .RS .IP \(bu \fBaef0::\fR .IP \(bu \fBbef0:1234:a890:5678::\fR .IP \(bu \fB8230:5678::\fR .RE .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Logical_Switch_Port TABLE" .PP .PP .PP A port within an L2 logical switch\[char46] .SS "Summary: .TQ .25in \fICore Features:\fR .RS .25in .TQ 2.75in \fBname\fR string (must be unique within table) .TQ 2.75in \fBtype\fR string .RE .TQ .25in \fIOptions:\fR .RS .25in .TQ 2.75in \fBoptions\fR map of string-string pairs .TQ .25in \fIOptions for router ports:\fR .RS .25in .TQ 2.50in \fBoptions : router-port\fR optional string .TQ 2.50in \fBoptions : nat-addresses\fR optional string .RE .TQ .25in \fIOptions for localnet ports:\fR .RS .25in .TQ 2.50in \fBoptions : network_name\fR optional string .RE .TQ .25in \fIOptions for l2gateway ports:\fR .RS .25in .TQ 2.50in \fBoptions : network_name\fR optional string .TQ 2.50in \fBoptions : l2gateway-chassis\fR optional string .RE .TQ .25in \fIOptions for vtep ports:\fR .RS .25in .TQ 2.50in \fBoptions : vtep-physical-switch\fR optional string .TQ 2.50in \fBoptions : vtep-logical-switch\fR optional string .RE .TQ .25in \fIVMI (or VIF) Options:\fR .RS .25in .TQ 2.50in \fBoptions : requested-chassis\fR optional string .TQ 2.50in \fBoptions : qos_max_rate\fR optional string .TQ 2.50in \fBoptions : qos_burst\fR optional string .RE .RE .TQ .25in \fIContainers:\fR .RS .25in .TQ 2.75in \fBparent_name\fR optional string .TQ 2.75in \fBtag_request\fR optional integer, in range 0 to 4,095 .TQ 2.75in \fBtag\fR optional integer, in range 1 to 4,095 .RE .TQ .25in \fIPort State:\fR .RS .25in .TQ 2.75in \fBup\fR optional boolean .TQ 2.75in \fBenabled\fR optional boolean .RE .TQ .25in \fIAddressing:\fR .RS .25in .TQ 2.75in \fBaddresses\fR set of strings .TQ 2.75in \fBdynamic_addresses\fR optional string .TQ 2.75in \fBport_security\fR set of strings .RE .TQ .25in \fIDHCP:\fR .RS .25in .TQ 2.75in \fBdhcpv4_options\fR optional weak reference to \fBDHCP_Options\fR .TQ 2.75in \fBdhcpv6_options\fR optional weak reference to \fBDHCP_Options\fR .RE .TQ .25in \fINaming:\fR .RS .25in .TQ 2.75in \fBexternal_ids : neutron:port_name\fR optional string .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .ST "Core Features:" .PP .IP "\fBname\fR: string (must be unique within table)" The logical port name\[char46] .IP For entities (VMs or containers) that are spawned in the hypervisor, the name used here must match those used in the \fBexternal_ids:iface-id\fR in the \fBOpen_vSwitch\fR database\(cqs \fBInterface\fR table, because hypervisors use \fBexternal_ids:iface-id\fR as a lookup key to identify the network interface of that entity\[char46] .IP For containers that share a VIF within a VM, the name can be any unique identifier\[char46] See \fBContainers\fR, below, for more information\[char46] .IP "\fBtype\fR: string" Specify a type for this logical port\[char46] Logical ports can be used to model other types of connectivity into an OVN logical switch\[char46] The following types are defined: .RS .TP (empty string) A VM (or VIF) interface\[char46] .TP \fBrouter\fR A connection to a logical router\[char46] .TP \fBlocalnet\fR A connection to a locally accessible network from each \fBovn\-controller\fR instance\[char46] A logical switch can only have a single \fBlocalnet\fR port attached\[char46] This is used to model direct connectivity to an existing network\[char46] .TP \fBlocalport\fR A connection to a local VIF\[char46] Traffic that arrives on a \fBlocalport\fR is never forwarded over a tunnel to another chassis\[char46] These ports are present on every chassis and have the same address in all of them\[char46] This is used to model connectivity to local services that run on every hypervisor\[char46] .TP \fBl2gateway\fR A connection to a physical network\[char46] .TP \fBvtep\fR A port to a logical switch on a VTEP gateway\[char46] .RE .ST "Options:" .PP .IP "\fBoptions\fR: map of string-string pairs" This column provides key/value settings specific to the logical port \fBtype\fR\[char46] The type-specific options are described individually below\[char46] .ST "Options for router ports:" .PP .PP .PP These options apply when \fBtype\fR is \fBrouter\fR\[char46] .IP "\fBoptions : router-port\fR: optional string" Required\[char46] The \fBname\fR of the \fBLogical_Router_Port\fR to which this logical switch port is connected\[char46] .IP "\fBoptions : nat-addresses\fR: optional string" This is used to send gratuitous ARPs for SNAT and DNAT IP addresses via the \fBlocalnet\fR port that is attached to the same logical switch as this type \fBrouter\fR port\[char46] This option is specified on a logical switch port that is connected to a gateway router, or a logical switch port that is connected to a distributed gateway port on a logical router\[char46] .IP This must take one of the following forms: .RS .TP \fBrouter\fR Gratuitous ARPs will be sent for all SNAT and DNAT external IP addresses and for all load balancer IP addresses defined on the \fBoptions:router-port\fR\(cqs logical router, using the \fBoptions:router-port\fR\(cqs MAC address\[char46] .IP This form of \fBoptions:nat-addresses\fR is valid for logical switch ports where \fBoptions:router-port\fR is the name of a port on a gateway router, or the name of a distributed gateway port\[char46] .IP Supported only in OVN 2\[char46]8 and later\[char46] Earlier versions required NAT addresses to be manually synchronized\[char46] .TP \fBEthernet address followed by one or more IPv4 addresses\fR Example: \fB80:fa:5b:06:72:b7 158\[char46]36\[char46]44\[char46]22 158\[char46]36\[char46]44\[char46]24\fR\[char46] This would result in generation of gratuitous ARPs for IP addresses 158\[char46]36\[char46]44\[char46]22 and 158\[char46]36\[char46]44\[char46]24 with a MAC address of 80:fa:5b:06:72:b7\[char46] .IP This form of \fBoptions:nat-addresses\fR is only valid for logical switch ports where \fBoptions:router-port\fR is the name of a port on a gateway router\[char46] .RE .ST "Options for localnet ports:" .PP .PP .PP These options apply when \fBtype\fR is \fBlocalnet\fR\[char46] .IP "\fBoptions : network_name\fR: optional string" Required\[char46] The name of the network to which the \fBlocalnet\fR port is connected\[char46] Each hypervisor, via \fBovn\-controller\fR, uses its local configuration to determine exactly how to connect to this locally accessible network\[char46] .ST "Options for l2gateway ports:" .PP .PP .PP These options apply when \fBtype\fR is \fBl2gateway\fR\[char46] .IP "\fBoptions : network_name\fR: optional string" Required\[char46] The name of the network to which the \fBl2gateway\fR port is connected\[char46] The L2 gateway, via \fBovn\-controller\fR, uses its local configuration to determine exactly how to connect to this network\[char46] .IP "\fBoptions : l2gateway-chassis\fR: optional string" Required\[char46] The chassis on which the \fBl2gateway\fR logical port should be bound to\[char46] \fBovn\-controller\fR running on the defined chassis will connect this logical port to the physical network\[char46] .ST "Options for vtep ports:" .PP .PP .PP These options apply when \fBtype\fR is \fBvtep\fR\[char46] .IP "\fBoptions : vtep-physical-switch\fR: optional string" Required\[char46] The name of the VTEP gateway\[char46] .IP "\fBoptions : vtep-logical-switch\fR: optional string" Required\[char46] A logical switch name connected by the VTEP gateway\[char46] .ST "VMI (or VIF) Options:" .PP .PP .PP These options apply to logical ports with \fBtype\fR having (empty string) .IP "\fBoptions : requested-chassis\fR: optional string" If set, identifies a specific chassis (by name or hostname) that is allowed to bind this port\[char46] Using this option will prevent thrashing between two chassis trying to bind the same port during a live migration\[char46] It can also prevent similar thrashing due to a mis-configuration, if a port is accidentally created on more than one chassis\[char46] .IP "\fBoptions : qos_max_rate\fR: optional string" If set, indicates the maximum rate for data sent from this interface, in bit/s\[char46] The traffic will be shaped according to this limit\[char46] .IP "\fBoptions : qos_burst\fR: optional string" If set, indicates the maximum burst size for data sent from this interface, in bits\[char46] .ST "Containers:" .PP .PP .PP When a large number of containers are nested within a VM, it may be too expensive to dedicate a VIF to each container\[char46] OVN can use VLAN tags to support such cases\[char46] Each container is assigned a VLAN ID and each packet that passes between the hypervisor and the VM is tagged with the appropriate ID for the container\[char46] Such VLAN IDs never appear on a physical wire, even inside a tunnel, so they need not be unique except relative to a single VM on a hypervisor\[char46] .PP .PP These columns are used for VIFs that represent nested containers using shared VIFs\[char46] For VMs and for containers that have dedicated VIFs, they are empty\[char46] .IP "\fBparent_name\fR: optional string" The VM interface through which the nested container sends its network traffic\[char46] This must match the \fBname\fR column for some other \fBLogical_Switch_Port\fR\[char46] .IP "\fBtag_request\fR: optional integer, in range 0 to 4,095" The VLAN tag in the network traffic associated with a container\(cqs network interface\[char46] The client can request \fBovn\-northd\fR to allocate a tag that is unique within the scope of a specific parent (specified in \fBparent_name\fR) by setting a value of \fB0\fR in this column\[char46] The allocated value is written by \fBovn\-northd\fR in the \fBtag\fR column\[char46] (Note that these tags are allocated and managed locally in \fBovn\-northd\fR, so they cannot be reconstructed in the event that the database is lost\[char46]) The client can also request a specific non-zero tag and \fBovn\-northd\fR will honor it and copy that value to the \fBtag\fR column\[char46] .IP When \fBtype\fR is set to \fBlocalnet\fR or \fBl2gateway\fR, this can be set to indicate that the port represents a connection to a specific VLAN on a locally accessible network\[char46] The VLAN ID is used to match incoming traffic and is also added to outgoing traffic\[char46] .IP "\fBtag\fR: optional integer, in range 1 to 4,095" The VLAN tag allocated by \fBovn\-northd\fR based on the contents of the \fBtag_request\fR column\[char46] .ST "Port State:" .PP .IP "\fBup\fR: optional boolean" This column is populated by \fBovn\-northd\fR, rather than by the CMS plugin as is most of this database\[char46] When a logical port is bound to a physical location in the OVN Southbound database \fBBinding\fR table, \fBovn\-northd\fR sets this column to \fBtrue\fR; otherwise, or if the port becomes unbound later, it sets it to \fBfalse\fR\[char46] This allows the CMS to wait for a VM\(cqs (or container\(cqs) networking to become active before it allows the VM (or container) to start\[char46] .IP Logical ports of router type are an exception to this rule\[char46] They are considered to be always up, that is this column is always set to \fBtrue\fR\[char46] .IP "\fBenabled\fR: optional boolean" This column is used to administratively set port state\[char46] If this column is empty or is set to \fBtrue\fR, the port is enabled\[char46] If this column is set to \fBfalse\fR, the port is disabled\[char46] A disabled port has all ingress and egress traffic dropped\[char46] .ST "Addressing:" .PP .IP "\fBaddresses\fR: set of strings" Addresses owned by the logical port\[char46] .IP Each element in the set must take one of the following forms: .RS .TP \fBEthernet address followed by zero or more IPv4 or IPv6 addresses (or both)\fR An Ethernet address defined is owned by the logical port\[char46] Like a physical Ethernet NIC, a logical port ordinarily has a single fixed Ethernet address\[char46] .IP When a OVN logical switch processes a unicast Ethernet frame whose destination MAC address is in a logical port\(cqs \fBaddresses\fR column, it delivers it only to that port, as if a MAC learning process had learned that MAC address on the port\[char46] .IP If IPv4 or IPv6 address(es) (or both) are defined, it indicates that the logical port owns the given IP addresses\[char46] .IP If IPv4 address(es) are defined, the OVN logical switch uses this information to synthesize responses to ARP requests without traversing the physical network\[char46] The OVN logical router connected to the logical switch, if any, uses this information to avoid issuing ARP requests for logical switch ports\[char46] .IP Note that the order here is important\[char46] The Ethernet address must be listed before the IP address(es) if defined\[char46] .IP Examples: .RS .TP \fB80:fa:5b:06:72:b7\fR This indicates that the logical port owns the above mac address\[char46] .TP \fB80:fa:5b:06:72:b7 10\[char46]0\[char46]0\[char46]4 20\[char46]0\[char46]0\[char46]4\fR This indicates that the logical port owns the mac address and two IPv4 addresses\[char46] .TP \fB80:fa:5b:06:72:b7 fdaa:15f2:72cf:0:f816:3eff:fe20:3f41\fR This indicates that the logical port owns the mac address and 1 IPv6 address\[char46] .TP \fB80:fa:5b:06:72:b7 10\[char46]0\[char46]0\[char46]4 fdaa:15f2:72cf:0:f816:3eff:fe20:3f41\fR This indicates that the logical port owns the mac address and 1 IPv4 address and 1 IPv6 address\[char46] .RE .TP \fBunknown\fR This indicates that the logical port has an unknown set of Ethernet addresses\[char46] When an OVN logical switch processes a unicast Ethernet frame whose destination MAC address is not in any logical port\(cqs \fBaddresses\fR column, it delivers it to the port (or ports) whose \fBaddresses\fR columns include \fBunknown\fR\[char46] .TP \fBdynamic\fR Use this keyword to make \fBovn\-northd\fR generate a globally unique MAC address and choose an unused IPv4 address with the logical port\(cqs subnet and store them in the port\(cqs \fBdynamic_addresses\fR column\[char46] \fBovn\-northd\fR will use the subnet specified in \fBother_config:subnet\fR in the port\(cqs \fBLogical_Switch\fR\[char46] .TP \fBEthernet address followed by keyword \(dqdynamic\(dq\fR The keyword \fBdynamic\fR after the MAC address indicates that \fBovn\-northd\fR should choose an unused IPv4 address from the logical port\(cqs subnet and store it with the specified MAC in the port\(cqs \fBdynamic_addresses\fR column\[char46] \fBovn\-northd\fR will use the subnet specified in \fBother_config:subnet\fR in the port\(cqs \fBLogical_Switch\fR table\[char46] .IP Examples: .RS .TP \fB80:fa:5b:06:72:b7 dynamic\fR This indicates that the logical port owns the specified MAC address and \fBovn\-northd\fR should allocate an unused IPv4 address for the logical port from the corresponding logical switch subnet\[char46] .RE .TP \fBrouter\fR Accepted only when \fBtype\fR is \fBrouter\fR\[char46] This indicates that the Ethernet, IPv4, and IPv6 addresses for this logical switch port should be obtained from the connected logical router port, as specified by \fBrouter\-port\fR in \fBoptions\fR\[char46] .IP The resulting addresses are used to populate the logical switch\(cqs destination lookup, and also for the logical switch to generate ARP and ND replies\[char46] .IP If the connected logical router port has a \fBredirect\-chassis\fR specified and the logical router has rules specified in \fBnat\fR with \fBexternal_mac\fR, then those addresses are also used to populate the switch\(cqs destination lookup\[char46] .IP Supported only in OVN 2\[char46]7 and later\[char46] Earlier versions required router addresses to be manually synchronized\[char46] .RE .IP "\fBdynamic_addresses\fR: optional string" Addresses assigned to the logical port by \fBovn\-northd\fR, if \fBdynamic\fR is specified in \fBaddresses\fR\[char46] Addresses will be of the same format as those that populate the \fBaddresses\fR column\[char46] Note that dynamically assigned addresses are constructed and managed locally in ovn-northd, so they cannot be reconstructed in the event that the database is lost\[char46] .IP "\fBport_security\fR: set of strings" This column controls the addresses from which the host attached to the logical port (``the host\(cq\(cq) is allowed to send packets and to which it is allowed to receive packets\[char46] If this column is empty, all addresses are permitted\[char46] .IP Each element in the set must begin with one Ethernet address\[char46] This would restrict the host to sending packets from and receiving packets to the ethernet addresses defined in the logical port\(cqs \fBport_security\fR column\[char46] It also restricts the inner source MAC addresses that the host may send in ARP and IPv6 Neighbor Discovery packets\[char46] The host is always allowed to receive packets to multicast and broadcast Ethernet addresses\[char46] .IP Each element in the set may additionally contain one or more IPv4 or IPv6 addresses (or both), with optional masks\[char46] If a mask is given, it must be a CIDR mask\[char46] In addition to the restrictions described for Ethernet addresses above, such an element restricts the IPv4 or IPv6 addresses from which the host may send and to which it may receive packets to the specified addresses\[char46] A masked address, if the host part is zero, indicates that the host is allowed to use any address in the subnet; if the host part is nonzero, the mask simply indicates the size of the subnet\[char46] In addition: .RS .IP \(bu If any IPv4 address is given, the host is also allowed to receive packets to the IPv4 local broadcast address 255\[char46]255\[char46]255\[char46]255 and to IPv4 multicast addresses (224\[char46]0\[char46]0\[char46]0/4)\[char46] If an IPv4 address with a mask is given, the host is also allowed to receive packets to the broadcast address in that specified subnet\[char46] .IP If any IPv4 address is given, the host is additionally restricted to sending ARP packets with the specified source IPv4 address\[char46] (RARP is not restricted\[char46]) .IP \(bu If any IPv6 address is given, the host is also allowed to receive packets to IPv6 multicast addresses (ff00::/8)\[char46] .IP If any IPv6 address is given, the host is additionally restricted to sending IPv6 Neighbor Discovery Solicitation or Advertisement packets with the specified source address or, for solicitations, the unspecified address\[char46] .RE .IP If an element includes an IPv4 address, but no IPv6 addresses, then IPv6 traffic is not allowed\[char46] If an element includes an IPv6 address, but no IPv4 address, then IPv4 and ARP traffic is not allowed\[char46] .IP This column uses the same lexical syntax as the \fBmatch\fR column in the OVN Southbound database\(cqs \fBPipeline\fR table\[char46] Multiple addresses within an element may be space or comma separated\[char46] .IP This column is provided as a convenience to cloud management systems, but all of the features that it implements can be implemented as ACLs using the \fBACL\fR table\[char46] .IP Examples: .RS .TP \fB80:fa:5b:06:72:b7\fR The host may send traffic from and receive traffic to the specified MAC address, and to receive traffic to Ethernet multicast and broadcast addresses, but not otherwise\[char46] The host may not send ARP or IPv6 Neighbor Discovery packets with inner source Ethernet addresses other than the one specified\[char46] .TP \fB80:fa:5b:06:72:b7 192\[char46]168\[char46]1\[char46]10/24\fR This adds further restrictions to the first example\[char46] The host may send IPv4 packets from or receive IPv4 packets to only 192\[char46]168\[char46]1\[char46]10, except that it may also receive IPv4 packets to 192\[char46]168\[char46]1\[char46]255 (based on the subnet mask), 255\[char46]255\[char46]255\[char46]255, and any address in 224\[char46]0\[char46]0\[char46]0/4\[char46] The host may not send ARPs with a source Ethernet address other than 80:fa:5b:06:72:b7 or source IPv4 address other than 192\[char46]168\[char46]1\[char46]10\[char46] The host may not send or receive any IPv6 (including IPv6 Neighbor Discovery) traffic\[char46] .TP \fB\(dq80:fa:5b:12:42:ba\(dq, \(dq80:fa:5b:06:72:b7 192\[char46]168\[char46]1\[char46]10/24\(dq\fR The host may send traffic from and receive traffic to the specified MAC addresses, and to receive traffic to Ethernet multicast and broadcast addresses, but not otherwise\[char46] With MAC 80:fa:5b:12:42:ba, the host may send traffic from and receive traffic to any L3 address\[char46] With MAC 80:fa:5b:06:72:b7, the host may send IPv4 packets from or receive IPv4 packets to only 192\[char46]168\[char46]1\[char46]10, except that it may also receive IPv4 packets to 192\[char46]168\[char46]1\[char46]255 (based on the subnet mask), 255\[char46]255\[char46]255\[char46]255, and any address in 224\[char46]0\[char46]0\[char46]0/4\[char46] The host may not send or receive any IPv6 (including IPv6 Neighbor Discovery) traffic\[char46] .RE .ST "DHCP:" .PP .IP "\fBdhcpv4_options\fR: optional weak reference to \fBDHCP_Options\fR" This column defines the DHCPv4 Options to be included by the \fBovn\-controller\fR when it replies to the DHCPv4 requests\[char46] Please see the \fBDHCP_Options\fR table\[char46] .IP "\fBdhcpv6_options\fR: optional weak reference to \fBDHCP_Options\fR" This column defines the DHCPv6 Options to be included by the \fBovn\-controller\fR when it replies to the DHCPv6 requests\[char46] Please see the \fBDHCP_Options\fR table\[char46] .ST "Naming:" .PP .IP "\fBexternal_ids : neutron:port_name\fR: optional string" This column gives an optional human-friendly name for the port\[char46] This name has no special meaning or purpose other than to provide convenience for human interaction with the northbound database\[char46] .IP Neutron copies this from its own port object\(cqs name\[char46] (Neutron ports do are not assigned human-friendly names by default, so it will often be empty\[char46]) .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .IP The \fBovn\-northd\fR program copies all these pairs into the \fBexternal_ids\fR column of the \fBPort_Binding\fR table in \fBOVN_Southbound\fR database\[char46] .bp .SH "Address_Set TABLE" .PP .PP .PP Each row in this table represents a named set of addresses\[char46] An address set may contain Ethernet, IPv4, or IPv6 addresses with optional bitwise or CIDR masks\[char46] Address set may ultimately be used in ACLs to compare against fields such as \fBip4\[char46]src\fR or \fBip6\[char46]src\fR\[char46] A single address set must contain addresses of the same type\[char46] As an example, the following would create an address set with three IP addresses: .PP .nf \fB .br \fB ovn\-nbctl create Address_Set name=set1 addresses=\(cq10\[char46]0\[char46]0\[char46]1 10\[char46]0\[char46]0\[char46]2 10\[char46]0\[char46]0\[char46]3\(cq .br \fB \fR .fi .PP .PP Address sets may be used in the \fBmatch\fR column of the \fBACL\fR table\[char46] For syntax information, see the details of the expression language used for the \fBmatch\fR column in the \fBLogical_Flow\fR table of the \fBOVN_Southbound\fR database\[char46] .SS "Summary: .TQ 3.00in \fBname\fR string (must be unique within table) .TQ 3.00in \fBaddresses\fR set of strings .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBname\fR: string (must be unique within table)" A name for the address set\[char46] Names are ASCII and must match \fB[a\-zA\-Z_\[char46]][a\-zA\-Z_\[char46]0\-9]*\fR\[char46] .IP "\fBaddresses\fR: set of strings" The set of addresses in string form\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Port_Group TABLE" .PP .PP .PP Each row in this table represents a named group of logical switch ports\[char46] .PP .PP Port groups may be used in the \fBmatch\fR column of the \fBACL\fR table\[char46] For syntax information, see the details of the expression language used for the \fBmatch\fR column in the \fBLogical_Flow\fR table of the \fBOVN_Southbound\fR database\[char46] .PP .PP For each port group, there are two address sets generated to the \fBAddress_Set\fR table of the \fBOVN_Southbound\fR database, containing the IP addresses of the group of ports, one for IPv4, and the other for IPv6, with \fBname\fR being the \fBname\fR of the \fBPort_Group\fR followed by a suffix \fB_ip4\fR for IPv4 and \fB_ip6\fR for IPv6\[char46] The generated address sets can be used in the same way as regular address sets in the \fBmatch\fR column of the \fBACL\fR table\[char46] For syntax information, see the details of the expression language used for the \fBmatch\fR column in the \fBLogical_Flow\fR table of the \fBOVN_Southbound\fR database\[char46] .SS "Summary: .TQ 3.00in \fBname\fR string (must be unique within table) .TQ 3.00in \fBports\fR set of weak reference to \fBLogical_Switch_Port\fRs .TQ 3.00in \fBacls\fR set of \fBACL\fRs .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBname\fR: string (must be unique within table)" A name for the port group\[char46] Names are ASCII and must match \fB[a\-zA\-Z_\[char46]][a\-zA\-Z_\[char46]0\-9]*\fR\[char46] .IP "\fBports\fR: set of weak reference to \fBLogical_Switch_Port\fRs" The logical switch ports belonging to the group in uuids\[char46] .IP "\fBacls\fR: set of \fBACL\fRs" Access control rules that apply to the port group\[char46] Applying an ACL to a port group has the same effect as applying the ACL to all logical lswitches that the ports of the port group belong to\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Load_Balancer TABLE" .PP .PP .PP Each row represents one load balancer\[char46] .SS "Summary: .TQ 3.00in \fBname\fR string .TQ 3.00in \fBvips\fR map of string-string pairs .TQ 3.00in \fBprotocol\fR optional string, either \fBtcp\fR or \fBudp\fR .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBname\fR: string" A name for the load balancer\[char46] This name has no special meaning or purpose other than to provide convenience for human interaction with the ovn-nb database\[char46] .IP "\fBvips\fR: map of string-string pairs" A map of virtual IP addresses (and an optional port number with \fB:\fR as a separator) associated with this load balancer and their corresponding endpoint IP addresses (and optional port numbers with \fB:\fR as separators) separated by commas\[char46] If the destination IP address (and port number) of a packet leaving a container or a VM matches the virtual IP address (and port number) provided here as a key, then OVN will statefully replace the destination IP address by one of the provided IP address (and port number) in this map as a value\[char46] IPv4 and IPv6 addresses are supported for load balancing; however a VIP of one address family may not be mapped to a destination IP address of a different family\[char46] If specifying an IPv6 address with a port, the address portion must be enclosed in square brackets\[char46] Examples for keys are \(dq192\[char46]168\[char46]1\[char46]4\(dq and \(dq[fd0f::1]:8800\(dq\[char46] Examples for value are \(dq10\[char46]0\[char46]0\[char46]1, 10\[char46]0\[char46]0\[char46]2\(dq and \(dq20\[char46]0\[char46]0\[char46]10:8800, 20\[char46]0\[char46]0\[char46]11:8800\(dq\[char46] .IP When the \fBLoad_Balancer\fR is added to the \fBlogical_switch\fR, the VIP has to be in a different subnet than the one used for the \fBlogical_switch\fR\[char46] Since VIP is in a different subnet, you should connect your logical switch to either a OVN logical router or a real router (this is because the client can now send a packet with VIP as the destination IP address and router\(cqs mac address as the destination MAC address)\[char46] .IP "\fBprotocol\fR: optional string, either \fBtcp\fR or \fBudp\fR" Valid protocols are \fBtcp\fR or \fBudp\fR\[char46] This column is useful when a port number is provided as part of the \fBvips\fR column\[char46] If this column is empty and a port number is provided as part of \fBvips\fR column, OVN assumes the protocol to be \fBtcp\fR\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "ACL TABLE" .PP .PP .PP Each row in this table represents one ACL rule for a logical switch or a port group that points to it through its \fBacls\fR column\[char46] The \fBaction\fR column for the highest-\fBpriority\fR matching row in this table determines a packet\(cqs treatment\[char46] If no row matches, packets are allowed by default\[char46] (Default-deny treatment is possible: add a rule with \fBpriority\fR 0, \fB0\fR as \fBmatch\fR, and \fBdeny\fR as \fBaction\fR\[char46]) .SS "Summary: .TQ 3.00in \fBpriority\fR integer, in range 0 to 32,767 .TQ 3.00in \fBdirection\fR string, either \fBfrom\-lport\fR or \fBto\-lport\fR .TQ 3.00in \fBmatch\fR string .TQ 3.00in \fBaction\fR string, one of \fBallow\-related\fR, \fBallow\fR, \fBdrop\fR, or \fBreject\fR .TQ .25in \fILogging:\fR .RS .25in .TQ 2.75in \fBlog\fR boolean .TQ 2.75in \fBname\fR optional string, at most 63 characters long .TQ 2.75in \fBseverity\fR optional string, one of \fBalert\fR, \fBdebug\fR, \fBinfo\fR, \fBnotice\fR, or \fBwarning\fR .TQ 2.75in \fBmeter\fR optional string .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBpriority\fR: integer, in range 0 to 32,767" The ACL rule\(cqs priority\[char46] Rules with numerically higher priority take precedence over those with lower\[char46] If two ACL rules with the same priority both match, then the one actually applied to a packet is undefined\[char46] .IP Return traffic from an \fBallow\-related\fR flow is always allowed and cannot be changed through an ACL\[char46] .IP "\fBdirection\fR: string, either \fBfrom\-lport\fR or \fBto\-lport\fR" Direction of the traffic to which this rule should apply: .RS .IP \(bu \fBfrom\-lport\fR: Used to implement filters on traffic arriving from a logical port\[char46] These rules are applied to the logical switch\(cqs ingress pipeline\[char46] .IP \(bu \fBto\-lport\fR: Used to implement filters on traffic forwarded to a logical port\[char46] These rules are applied to the logical switch\(cqs egress pipeline\[char46] .RE .IP "\fBmatch\fR: string" The packets that the ACL should match, in the same expression language used for the \fBmatch\fR column in the OVN Southbound database\(cqs \fBLogical_Flow\fR table\[char46] The \fBoutport\fR logical port is only available in the \fBto\-lport\fR direction (the \fBinport\fR is available in both directions)\[char46] .IP By default all traffic is allowed\[char46] When writing a more restrictive policy, it is important to remember to allow flows such as ARP and IPv6 neighbor discovery packets\[char46] .IP Note that you can not create an ACL matching on a port with type=router or type=localnet\[char46] .IP "\fBaction\fR: string, one of \fBallow\-related\fR, \fBallow\fR, \fBdrop\fR, or \fBreject\fR" The action to take when the ACL rule matches: .RS .IP \(bu \fBallow\fR: Forward the packet\[char46] .IP \(bu \fBallow\-related\fR: Forward the packet and related traffic (e\[char46]g\[char46] inbound replies to an outbound connection)\[char46] .IP \(bu \fBdrop\fR: Silently drop the packet\[char46] .IP \(bu \fBreject\fR: Drop the packet, replying with a RST for TCP or ICMPv4/ICMPv6 unreachable message for other IPv4/IPv6-based protocols\[char46] .RE .ST "Logging:" .PP .PP .PP These columns control whether and how OVN logs packets that match an ACL\[char46] .IP "\fBlog\fR: boolean" If set to \fBtrue\fR, packets that match the ACL will trigger a log message on the transport node or nodes that perform ACL processing\[char46] Logging may be combined with any \fBaction\fR\[char46] .IP If set to \fBfalse\fR, the remaining columns in this group have no significance\[char46] .IP "\fBname\fR: optional string, at most 63 characters long" This name, if it is provided, is included in log records\[char46] It provides the administrator and the cloud management system a way to associate a log record with a particular ACL\[char46] .IP "\fBseverity\fR: optional string, one of \fBalert\fR, \fBdebug\fR, \fBinfo\fR, \fBnotice\fR, or \fBwarning\fR" The severity of the ACL\[char46] The severity levels match those of syslog, in decreasing level of severity: \fBalert\fR, \fBwarning\fR, \fBnotice\fR, \fBinfo\fR, or \fBdebug\fR\[char46] When the column is empty, the default is \fBinfo\fR\[char46] .IP "\fBmeter\fR: optional string" The name of a meter to rate-limit log messages for the ACL\[char46] The string must match the \fBname\fR column of a row in the \fBMeter\fR table\[char46] By default, log messages are not rate-limited\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Logical_Router TABLE" .PP .PP .PP Each row represents one L3 logical router\[char46] .SS "Summary: .TQ 3.00in \fBports\fR set of \fBLogical_Router_Port\fRs .TQ 3.00in \fBstatic_routes\fR set of \fBLogical_Router_Static_Route\fRs .TQ 3.00in \fBenabled\fR optional boolean .TQ 3.00in \fBnat\fR set of \fBNAT\fRs .TQ 3.00in \fBload_balancer\fR set of \fBLoad_Balancer\fRs .TQ .25in \fINaming:\fR .RS .25in .TQ 2.75in \fBname\fR string .TQ 2.75in \fBexternal_ids : neutron:router_name\fR optional string .RE .TQ .25in \fIOptions:\fR .RS .25in .TQ 2.75in \fBoptions : chassis\fR optional string .TQ 2.75in \fBoptions : dnat_force_snat_ip\fR optional string .TQ 2.75in \fBoptions : lb_force_snat_ip\fR optional string .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBports\fR: set of \fBLogical_Router_Port\fRs" The router\(cqs ports\[char46] .IP "\fBstatic_routes\fR: set of \fBLogical_Router_Static_Route\fRs" One or more static routes for the router\[char46] .IP "\fBenabled\fR: optional boolean" This column is used to administratively set router state\[char46] If this column is empty or is set to \fBtrue\fR, the router is enabled\[char46] If this column is set to \fBfalse\fR, the router is disabled\[char46] A disabled router has all ingress and egress traffic dropped\[char46] .IP "\fBnat\fR: set of \fBNAT\fRs" One or more NAT rules for the router\[char46] NAT rules only work on Gateway routers, and on distributed routers with one logical router port with a \fBredirect\-chassis\fR specified\[char46] .IP "\fBload_balancer\fR: set of \fBLoad_Balancer\fRs" Load balance a virtual ip address to a set of logical port ip addresses\[char46] Load balancer rules only work on the Gateway routers\[char46] .ST "Naming:" .PP .PP .PP These columns provide names for the logical router\[char46] From OVN\(cqs perspective, these names have no special meaning or purpose other than to provide convenience for human interaction with the northbound database\[char46] There is no requirement for the name to be unique\[char46] (For a unique identifier for a logical router, use its row UUID\[char46]) .PP .PP (Originally, \fBname\fR 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 \fBneutron\-\fIuuid\fB\fR\[char46] Later on, Neutron started propagating the friendly name of a router as \fBexternal_ids:neutron:router_name\fR\[char46] Perhaps this can be cleaned up someday\[char46]) .IP "\fBname\fR: string" A name for the logical router\[char46] .IP "\fBexternal_ids : neutron:router_name\fR: optional string" Another name for the logical router\[char46] .ST "Options:" .PP .PP .PP Additional options for the logical router\[char46] .IP "\fBoptions : chassis\fR: optional string" If set, indicates that the logical router in question is a Gateway router (which is centralized) and resides in the set chassis\[char46] The same value is also used by \fBovn\-controller\fR to uniquely identify the chassis in the OVN deployment and comes from \fBexternal_ids:system\-id\fR in the \fBOpen_vSwitch\fR table of Open_vSwitch database\[char46] .IP 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\[char46] .IP "\fBoptions : dnat_force_snat_ip\fR: optional string" If set, indicates the IP address to use to force SNAT a packet that has already been DNATed in the gateway router\[char46] 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\[char46] For the return traffic to go back to the same gateway router (for unDNATing), the packet needs a SNAT in the first place\[char46] This can be achieved by setting the above option with a gateway specific IP address\[char46] .IP "\fBoptions : lb_force_snat_ip\fR: 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\[char46] 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\[char46] For the return traffic to go back to the same gateway router (for unDNATing), the packet needs a SNAT in the first place\[char46] This can be achieved by setting the above option with a gateway specific IP address\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "QoS TABLE" .PP .PP .PP Each row in this table represents one QoS rule for a logical switch that points to it through its \fBqos_rules\fR column\[char46] Two types of QoS are supported: DSCP marking and metering\[char46] A \fBmatch\fR with the highest-\fBpriority\fR will have QoS applied to it\[char46] If the \fBaction\fR column is specified, then matching packets will have DSCP marking applied\[char46] If the \fBbandwdith\fR column is specified, then matching packets will have metering applied\[char46] \fBaction\fR and \fBbandwdith\fR are not exclusive, so both marking and metering by defined for the same QoS entry\[char46] If no row matches, packets will not have any QoS applied\[char46] .SS "Summary: .TQ 3.00in \fBpriority\fR integer, in range 0 to 32,767 .TQ 3.00in \fBdirection\fR string, either \fBfrom\-lport\fR or \fBto\-lport\fR .TQ 3.00in \fBmatch\fR string .TQ 3.00in \fBaction\fR map of string-integer pairs, key must be \fBdscp\fR, value in range 0 to 63 .TQ 3.00in \fBbandwidth\fR map of string-integer pairs, key either \fBburst\fR or \fBrate\fR, value in range 1 to 4,294,967,295 .TQ 3.00in \fBexternal_ids\fR map of string-string pairs .SS "Details: .IP "\fBpriority\fR: integer, in range 0 to 32,767" The QoS rule\(cqs priority\[char46] Rules with numerically higher priority take precedence over those with lower\[char46] If two QoS rules with the same priority both match, then the one actually applied to a packet is undefined\[char46] .IP "\fBdirection\fR: string, either \fBfrom\-lport\fR or \fBto\-lport\fR" The value of this field is similar to \fBACL\fR column in the OVN Northbound database\(cqs \fBACL\fR table\[char46] .IP "\fBmatch\fR: string" The packets that the QoS rules should match, in the same expression language used for the \fBmatch\fR column in the OVN Southbound database\(cqs \fBLogical_Flow\fR table\[char46] The \fBoutport\fR logical port is only available in the \fBto\-lport\fR direction (the \fBinport\fR is available in both directions)\[char46] .IP "\fBaction\fR: map of string-integer pairs, key must be \fBdscp\fR, value in range 0 to 63" When specified, matching flows will have DSCP marking applied\[char46] .RS .IP \(bu \fBdscp\fR: The value of this action should be in the range of 0 to 63 (inclusive)\[char46] .RE .IP "\fBbandwidth\fR: map of string-integer pairs, key either \fBburst\fR or \fBrate\fR, value in range 1 to 4,294,967,295" When specified, matching packets will have bandwidth metering applied\[char46] Traffic over the limit will be dropped\[char46] .RS .IP \(bu \fBrate\fR: The value of rate limit in kbps\[char46] .IP \(bu \fBburst\fR: The value of burst rate limit in kilobits\[char46] This is optional and needs to specify the \fBrate\fR\[char46] .RE .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Meter TABLE" .PP .PP .PP Each row in this table represents a meter that can be used for QoS or rate-limiting\[char46] .SS "Summary: .TQ 3.00in \fBname\fR string (must be unique within table) .TQ 3.00in \fBunit\fR string, either \fBkbps\fR or \fBpktps\fR .TQ 3.00in \fBbands\fR set of 1 or more \fBMeter_Band\fRs .TQ 3.00in \fBexternal_ids\fR map of string-string pairs .SS "Details: .IP "\fBname\fR: string (must be unique within table)" A name for this meter\[char46] .IP Names that begin with \(dq__\(dq (two underscores) are reserved for OVN internal use and should not be added manually\[char46] .IP "\fBunit\fR: string, either \fBkbps\fR or \fBpktps\fR" The unit for \fBrate\fR and \fBburst_rate\fR parameters in the \fBbands\fR entry\[char46] \fBkbps\fR specifies kilobits per second, and \fBpktps\fR specifies packets per second\[char46] .IP "\fBbands\fR: set of 1 or more \fBMeter_Band\fRs" The bands associated with this meter\[char46] Each band specifies a rate above which the band is to take the action \fBaction\fR\[char46] If multiple bands\(cq rates are exceeded, then the band with the highest rate among the exceeded bands is selected\[char46] .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Meter_Band TABLE" .PP .PP .PP Each row in this table represents a meter band which specifies the rate above which the configured action should be applied\[char46] These bands are referenced by the \fBbands\fR column in the \fBMeter\fR table\[char46] .SS "Summary: .TQ 3.00in \fBaction\fR string, must be \fBdrop\fR .TQ 3.00in \fBrate\fR integer, in range 1 to 4,294,967,295 .TQ 3.00in \fBburst_size\fR integer, in range 0 to 4,294,967,295 .TQ 3.00in \fBexternal_ids\fR map of string-string pairs .SS "Details: .IP "\fBaction\fR: string, must be \fBdrop\fR" The action to execute when this band matches\[char46] The only supported action is \fBdrop\fR\[char46] .IP "\fBrate\fR: integer, in range 1 to 4,294,967,295" The rate limit for this band, in kilobits per second or bits per second, depending on whether the parent \fBMeter\fR entry\(cqs \fBunit\fR column specified \fBkbps\fR or \fBpktps\fR\[char46] .IP "\fBburst_size\fR: integer, in range 0 to 4,294,967,295" The maximum burst allowed for the band in kilobits or packets, depending on whether \fBkbps\fR or \fBpktps\fR was selected in the parent \fBMeter\fR entry\(cqs \fBunit\fR column\[char46] If the size is zero, the switch is free to select some reasonable value depending on its configuration\[char46] .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Logical_Router_Port TABLE" .PP .PP .PP A port within an L3 logical router\[char46] .PP .PP Exactly one \fBLogical_Router\fR row must reference a given logical router port\[char46] .SS "Summary: .TQ 3.00in \fBname\fR string (must be unique within table) .TQ 3.00in \fBgateway_chassis\fR set of \fBGateway_Chassis\fRs .TQ 3.00in \fBnetworks\fR set of 1 or more strings .TQ 3.00in \fBmac\fR string .TQ 3.00in \fBenabled\fR optional boolean .TQ .25in \fIipv6_ra_configs:\fR .RS .25in .TQ 2.75in \fBipv6_ra_configs : address_mode\fR optional string .TQ 2.75in \fBipv6_ra_configs : mtu\fR optional string .TQ 2.75in \fBipv6_ra_configs : send_periodic\fR optional string .TQ 2.75in \fBipv6_ra_configs : max_interval\fR optional string .TQ 2.75in \fBipv6_ra_configs : min_interval\fR optional string .RE .TQ .25in \fIOptions:\fR .RS .25in .TQ 2.75in \fBoptions : redirect-chassis\fR optional string .RE .TQ .25in \fIAttachment:\fR .RS .25in .TQ 2.75in \fBpeer\fR optional string .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBname\fR: string (must be unique within table)" A name for the logical router port\[char46] .IP In addition to provide convenience for human interaction with the northbound database, this column is used as reference by its patch port in \fBLogical_Switch_Port\fR or another logical router port in \fBLogical_Router_Port\fR\[char46] .IP "\fBgateway_chassis\fR: set of \fBGateway_Chassis\fRs" If set, this indicates that this logical router port represents a distributed gateway port that connects this router to a logical switch with a localnet port\[char46] There may be at most one such logical router port on each logical router\[char46] .IP Several \fBGateway_Chassis\fR can be referenced for a given logical router port\[char46] A single \fBGateway_Chassis\fR is functionally equivalent to setting \fBoptions:redirect-chassis\fR\[char46] Refer to the description of \fBoptions:redirect-chassis\fR for additional details on gateway handling\[char46] .IP Defining more than one \fBGateway_Chassis\fR will enable gateway high availability\[char46] Only one gateway will be active at a time\[char46] OVN chassis will use BFD to monitor connectivity to a gateway\[char46] If connectivity to the active gateway is interrupted, another gateway will become active\[char46] The \fBpriority\fR column specifies the order that gateways will be chosen by OVN\[char46] .IP "\fBnetworks\fR: set of 1 or more strings" The IP addresses and netmasks of the router\[char46] For example, \fB192\[char46]168\[char46]0\[char46]1/24\fR indicates that the router\(cqs IP address is 192\[char46]168\[char46]0\[char46]1 and that packets destined to 192\[char46]168\[char46]0\[char46]\fIx\fR should be routed to this port\[char46] .IP A logical router port always adds a link-local IPv6 address (fe80::/64) automatically generated from the interface\(cqs MAC address using the modified EUI\-64 format\[char46] .IP "\fBmac\fR: string" The Ethernet address that belongs to this router port\[char46] .IP "\fBenabled\fR: optional boolean" This column is used to administratively set port state\[char46] If this column is empty or is set to \fBtrue\fR, the port is enabled\[char46] If this column is set to \fBfalse\fR, the port is disabled\[char46] A disabled port has all ingress and egress traffic dropped\[char46] .ST "ipv6_ra_configs:" .PP .PP .PP This column defines the IPv6 ND RA address mode and ND MTU Option to be included by \fBovn\-controller\fR when it replies to the IPv6 Router solicitation requests\[char46] .IP "\fBipv6_ra_configs : address_mode\fR: optional string" The address mode to be used for IPv6 address configuration\[char46] The supported values are: .RS .IP \(bu \fBslaac\fR: Address configuration using Router Advertisement (RA) packet\[char46] The IPv6 prefixes defined in the \fBLogical_Router_Port\fR table\(cqs \fBnetworks\fR column will be included in the RA\(cqs ICMPv6 option - Prefix information\[char46] .IP \(bu \fBdhcpv6_stateful\fR: Address configuration using DHCPv6\[char46] .IP \(bu \fBdhcpv6_stateless\fR: Address configuration using Router Advertisement (RA) packet\[char46] Other IPv6 options are provided by DHCPv6\[char46] .RE .IP "\fBipv6_ra_configs : mtu\fR: optional string" The recommended MTU for the link\[char46] Default is 0, which means no MTU Option will be included in RA packet replied by ovn-controller\[char46] Per RFC 2460, the mtu value is recommended no less than 1280, so any mtu value less than 1280 will be considered as no MTU Option\[char46] .IP "\fBipv6_ra_configs : send_periodic\fR: optional string" If set to true, then this router interface will send router advertisements periodically\[char46] The default is false\[char46] .IP "\fBipv6_ra_configs : max_interval\fR: optional string" The maximum number of seconds to wait between sending periodic router advertisements\[char46] This option has no effect if \fBipv6_ra_configs:send_periodic\fR is false\[char46] The default is 600\[char46] .IP "\fBipv6_ra_configs : min_interval\fR: optional string" The minimum number of seconds to wait between sending periodic router advertisements\[char46] This option has no effect if \fBipv6_ra_configs:send_periodic\fR is false\[char46] The default is one-third of \fBipv6_ra_configs:max_interval\fR, i\[char46]e\[char46] 200 seconds if that key is unset\[char46] .ST "Options:" .PP .PP .PP Additional options for the logical router port\[char46] .IP "\fBoptions : redirect-chassis\fR: optional string" If set, this indicates that this logical router port represents a distributed gateway port that connects this router to a logical switch with a localnet port\[char46] There may be at most one such logical router port on each logical router\[char46] .IP Even when a \fBredirect\-chassis\fR is specified, the logical router port still effectively resides on each chassis\[char46] However, due to the implications of the use of L2 learning in the physical network, as well as the need to support advanced features such as one-to-many NAT (aka IP masquerading), a subset of the logical router processing is handled in a centralized manner on the specified \fBredirect\-chassis\fR\[char46] .IP When this option is specified, the peer logical switch port\(cqs \fBaddresses\fR must be set to \fBrouter\fR\[char46] With this setting, the \fBexternal_mac\fRs specified in NAT rules are automatically programmed in the peer logical switch\(cqs destination lookup on the chassis where the \fBlogical_port\fR resides\[char46] In addition, the logical router\(cqs MAC address is automatically programmed in the peer logical switch\(cqs destination lookup flow on the \fBredirect\-chassis\fR\[char46] .IP When this option is specified and it is desired to generate gratuitous ARPs for NAT addresses, then the peer logical switch port\(cqs \fBoptions:nat-addresses\fR should be set to \fBrouter\fR\[char46] .IP While \fBoptions:redirect-chassis\fR is still supported for backwards compatibility, it is now preferred to specify one or more \fBgateway_chassis\fR instead\[char46] It is functionally equivalent, but allows you to specify multiple chassis to enable high availability\[char46] .ST "Attachment:" .PP .PP .PP A given router port serves one of two purposes: .RS .IP \(bu To attach a logical switch to a logical router\[char46] A logical router port of this type is referenced by exactly one \fBLogical_Switch_Port\fR of type \fBrouter\fR\[char46] The value of \fBname\fR is set as \fBrouter\-port\fR in column \fBoptions\fR of \fBLogical_Switch_Port\fR\[char46] In this case \fBpeer\fR column is empty\[char46] .IP \(bu To connect one logical router to another\[char46] This requires a pair of logical router ports, each connected to a different router\[char46] Each router port in the pair specifies the other in its \fBpeer\fR column\[char46] No \fBLogical_Switch\fR refers to the router port\[char46] .RE .IP "\fBpeer\fR: optional string" For a router port used to connect two logical routers, this identifies the other router port in the pair by \fBname\fR\[char46] .IP For a router port attached to a logical switch, this column is empty\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Logical_Router_Static_Route TABLE" .PP .PP .PP Each record represents a static route\[char46] .PP .PP When multiple routes match a packet, the longest-prefix match is chosen\[char46] For a given prefix length, a \fBdst\-ip\fR route is preferred over a \fBsrc\-ip\fR route\[char46] .SS "Summary: .TQ 3.00in \fBip_prefix\fR string .TQ 3.00in \fBpolicy\fR optional string, either \fBdst\-ip\fR or \fBsrc\-ip\fR .TQ 3.00in \fBnexthop\fR string .TQ 3.00in \fBoutput_port\fR optional string .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBip_prefix\fR: string" IP prefix of this route (e\[char46]g\[char46] 192\[char46]168\[char46]100\[char46]0/24)\[char46] .IP "\fBpolicy\fR: optional string, either \fBdst\-ip\fR or \fBsrc\-ip\fR" If it is specified, this setting describes the policy used to make routing decisions\[char46] This setting must be one of the following strings: .RS .IP \(bu \fBsrc\-ip\fR: This policy sends the packet to the \fBnexthop\fR when the packet\(cqs source IP address matches \fBip_prefix\fR\[char46] .IP \(bu \fBdst\-ip\fR: This policy sends the packet to the \fBnexthop\fR when the packet\(cqs destination IP address matches \fBip_prefix\fR\[char46] .RE .IP If not specified, the default is \fBdst\-ip\fR\[char46] .IP "\fBnexthop\fR: string" Nexthop IP address for this route\[char46] Nexthop IP address should be the IP address of a connected router port or the IP address of a logical port\[char46] .IP "\fBoutput_port\fR: optional string" The name of the \fBLogical_Router_Port\fR via which the packet needs to be sent out\[char46] This is optional and when not specified, OVN will automatically figure this out based on the \fBnexthop\fR\[char46] When this is specified and there are multiple IP addresses on the router port and none of them are in the same subnet of \fBnexthop\fR, OVN chooses the first IP address as the one via which the \fBnexthop\fR is reachable\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "NAT TABLE" .PP .PP .PP Each record represents a NAT rule\[char46] .SS "Summary: .TQ 3.00in \fBtype\fR string, one of \fBdnat\fR, \fBdnat_and_snat\fR, or \fBsnat\fR .TQ 3.00in \fBexternal_ip\fR string .TQ 3.00in \fBexternal_mac\fR optional string .TQ 3.00in \fBlogical_ip\fR string .TQ 3.00in \fBlogical_port\fR optional string .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBtype\fR: string, one of \fBdnat\fR, \fBdnat_and_snat\fR, or \fBsnat\fR" Type of the NAT rule\[char46] .RS .IP \(bu When \fBtype\fR is \fBdnat\fR, the externally visible IP address \fBexternal_ip\fR is DNATted to the IP address \fBlogical_ip\fR in the logical space\[char46] .IP \(bu When \fBtype\fR is \fBsnat\fR, IP packets with their source IP address that either matches the IP address in \fBlogical_ip\fR or is in the network provided by \fBlogical_ip\fR is SNATed into the IP address in \fBexternal_ip\fR\[char46] .IP \(bu When \fBtype\fR is \fBdnat_and_snat\fR, the externally visible IP address \fBexternal_ip\fR is DNATted to the IP address \fBlogical_ip\fR in the logical space\[char46] In addition, IP packets with the source IP address that matches \fBlogical_ip\fR is SNATed into the IP address in \fBexternal_ip\fR\[char46] .RE .IP "\fBexternal_ip\fR: string" An IPv4 address\[char46] .IP "\fBexternal_mac\fR: optional string" A MAC address\[char46] .IP This is only used on the gateway port on distributed routers\[char46] This must be specified in order for the NAT rule to be processed in a distributed manner on all chassis\[char46] If this is not specified for a NAT rule on a distributed router, then this NAT rule will be processed in a centralized manner on the gateway port instance on the \fBredirect\-chassis\fR\[char46] .IP This MAC address must be unique on the logical switch that the gateway port is attached to\[char46] If the MAC address used on the \fBlogical_port\fR is globally unique, then that MAC address can be specified as this \fBexternal_mac\fR\[char46] .IP "\fBlogical_ip\fR: string" An IPv4 network (e\[char46]g 192\[char46]168\[char46]1\[char46]0/24) or an IPv4 address\[char46] .IP "\fBlogical_port\fR: optional string" The name of the logical port where the \fBlogical_ip\fR resides\[char46] .IP This is only used on distributed routers\[char46] This must be specified in order for the NAT rule to be processed in a distributed manner on all chassis\[char46] If this is not specified for a NAT rule on a distributed router, then this NAT rule will be processed in a centralized manner on the gateway port instance on the \fBredirect\-chassis\fR\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "DHCP_Options TABLE" .PP .PP .PP OVN implements native DHCPv4 support which caters to the common use case of providing an IPv4 address to a booting instance by providing stateless replies to DHCPv4 requests based on statically configured address mappings\[char46] To do this it allows a short list of DHCPv4 options to be configured and applied at each compute host running \fBovn\-controller\fR\[char46] .PP .PP OVN also implements native DHCPv6 support which provides stateless replies to DHCPv6 requests\[char46] .SS "Summary: .TQ 3.00in \fBcidr\fR string .TQ .25in \fIDHCPv4 options:\fR .RS .25in .TQ .25in \fIMandatory DHCPv4 options:\fR .RS .25in .TQ 2.50in \fBoptions : server_id\fR optional string .TQ 2.50in \fBoptions : server_mac\fR optional string .TQ 2.50in \fBoptions : lease_time\fR optional string, containing an integer, in range 0 to 4,294,967,295 .RE .TQ .25in \fIIPv4 DHCP Options:\fR .RS .25in .TQ 2.50in \fBoptions : router\fR optional string .TQ 2.50in \fBoptions : netmask\fR optional string .TQ 2.50in \fBoptions : dns_server\fR optional string .TQ 2.50in \fBoptions : log_server\fR optional string .TQ 2.50in \fBoptions : lpr_server\fR optional string .TQ 2.50in \fBoptions : swap_server\fR optional string .TQ 2.50in \fBoptions : policy_filter\fR optional string .TQ 2.50in \fBoptions : router_solicitation\fR optional string .TQ 2.50in \fBoptions : nis_server\fR optional string .TQ 2.50in \fBoptions : ntp_server\fR optional string .TQ 2.50in \fBoptions : tftp_server\fR optional string .TQ 2.50in \fBoptions : classless_static_route\fR optional string .TQ 2.50in \fBoptions : ms_classless_static_route\fR optional string .RE .TQ .25in \fIBoolean DHCP Options:\fR .RS .25in .TQ 2.50in \fBoptions : ip_forward_enable\fR optional string, either \fB0\fR or \fB1\fR .TQ 2.50in \fBoptions : router_discovery\fR optional string, either \fB0\fR or \fB1\fR .TQ 2.50in \fBoptions : ethernet_encap\fR optional string, either \fB0\fR or \fB1\fR .RE .TQ .25in \fIInteger DHCP Options:\fR .RS .25in .TQ 2.50in \fBoptions : default_ttl\fR optional string, containing an integer, in range 0 to 255 .TQ 2.50in \fBoptions : tcp_ttl\fR optional string, containing an integer, in range 0 to 255 .TQ 2.50in \fBoptions : mtu\fR optional string, containing an integer, in range 68 to 65,535 .TQ 2.50in \fBoptions : T1\fR optional string, containing an integer, in range 68 to 4,294,967,295 .TQ 2.50in \fBoptions : T2\fR optional string, containing an integer, in range 68 to 4,294,967,295 .RE .RE .TQ .25in \fIDHCPv6 options:\fR .RS .25in .TQ .25in \fIMandatory DHCPv6 options:\fR .RS .25in .TQ 2.50in \fBoptions : server_id\fR optional string .RE .TQ .25in \fIIPv6 DHCPv6 options:\fR .RS .25in .TQ 2.50in \fBoptions : dns_server\fR optional string .RE .TQ .25in \fIString DHCPv6 options:\fR .RS .25in .TQ 2.50in \fBoptions : domain_search\fR optional string .TQ 2.50in \fBoptions : dhcpv6_stateless\fR optional string .RE .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBcidr\fR: string" The DHCPv4/DHCPv6 options will be included if the logical port has its IP address in this \fBcidr\fR\[char46] .ST "DHCPv4 options:" .PP .PP .PP The CMS should define the set of DHCPv4 options as key/value pairs in the \fBoptions\fR column of this table\[char46] For \fBovn\-controller\fR to include these DHCPv4 options, the \fBdhcpv4_options\fR of \fBLogical_Switch_Port\fR should refer to an entry in this table\[char46] .ST "Mandatory DHCPv4 options:" .PP .PP .PP The following options must be defined\[char46] .IP "\fBoptions : server_id\fR: optional string" The IP address for the DHCP server to use\[char46] This should be in the subnet of the offered IP\[char46] This is also included in the DHCP offer as option 54, ``server identifier\[char46]\(cq\(cq .IP "\fBoptions : server_mac\fR: optional string" The Ethernet address for the DHCP server to use\[char46] .IP "\fBoptions : lease_time\fR: optional string, containing an integer, in range 0 to 4,294,967,295" The offered lease time in seconds, .IP The DHCPv4 option code for this option is 51\[char46] .ST "IPv4 DHCP Options:" .PP .PP .PP Below are the supported DHCPv4 options whose values are an IPv4 address, e\[char46]g\[char46] \fB192\[char46]168\[char46]1\[char46]1\fR\[char46] Some options accept multiple IPv4 addresses enclosed within curly braces, e\[char46]g\[char46] \fB{192\[char46]168\[char46]1\[char46]2, 192\[char46]168\[char46]1\[char46]3}\fR\[char46] Please refer to RFC 2132 for more details on DHCPv4 options and their codes\[char46] .IP "\fBoptions : router\fR: optional string" The IP address of a gateway for the client to use\[char46] This should be in the subnet of the offered IP\[char46] The DHCPv4 option code for this option is 3\[char46] .IP "\fBoptions : netmask\fR: optional string" The DHCPv4 option code for this option is 1\[char46] .IP "\fBoptions : dns_server\fR: optional string" The DHCPv4 option code for this option is 6\[char46] .IP "\fBoptions : log_server\fR: optional string" The DHCPv4 option code for this option is 7\[char46] .IP "\fBoptions : lpr_server\fR: optional string" The DHCPv4 option code for this option is 9\[char46] .IP "\fBoptions : swap_server\fR: optional string" The DHCPv4 option code for this option is 16\[char46] .IP "\fBoptions : policy_filter\fR: optional string" The DHCPv4 option code for this option is 21\[char46] .IP "\fBoptions : router_solicitation\fR: optional string" The DHCPv4 option code for this option is 32\[char46] .IP "\fBoptions : nis_server\fR: optional string" The DHCPv4 option code for this option is 41\[char46] .IP "\fBoptions : ntp_server\fR: optional string" The DHCPv4 option code for this option is 42\[char46] .IP "\fBoptions : tftp_server\fR: optional string" The DHCPv4 option code for this option is 66\[char46] .IP "\fBoptions : classless_static_route\fR: optional string" The DHCPv4 option code for this option is 121\[char46] .IP This option can contain one or more static routes, each of which consists of a destination descriptor and the IP address of the router that should be used to reach that destination\[char46] Please see RFC 3442 for more details\[char46] .IP Example: \fB{30\[char46]0\[char46]0\[char46]0/24,10\[char46]0\[char46]0\[char46]10, 0\[char46]0\[char46]0\[char46]0/0,10\[char46]0\[char46]0\[char46]1}\fR .IP "\fBoptions : ms_classless_static_route\fR: optional string" The DHCPv4 option code for this option is 249\[char46] This option is similar to \fBclassless_static_route\fR supported by Microsoft Windows DHCPv4 clients\[char46] .ST "Boolean DHCP Options:" .PP .PP .PP These options accept a Boolean value, expressed as \fB0\fR for false or \fB1\fR for true\[char46] .IP "\fBoptions : ip_forward_enable\fR: optional string, either \fB0\fR or \fB1\fR" The DHCPv4 option code for this option is 19\[char46] .IP "\fBoptions : router_discovery\fR: optional string, either \fB0\fR or \fB1\fR" The DHCPv4 option code for this option is 31\[char46] .IP "\fBoptions : ethernet_encap\fR: optional string, either \fB0\fR or \fB1\fR" The DHCPv4 option code for this option is 36\[char46] .ST "Integer DHCP Options:" .PP .PP .PP These options accept a nonnegative integer value\[char46] .IP "\fBoptions : default_ttl\fR: optional string, containing an integer, in range 0 to 255" The DHCPv4 option code for this option is 23\[char46] .IP "\fBoptions : tcp_ttl\fR: optional string, containing an integer, in range 0 to 255" The DHCPv4 option code for this option is 37\[char46] .IP "\fBoptions : mtu\fR: optional string, containing an integer, in range 68 to 65,535" The DHCPv4 option code for this option is 26\[char46] .IP "\fBoptions : T1\fR: optional string, containing an integer, in range 68 to 4,294,967,295" This specifies the time interval from address assignment until the client begins trying to renew its address\[char46] The DHCPv4 option code for this option is 58\[char46] .IP "\fBoptions : T2\fR: optional string, containing an integer, in range 68 to 4,294,967,295" This specifies the time interval from address assignment until the client begins trying to rebind its address\[char46] The DHCPv4 option code for this option is 59\[char46] .ST "DHCPv6 options:" .PP .PP .PP OVN also implements native DHCPv6 support\[char46] The CMS should define the set of DHCPv6 options as key/value pairs\[char46] The define DHCPv6 options will be included in the DHCPv6 response to the DHCPv6 Solicit/Request/Confirm packet from the logical ports having the IPv6 addresses in the \fBcidr\fR\[char46] .ST "Mandatory DHCPv6 options:" .PP .PP .PP The following options must be defined\[char46] .IP "\fBoptions : server_id\fR: optional string" The Ethernet address for the DHCP server to use\[char46] This is also included in the DHCPv6 reply as option 2, ``Server Identifier\(cq\(cq to carry a DUID identifying a server between a client and a server\[char46] \fBovn\-controller\fR defines DUID based on Link-layer Address [DUID-LL]\[char46] .ST "IPv6 DHCPv6 options:" .PP .PP .PP Below are the supported DHCPv6 options whose values are an IPv6 address, e\[char46]g\[char46] \fBaef0::4\fR\[char46] Some options accept multiple IPv6 addresses enclosed within curly braces, e\[char46]g\[char46] \fB{aef0::4, aef0::5}\fR\[char46] Please refer to RFC 3315 for more details on DHCPv6 options and their codes\[char46] .IP "\fBoptions : dns_server\fR: optional string" The DHCPv6 option code for this option is 23\[char46] This option specifies the DNS servers that the VM should use\[char46] .ST "String DHCPv6 options:" .PP .PP .PP These options accept string values\[char46] .IP "\fBoptions : domain_search\fR: optional string" The DHCPv6 option code for this option is 24\[char46] This option specifies the domain search list the client should use to resolve hostnames with DNS\[char46] .IP Example: \fB\(dqovn\[char46]org\(dq\fR\[char46] .IP "\fBoptions : dhcpv6_stateless\fR: optional string" This option specifies the OVN native DHCPv6 will work in stateless mode, which means OVN native DHCPv6 will not offer IPv6 addresses for VM/VIF ports, but only reply other configurations, such as DNS and domain search list\[char46] When setting this option with string value \(dqtrue\(dq, VM/VIF will configure IPv6 addresses by stateless way\[char46] Default value for this option is false\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "Connection TABLE" .PP .PP .PP Configuration for a database connection to an Open vSwitch database (OVSDB) client\[char46] .PP .PP This table primarily configures the Open vSwitch database server (\fBovsdb\-server\fR)\[char46] .PP .PP The Open vSwitch database server can initiate and maintain active connections to remote clients\[char46] It can also listen for database connections\[char46] .SS "Summary: .TQ .25in \fICore Features:\fR .RS .25in .TQ 2.75in \fBtarget\fR string (must be unique within table) .RE .TQ .25in \fIClient Failure Detection and Handling:\fR .RS .25in .TQ 2.75in \fBmax_backoff\fR optional integer, at least 1,000 .TQ 2.75in \fBinactivity_probe\fR optional integer .RE .TQ .25in \fIStatus:\fR .RS .25in .TQ 2.75in \fBis_connected\fR boolean .TQ 2.75in \fBstatus : last_error\fR optional string .TQ 2.75in \fBstatus : state\fR optional string, one of \fBACTIVE\fR, \fBBACKOFF\fR, \fBCONNECTING\fR, \fBIDLE\fR, or \fBVOID\fR .TQ 2.75in \fBstatus : sec_since_connect\fR optional string, containing an integer, at least 0 .TQ 2.75in \fBstatus : sec_since_disconnect\fR optional string, containing an integer, at least 0 .TQ 2.75in \fBstatus : locks_held\fR optional string .TQ 2.75in \fBstatus : locks_waiting\fR optional string .TQ 2.75in \fBstatus : locks_lost\fR optional string .TQ 2.75in \fBstatus : n_connections\fR optional string, containing an integer, at least 2 .TQ 2.75in \fBstatus : bound_port\fR optional string, containing an integer .RE .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .TQ 2.75in \fBother_config\fR map of string-string pairs .RE .SS "Details: .ST "Core Features:" .PP .IP "\fBtarget\fR: string (must be unique within table)" Connection methods for clients\[char46] .IP The following connection methods are currently supported: .RS .TP \fBssl:\fIhost\fB\fR[\fB:\fIport\fB\fR] The specified SSL \fIport\fR on the host at the given \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address\[char46] A valid SSL configuration must be provided when this form is used, this configuration can be specified via command-line options or the \fBSSL\fR table\[char46] .IP If \fIport\fR is not specified, it defaults to 6640\[char46] .IP SSL support is an optional feature that is not always built as part of Open vSwitch\[char46] .TP \fBtcp:\fIhost\fB\fR[\fB:\fIport\fB\fR] The specified TCP \fIport\fR on the host at the given \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address\[char46] If \fIhost\fR is an IPv6 address, wrap it in square brackets, e\[char46]g\[char46] \fBtcp:[::1]:6640\fR\[char46] .IP If \fIport\fR is not specified, it defaults to 6640\[char46] .TP \fBpssl:\fR[\fIport\fR][\fB:\fIhost\fB\fR] Listens for SSL connections on the specified TCP \fIport\fR\[char46] Specify 0 for \fIport\fR to have the kernel automatically choose an available port\[char46] If \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address, is specified, then connections are restricted to the resolved or specified local IPaddress (either IPv4 or IPv6 address)\[char46] If \fIhost\fR is an IPv6 address, wrap in square brackets, e\[char46]g\[char46] \fBpssl:6640:[::1]\fR\[char46] If \fIhost\fR is not specified then it listens only on IPv4 (but not IPv6) addresses\[char46] A valid SSL configuration must be provided when this form is used, this can be specified either via command-line options or the \fBSSL\fR table\[char46] .IP If \fIport\fR is not specified, it defaults to 6640\[char46] .IP SSL support is an optional feature that is not always built as part of Open vSwitch\[char46] .TP \fBptcp:\fR[\fIport\fR][\fB:\fIhost\fB\fR] Listens for connections on the specified TCP \fIport\fR\[char46] Specify 0 for \fIport\fR to have the kernel automatically choose an available port\[char46] If \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address, is specified, then connections are restricted to the resolved or specified local IP address (either IPv4 or IPv6 address)\[char46] If \fIhost\fR is an IPv6 address, wrap it in square brackets, e\[char46]g\[char46] \fBptcp:6640:[::1]\fR\[char46] If \fIhost\fR is not specified then it listens only on IPv4 addresses\[char46] .IP If \fIport\fR is not specified, it defaults to 6640\[char46] .RE .IP When multiple clients are configured, the \fBtarget\fR values must be unique\[char46] Duplicate \fBtarget\fR values yield unspecified results\[char46] .ST "Client Failure Detection and Handling:" .PP .IP "\fBmax_backoff\fR: optional integer, at least 1,000" Maximum number of milliseconds to wait between connection attempts\[char46] Default is implementation-specific\[char46] .IP "\fBinactivity_probe\fR: optional integer" Maximum number of milliseconds of idle time on connection to the client before sending an inactivity probe message\[char46] If Open vSwitch does not communicate with the client for the specified number of seconds, it will send a probe\[char46] If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect\[char46] Default is implementation-specific\[char46] A value of 0 disables inactivity probes\[char46] .ST "Status:" .PP .PP .PP Key-value pair of \fBis_connected\fR is always updated\[char46] Other key-value pairs in the status columns may be updated depends on the \fBtarget\fR type\[char46] .PP .PP When \fBtarget\fR specifies a connection method that listens for inbound connections (e\[char46]g\[char46] \fBptcp:\fR or \fBpunix:\fR), both \fBn_connections\fR and \fBis_connected\fR may also be updated while the remaining key-value pairs are omitted\[char46] .PP .PP On the other hand, when \fBtarget\fR specifies an outbound connection, all key-value pairs may be updated, except the above-mentioned two key-value pairs associated with inbound connection targets\[char46] They are omitted\[char46] .IP "\fBis_connected\fR: boolean" \fBtrue\fR if currently connected to this client, \fBfalse\fR otherwise\[char46] .IP "\fBstatus : last_error\fR: optional string" A human-readable description of the last error on the connection to the manager; i\[char46]e\[char46] \fBstrerror(errno)\fR\[char46] This key will exist only if an error has occurred\[char46] .IP "\fBstatus : state\fR: optional string, one of \fBACTIVE\fR, \fBBACKOFF\fR, \fBCONNECTING\fR, \fBIDLE\fR, or \fBVOID\fR" The state of the connection to the manager: .RS .TP \fBVOID\fR Connection is disabled\[char46] .TP \fBBACKOFF\fR Attempting to reconnect at an increasing period\[char46] .TP \fBCONNECTING\fR Attempting to connect\[char46] .TP \fBACTIVE\fR Connected, remote host responsive\[char46] .TP \fBIDLE\fR Connection is idle\[char46] Waiting for response to keep-alive\[char46] .RE .IP These values may change in the future\[char46] They are provided only for human consumption\[char46] .IP "\fBstatus : sec_since_connect\fR: optional string, containing an integer, at least 0" The amount of time since this client last successfully connected to the database (in seconds)\[char46] Value is empty if client has never successfully been connected\[char46] .IP "\fBstatus : sec_since_disconnect\fR: optional string, containing an integer, at least 0" The amount of time since this client last disconnected from the database (in seconds)\[char46] Value is empty if client has never disconnected\[char46] .IP "\fBstatus : locks_held\fR: optional string" Space-separated list of the names of OVSDB locks that the connection holds\[char46] Omitted if the connection does not hold any locks\[char46] .IP "\fBstatus : locks_waiting\fR: optional string" Space-separated list of the names of OVSDB locks that the connection is currently waiting to acquire\[char46] Omitted if the connection is not waiting for any locks\[char46] .IP "\fBstatus : locks_lost\fR: optional string" Space-separated list of the names of OVSDB locks that the connection has had stolen by another OVSDB client\[char46] Omitted if no locks have been stolen from this connection\[char46] .IP "\fBstatus : n_connections\fR: optional string, containing an integer, at least 2" When \fBtarget\fR specifies a connection method that listens for inbound connections (e\[char46]g\[char46] \fBptcp:\fR or \fBpssl:\fR) and more than one connection is actually active, the value is the number of active connections\[char46] Otherwise, this key-value pair is omitted\[char46] .IP "\fBstatus : bound_port\fR: optional string, containing an integer" When \fBtarget\fR is \fBptcp:\fR or \fBpssl:\fR, this is the TCP port on which the OVSDB server is listening\[char46] (This is particularly useful when \fBtarget\fR specifies a port of 0, allowing the kernel to choose any available port\[char46]) .ST "Common Columns:" .PP The overall purpose of these columns is described under \fBCommon Columns\fR at the beginning of this document\[char46] .IP "\fBexternal_ids\fR: map of string-string pairs" .IP "\fBother_config\fR: map of string-string pairs" .bp .SH "DNS TABLE" .PP .PP .PP Each row in this table stores the DNS records\[char46] The \fBLogical_Switch\fR table\(cqs \fBdns_records\fR references these records\[char46] .SS "Summary: .TQ 3.00in \fBrecords\fR map of string-string pairs .TQ 3.00in \fBexternal_ids\fR map of string-string pairs .SS "Details: .IP "\fBrecords\fR: map of string-string pairs" Key-value pair of DNS records with \fBDNS query name\fR as the key and value as a string of IP address(es) separated by comma or space\[char46] .IP \fBExample: \fR \(dqvm1\[char46]ovn\[char46]org\(dq = \(dq10\[char46]0\[char46]0\[char46]4 aef0::4\(dq .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46] .bp .SH "SSL TABLE" .PP SSL configuration for ovn-nb database access\[char46] .SS "Summary: .TQ 3.00in \fBprivate_key\fR string .TQ 3.00in \fBcertificate\fR string .TQ 3.00in \fBca_cert\fR string .TQ 3.00in \fBbootstrap_ca_cert\fR boolean .TQ 3.00in \fBssl_protocols\fR string .TQ 3.00in \fBssl_ciphers\fR string .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBprivate_key\fR: string" Name of a PEM file containing the private key used as the switch\(cqs identity for SSL connections to the controller\[char46] .IP "\fBcertificate\fR: string" Name of a PEM file containing a certificate, signed by the certificate authority (CA) used by the controller and manager, that certifies the switch\(cqs private key, identifying a trustworthy switch\[char46] .IP "\fBca_cert\fR: string" Name of a PEM file containing the CA certificate used to verify that the switch is connected to a trustworthy controller\[char46] .IP "\fBbootstrap_ca_cert\fR: boolean" If set to \fBtrue\fR, then Open vSwitch will attempt to obtain the CA certificate from the controller on its first SSL connection and save it to the named PEM file\[char46] If it is successful, it will immediately drop the connection and reconnect, and from then on all SSL connections must be authenticated by a certificate signed by the CA certificate thus obtained\[char46] \fBThis option exposes the SSL connection to a man\-in\-the\-middle attack obtaining the initial CA certificate\[char46]\fR It may still be useful for bootstrapping\[char46] .IP "\fBssl_protocols\fR: string" List of SSL protocols to be enabled for SSL connections\[char46] The default when this option is omitted is \fBTLSv1,TLSv1\[char46]1,TLSv1\[char46]2\fR\[char46] .IP "\fBssl_ciphers\fR: string" List of ciphers (in OpenSSL cipher string format) to be supported for SSL connections\[char46] The default when this option is omitted is \fBHIGH:!aNULL:!MD5\fR\[char46] .ST "Common Columns:" .PP The overall purpose of these columns is described under \fBCommon Columns\fR at the beginning of this document\[char46] .IP "\fBexternal_ids\fR: map of string-string pairs" .bp .SH "Gateway_Chassis TABLE" .PP .PP .PP Association of one or more chassis to a logical router port\[char46] The traffic going out through an specific router port will be redirected to a chassis, or a set of them in high availability configurations\[char46] A single \fBGateway_Chassis\fR is equivalent to setting \fBoptions:redirect-chassis\fR\[char46] Using \fBGateway_Chassis\fR allows associating multiple prioritized chassis with a single logical router port\[char46] .SS "Summary: .TQ 3.00in \fBname\fR string (must be unique within table) .TQ 3.00in \fBchassis_name\fR string .TQ 3.00in \fBpriority\fR integer, in range 0 to 32,767 .TQ 3.00in \fBoptions\fR map of string-string pairs .TQ .25in \fICommon Columns:\fR .RS .25in .TQ 2.75in \fBexternal_ids\fR map of string-string pairs .RE .SS "Details: .IP "\fBname\fR: string (must be unique within table)" Name of the \fBGateway_Chassis\fR\[char46] .IP A suggested, but not required naming convention is \fB${port_name}_${chassis_name}\fR\[char46] .IP "\fBchassis_name\fR: string" Name of the chassis that we want to redirect traffic through for the associated logical router port\[char46] The value must match the \fBname\fR column of the \fBChassis\fR table in the \fBOVN_Southbound\fR database\[char46] .IP "\fBpriority\fR: integer, in range 0 to 32,767" This is the priority of a chassis among all \fBGateway_Chassis\fR belonging to the same logical router port\[char46] .IP "\fBoptions\fR: map of string-string pairs" Reserved for future use\[char46] .ST "Common Columns:" .PP .IP "\fBexternal_ids\fR: map of string-string pairs" See \fBExternal IDs\fR at the beginning of this document\[char46]