Each row represents one L2 logical switch.
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). They work in the same way when providing
connectivity between logical ports on same chasis, but
differently when connecting remote logical ports. 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 localnet ports. Each bridged logical switch has one and
only one localnet port, which has only one special address
unknown.
Summary:
ports set of Logical_Switch_Ports
load_balancer set of weak reference to
Load_Balancers
acls set of ACLs
qos_rules set of QoSs
dns_records set of weak reference to DNSs
Naming:
name string
external_ids : neutron:network_name
optional string
IP Address Assignment:
other_config : subnet optional string
other_config : exclude_ips optional string
other_config : ipv6_prefix optional string
other_config : mac_only optional string, either true or
false
IP Multicast Snooping Options:
other_config : mcast_snoop optional string, either true or
false
other_config : mcast_querier
optional string, either true or
false
other_config : mcast_flood_unregistered
optional string, either true or
false
other_config : mcast_table_size
optional string, containing an
integer, in range 1 to 32,766
other_config : mcast_idle_timeout
optional string, containing an
integer, in range 15 to 3,600
other_config : mcast_query_interval
optional string, containing an
integer, in range 1 to 3,600
other_config : mcast_query_max_response
optional string, containing an
integer, in range 1 to 10
other_config : mcast_eth_src
optional string
other_config : mcast_ip4_src
optional string
Common Columns:
external_ids map of string-string pairs
Details:
ports: set of Logical_Switch_Ports
The logical ports connected to the logical switch.
It is an error for multiple logical switches to include
the same logical port.
load_balancer: set of weak reference to Load_Balancers
Load balance a virtual ip address to a set of logical port
endpoint ip addresses.
acls: set of ACLs
Access control rules that apply to packets within the
logical switch.
qos_rules: set of QoSs
QoS marking and metering rules that apply to packets
within the logical switch.
dns_records: set of weak reference to DNSs
This column defines the DNS records to be used for
resolving internal DNS queries within the logical switch
by the native DNS resolver. Please see the DNS table.
Naming:
These columns provide names for the logical switch. From OVN's
perspective, these names have no special meaning or purpose other
than to provide convenience for human interaction with the
database. There is no requirement for the name to be unique. (For
a unique identifier for a logical switch, use its row UUID.)
(Originally, name was intended to serve the purpose of a human-
friendly name, but the Neutron integration used it to uniquely
identify its own switch object, in the format neutron-uuid. Later
on, Neutron started propagating the friendly name of a switch as
external_ids:neutron:network_name. Perhaps this can be cleaned up
someday.)
name: string
A name for the logical switch.
external_ids : neutron:network_name: optional string
Another name for the logical switch.
IP Address Assignment:
These options control automatic IP address management (IPAM) for
ports attached to the logical switch. To enable IPAM for IPv4,
set other_config:subnet and optionally other_config:exclude_ips.
To enable IPAM for IPv6, set other_config:ipv6_prefix. IPv4 and
IPv6 may be enabled together or separately.
To request dynamic address assignment for a particular port, use
the dynamic keyword in the addresses column of the port's
Logical_Switch_Port row. This requests both an IPv4 and an IPv6
address, if IPAM for IPv4 and IPv6 are both enabled.
other_config : subnet: optional string
Set this to an IPv4 subnet, e.g. 192.168.0.0/24, to enable
ovn-northd to automatically assign IP addresses within
that subnet.
other_config : exclude_ips: optional string
To exclude some addresses from automatic IP address
management, set this to a list of the IPv4 addresses or
..-delimited ranges to exclude. The addresses or ranges
should be a subset of those in other_config:subnet.
Whether listed or not, ovn-northd will never allocate the
first or last address in a subnet, such as 192.168.0.0 or
192.168.0.255 in 192.168.0.0/24.
Examples:
• 192.168.0.2 192.168.0.10
• 192.168.0.4 192.168.0.30..192.168.0.60
192.168.0.110..192.168.0.120
• 192.168.0.110..192.168.0.120
192.168.0.25..192.168.0.30 192.168.0.144
other_config : ipv6_prefix: optional string
Set this to an IPv6 prefix to enable ovn-northd to
automatically assign IPv6 addresses using this prefix. The
assigned IPv6 address will be generated using the IPv6
prefix and the MAC address (converted to an IEEE EUI64
identifier) of the port. The IPv6 prefix defined here
should be a valid IPv6 address ending with ::.
Examples:
• aef0::
• bef0:1234:a890:5678::
• 8230:5678::
other_config : mac_only: optional string, either true or false
Value used to request to assign L2 address only if neither
subnet nor ipv6_prefix are specified
IP Multicast Snooping Options:
These options control IP Multicast Snooping configuration of the
logical switch. To enable IP Multicast Snooping set
other_config:mcast_snoop to true. To enable IP Multicast Querier
set other_config:mcast_snoop to true. If IP Multicast Querier is
enabled other_config:mcast_eth_src and other_config:mcast_ip4_src
must be set.
other_config : mcast_snoop: optional string, either true or false
Enables/disables IP Multicast Snooping on the logical
switch.
other_config : mcast_querier: optional string, either true or
false
Enables/disables IP Multicast Querier on the logical
switch.
other_config : mcast_flood_unregistered: optional string, either
true or false
Determines whether unregistered multicast traffic should
be flooded or not. Only applicable if
other_config:mcast_snoop is enabled.
other_config : mcast_table_size: optional string, containing an
integer, in range 1 to 32,766
Number of multicast groups to be stored. Default: 2048.
other_config : mcast_idle_timeout: optional string, containing an
integer, in range 15 to 3,600
Configures the IP Multicast Snooping group idle timeout
(in seconds). Default: 300 seconds.
other_config : mcast_query_interval: optional string, containing
an integer, in range 1 to 3,600
Configures the IP Multicast Querier interval between
queries (in seconds). Default:
other_config:mcast_idle_timeout / 2.
other_config : mcast_query_max_response: optional string,
containing an integer, in range 1 to 10
Configures the value of the "max-response" field in the
multicast queries originated by the logical switch.
Default: 1 second.
other_config : mcast_eth_src: optional string
Configures the source Ethernet address for queries
originated by the logical switch.
other_config : mcast_ip4_src: optional string
Configures the source IPv4 address for queries originated
by the logical switch.
Common Columns:
external_ids: map of string-string pairs
See External IDs at the beginning of this document.
