ovs-vswitchd.conf.db (5) - Linux Man Pages

ovs-vswitchd.conf.db: Open_vSwitch database schema

NAME

ovs-vswitchd46conf46db - Open_vSwitch database schema

A database with this schema holds the configuration for one Open vSwitch daemon46 The top-level configuration for the daemon is the Open_vSwitch table, which must have exactly one record46 Records in other tables are significant only when they can be reached directly or indirectly from the Open_vSwitch table46 Records that are not reachable from the Open_vSwitch table are automatically deleted from the database, except for records in a few distinguished ``root set'' tables46

Common Columns

Most tables contain two special columns, named other_config and external_ids46 These columns have the same form and purpose each place that they appear, so we describe them here to save space later46

other_config: map of string-string pairs
Key-value pairs for configuring rarely used features46 Supported keys, along with the forms taken by their values, are documented individually for each table46
A few tables do not have other_config columns because no key-value pairs have yet been defined for them46
external_ids: map of string-string pairs
Key-value pairs for use by external frameworks that integrate with Open vSwitch, rather than by Open vSwitch itself46 System integrators should either use the Open vSwitch development mailing list to coordinate on common key-value definitions, or choose key names that are likely to be unique46 In some cases, where key-value pairs have been defined that are likely to be widely useful, they are documented individually for each table46

TABLE SUMMARY

The following list summarizes the purpose of each of the tables in the Open_vSwitch database. Each table is described in more detail on a later page.

Table
Purpose
Open_vSwitch
Open vSwitch configuration46
Bridge
Bridge configuration46
Port
Port configuration46
Interface
One physical network device in a Port46
Flow_Table
OpenFlow table configuration
QoS
Quality of Service configuration
Queue
QoS output queue46
Mirror
Port mirroring46
Controller
OpenFlow controller configuration46
Manager
OVSDB management connection46
NetFlow
NetFlow configuration46
SSL
SSL configuration46
sFlow
sFlow configuration46
IPFIX
IPFIX configuration46
Flow_Sample_Collector_Set
Flow_Sample_Collector_Set configuration46
AutoAttach
AutoAttach configuration46

Open_vSwitch TABLE

Configuration for an Open vSwitch daemon46 There must be exactly one record in the Open_vSwitch table46

Summary:


Configuration:

bridges
set of Bridges
ssl
optional SSL
external_ids : system-id
optional string
external_ids : xs-system-uuid
optional string
other_config : stats-update-interval
optional string, containing an integer, at least 5,000
other_config : flow-restore-wait
optional string, either true or false
other_config : flow-limit
optional string, containing an integer, at least 0
other_config : max-idle
optional string, containing an integer, at least 500
other_config : n-dpdk-rxqs
optional string, containing an integer, at least 1
other_config : pmd-cpu-mask
optional string
other_config : n-handler-threads
optional string, containing an integer, at least 1
other_config : n-revalidator-threads
optional string, containing an integer, at least 1

Status:

next_cfg
integer
cur_cfg
integer
Statistics:

other_config : enable-statistics
optional string, either true or false
statistics : cpu
optional string, containing an integer, at least 1
statistics : load_average
optional string
statistics : memory
optional string
statistics : process_NAME
optional string
statistics : file_systems
optional string

Version Reporting:

ovs_version
optional string
db_version
optional string
system_type
optional string
system_version
optional string

Capabilities:

datapath_types
set of strings
iface_types
set of strings

Database Configuration:

manager_options
set of Managers

Common Columns:

other_config
map of string-string pairs
external_ids
map of string-string pairs

Details:

Configuration:

bridges: set of Bridges
Set of bridges managed by the daemon46
ssl: optional SSL
SSL used globally by the daemon46
external_ids : system-id: optional string
A unique identifier for the Open vSwitch's physical host46 The form of the identifier depends on the type of the host46 On a Citrix XenServer, this will likely be the same as external_ids:xs-system-uuid46
external_ids : xs-system-uuid: optional string
The Citrix XenServer universally unique identifier for the physical host as displayed by xe host-list46
other_config : stats-update-interval: optional string, containing an integer, at least 5,000
Interval for updating statistics to the database, in milliseconds46 This option will affect the update of the statistics column in the following tables: Port, Interface , Mirror46
Default value is 5000 ms46
Getting statistics more frequently can be achieved via OpenFlow46
other_config : flow-restore-wait: optional string, either true or false
When ovs-vswitchd starts up, it has an empty flow table and therefore it handles all arriving packets in its default fashion according to its configuration, by dropping them or sending them to an OpenFlow controller or switching them as a standalone switch46 This behavior is ordinarily desirable46 However, if ovs-vswitchd is restarting as part of a ``hot-upgrade,'' then this leads to a relatively long period during which packets are mishandled46
This option allows for improvement46 When ovs-vswitchd starts with this value set as true, it will neither flush or expire previously set datapath flows nor will it send and receive any packets to or from the datapath46 When this value is later set to false, ovs-vswitchd will start receiving packets from the datapath and re-setup the flows46
Thus, with this option, the procedure for a hot-upgrade of ovs-vswitchd becomes roughly the following:
1.
Stop ovs-vswitchd46
2.
Set other_config:flow-restore-wait to true46
3.
Start ovs-vswitchd46
4.
Use ovs-ofctl (or some other program, such as an OpenFlow controller) to restore the OpenFlow flow table to the desired state46
5.
Set other_config:flow-restore-wait to false (or remove it entirely from the database)46
The ovs-ctl's ``restart'' and ``force-reload-kmod'' functions use the above config option during hot upgrades46
other_config : flow-limit: optional string, containing an integer, at least 0
The maximum number of flows allowed in the datapath flow table46 Internally OVS will choose a flow limit which will likely be lower than this number, based on real time network conditions46 Tweaking this value is discouraged unless you know exactly what you're doing46
The default is 20000046
other_config : max-idle: optional string, containing an integer, at least 500
The maximum time (in ms) that idle flows will remain cached in the datapath46 Internally OVS will check the validity and activity for datapath flows regularly and may expire flows quicker than this number, based on real time network conditions46 Tweaking this value is discouraged unless you know exactly what you're doing46
The default is 1000046
other_config : n-dpdk-rxqs: optional string, containing an integer, at least 1
Specifies the maximum number of rx queues to be created for each dpdk interface46 If not specified or specified to 0, one rx queue will be created for each dpdk interface by default46
other_config : pmd-cpu-mask: optional string
Specifies CPU mask for setting the cpu affinity of PMD (Poll Mode Driver) threads46 Value should be in the form of hex string, similar to the dpdk EAL '-c COREMASK' option input or the 'taskset' mask input46
The lowest order bit corresponds to the first CPU core46 A set bit means the corresponding core is available and a pmd thread will be created and pinned to it46 If the input does not cover all cores, those uncovered cores are considered not set46
If not specified, one pmd thread will be created for each numa node and pinned to any available core on the numa node by default46
other_config : n-handler-threads: optional string, containing an integer, at least 1
Specifies the number of threads for software datapaths to use for handling new flows46 The default the number of online CPU cores minus the number of revalidators46
This configuration is per datapath46 If you have more than one software datapath (e46g46 some system bridges and some netdev bridges), then the total number of threads is n-handler-threads times the number of software datapaths46
other_config : n-revalidator-threads: optional string, containing an integer, at least 1
Specifies the number of threads for software datapaths to use for revalidating flows in the datapath46 Typically, there is a direct correlation between the number of revalidator threads, and the number of flows allowed in the datapath46 The default is the number of cpu cores divided by four plus one46 If n-handler-threads is set, the default changes to the number of cpu cores minus the number of handler threads46
This configuration is per datapath46 If you have more than one software datapath (e46g46 some system bridges and some netdev bridges), then the total number of threads is n-handler-threads times the number of software datapaths46

Status:

next_cfg: integer
Sequence number for client to increment46 When a client modifies any part of the database configuration and wishes to wait for Open vSwitch to finish applying the changes, it may increment this sequence number46
cur_cfg: integer
Sequence number that Open vSwitch sets to the current value of next_cfg after it finishes applying a set of configuration changes46

Statistics: The statistics column contains key-value pairs that report statistics about a system running an Open vSwitch46 These are updated periodically (currently, every 5 seconds)46 Key-value pairs that cannot be determined or that do not apply to a platform are omitted46

other_config : enable-statistics: optional string, either true or false
Statistics are disabled by default to avoid overhead in the common case when statistics gathering is not useful46 Set this value to true to enable populating the statistics column or to false to explicitly disable it46
statistics : cpu: optional string, containing an integer, at least 1
Number of CPU processors, threads, or cores currently online and available to the operating system on which Open vSwitch is running, as an integer46 This may be less than the number installed, if some are not online or if they are not available to the operating system46
Open vSwitch userspace processes are not multithreaded, but the Linux kernel-based datapath is46
statistics : load_average: optional string
A comma-separated list of three floating-point numbers, representing the system load average over the last 1, 5, and 15 minutes, respectively46
statistics : memory: optional string
A comma-separated list of integers, each of which represents a quantity of memory in kilobytes that describes the operating system on which Open vSwitch is running46 In respective order, these values are:
1.
Total amount of RAM allocated to the OS46
2.
RAM allocated to the OS that is in use46
3.
RAM that can be flushed out to disk or otherwise discarded if that space is needed for another purpose46 This number is necessarily less than or equal to the previous value46
4.
Total disk space allocated for swap46
5.
Swap space currently in use46
On Linux, all five values can be determined and are included46 On other operating systems, only the first two values can be determined, so the list will only have two values46
statistics : process_NAME: optional string
One such key-value pair, with NAME replaced by a process name, will exist for each running Open vSwitch daemon process, with name replaced by the daemon's name (e46g46 process_ovs-vswitchd)46 The value is a comma-separated list of integers46 The integers represent the following, with memory measured in kilobytes and durations in milliseconds:
1.
The process's virtual memory size46
2.
The process's resident set size46
3.
The amount of user and system CPU time consumed by the process46
4.
The number of times that the process has crashed and been automatically restarted by the monitor46
5.
The duration since the process was started46
6.
The duration for which the process has been running46
The interpretation of some of these values depends on whether the process was started with the --monitor46 If it was not, then the crash count will always be 0 and the two durations will always be the same46 If --monitor was given, then the crash count may be positive; if it is, the latter duration is the amount of time since the most recent crash and restart46
There will be one key-value pair for each file in Open vSwitch's ``run directory'' (usually /var/run/openvswitch) whose name ends in 46pid, whose contents are a process ID, and which is locked by a running process46 The name is taken from the pidfile's name46
Currently Open vSwitch is only able to obtain all of the above detail on Linux systems46 On other systems, the same key-value pairs will be present but the values will always be the empty string46
statistics : file_systems: optional string
A space-separated list of information on local, writable file systems46 Each item in the list describes one file system and consists in turn of a comma-separated list of the following:
1.
Mount point, e46g46 / or /var/log46 Any spaces or commas in the mount point are replaced by underscores46
2.
Total size, in kilobytes, as an integer46
3.
Amount of storage in use, in kilobytes, as an integer46
This key-value pair is omitted if there are no local, writable file systems or if Open vSwitch cannot obtain the needed information46

Version Reporting: These columns report the types and versions of the hardware and software running Open vSwitch46 We recommend in general that software should test whether specific features are supported instead of relying on version number checks46 These values are primarily intended for reporting to human administrators46

ovs_version: optional string
The Open vSwitch version number, e46g46 146146046
db_version: optional string
The database schema version number in the form major46minor46tweak, e46g46 146246346 Whenever the database schema is changed in a non-backward compatible way (e46g46 deleting a column or a table), major is incremented46 When the database schema is changed in a backward compatible way (e46g46 adding a new column), minor is incremented46 When the database schema is changed cosmetically (e46g46 reindenting its syntax), tweak is incremented46
The schema version is part of the database schema, so it can also be retrieved by fetching the schema using the Open vSwitch database protocol46
system_type: optional string
An identifier for the type of system on top of which Open vSwitch runs, e46g46 XenServer or KVM46
System integrators are responsible for choosing and setting an appropriate value for this column46
system_version: optional string
The version of the system identified by system_type, e46g46 546646100-39265p on XenServer 546646100 build 3926546
System integrators are responsible for choosing and setting an appropriate value for this column46

Capabilities: These columns report capabilities of the Open vSwitch instance46

datapath_types: set of strings
This column reports the different dpifs registered with the system46 These are the values that this instance supports in the datapath_type column of the Bridge table46
iface_types: set of strings
This column reports the different netdevs registered with the system46 These are the values that this instance supports in the type column of the Interface table46

Database Configuration: These columns primarily configure the Open vSwitch database (ovsdb-server), not the Open vSwitch switch (ovs-vswitchd)46 The OVSDB database also uses the ssl settings46

The Open vSwitch switch does read the database configuration to determine remote IP addresses to which in-band control should apply46

manager_options: set of Managers
Database clients to which the Open vSwitch database server should connect or to which it should listen, along with options for how these connection should be configured46 See the Manager table for more information46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

other_config: map of string-string pairs
external_ids: map of string-string pairs

Bridge TABLE

Configuration for a bridge within an Open_vSwitch46

A Bridge record represents an Ethernet switch with one or more ``ports,'' which are the Port records pointed to by the Bridge's ports column46

Summary:


Core Features:

name
immutable string (must be unique within table)
ports
set of Ports
mirrors
set of Mirrors
netflow
optional NetFlow
sflow
optional sFlow
ipfix
optional IPFIX
flood_vlans
set of up to 4,096 integers, in range 0 to 4,095
auto_attach
optional AutoAttach

OpenFlow Configuration:

controller
set of Controllers
flow_tables
map of integer-Flow_Table pairs, key in range 0 to 254
fail_mode
optional string, either secure or standalone
datapath_id
optional string
datapath_version
string
other_config : datapath-id
optional string
other_config : dp-desc
optional string
other_config : disable-in-band
optional string, either true or false
other_config : in-band-queue
optional string, containing an integer, in range 0 to 4,294,967,295
protocols
set of strings, one of OpenFlow11, OpenFlow10, OpenFlow13, OpenFlow12, OpenFlow15, or OpenFlow14

Spanning Tree Configuration:
STP Configuration:

stp_enable
boolean
other_config : stp-system-id
optional string
other_config : stp-priority
optional string, containing an integer, in range 0 to 65,535
other_config : stp-hello-time
optional string, containing an integer, in range 1 to 10
other_config : stp-max-age
optional string, containing an integer, in range 6 to 40
other_config : stp-forward-delay
optional string, containing an integer, in range 4 to 30
other_config : mcast-snooping-aging-time
optional string, containing an integer, at least 1
other_config : mcast-snooping-table-size
optional string, containing an integer, at least 1
other_config : mcast-snooping-disable-flood-unregistered
optional string, either true or false

STP Status:

status : stp_bridge_id
optional string
status : stp_designated_root
optional string
status : stp_root_path_cost
optional string

Rapid Spanning Tree:
RSTP Configuration:

rstp_enable
boolean
other_config : rstp-address
optional string
other_config : rstp-priority
optional string, containing an integer, in range 0 to 61,440
other_config : rstp-ageing-time
optional string, containing an integer, in range 10 to 1,000,000
other_config : rstp-force-protocol-version
optional string, containing an integer
other_config : rstp-max-age
optional string, containing an integer, in range 6 to 40
other_config : rstp-forward-delay
optional string, containing an integer, in range 4 to 30
other_config : rstp-transmit-hold-count
optional string, containing an integer, in range 1 to 10

RSTP Status:

rstp_status : rstp_bridge_id
optional string
rstp_status : rstp_root_id
optional string
rstp_status : rstp_root_path_cost
optional string, containing an integer, at least 0
rstp_status : rstp_designated_id
optional string
rstp_status : rstp_designated_port_id
optional string
rstp_status : rstp_bridge_port_id
optional string

Multicast Snooping Configuration:

mcast_snooping_enable
boolean

Other Features:

datapath_type
string
external_ids : bridge-id
optional string
external_ids : xs-network-uuids
optional string
other_config : hwaddr
optional string
other_config : forward-bpdu
optional string, either true or false
other_config : mac-aging-time
optional string, containing an integer, at least 1
other_config : mac-table-size
optional string, containing an integer, at least 1

Common Columns:

other_config
map of string-string pairs
external_ids
map of string-string pairs

Details:

Core Features:

name: immutable string (must be unique within table)
Bridge identifier46 Should be alphanumeric and no more than about 8 bytes long46 Must be unique among the names of ports, interfaces, and bridges on a host46
ports: set of Ports
Ports included in the bridge46
mirrors: set of Mirrors
Port mirroring configuration46
netflow: optional NetFlow
NetFlow configuration46
sflow: optional sFlow
sFlow(R) configuration46
ipfix: optional IPFIX
IPFIX configuration46
flood_vlans: set of up to 4,096 integers, in range 0 to 4,095
VLAN IDs of VLANs on which MAC address learning should be disabled, so that packets are flooded instead of being sent to specific ports that are believed to contain packets' destination MACs46 This should ordinarily be used to disable MAC learning on VLANs used for mirroring (RSPAN VLANs)46 It may also be useful for debugging46
SLB bonding (see the bond_mode column in the Port table) is incompatible with flood_vlans46 Consider using another bonding mode or a different type of mirror instead46
auto_attach: optional AutoAttach
Auto Attach configuration46

OpenFlow Configuration:

controller: set of Controllers
OpenFlow controller set46 If unset, then no OpenFlow controllers will be used46
If there are primary controllers, removing all of them clears the flow table46 If there are no primary controllers, adding one also clears the flow table46 Other changes to the set of controllers, such as adding or removing a service controller, adding another primary controller to supplement an existing primary controller, or removing only one of two primary controllers, have no effect on the flow table46
flow_tables: map of integer-Flow_Table pairs, key in range 0 to 254
Configuration for OpenFlow tables46 Each pair maps from an OpenFlow table ID to configuration for that table46
fail_mode: optional string, either secure or standalone
When a controller is configured, it is, ordinarily, responsible for setting up all flows on the switch46 Thus, if the connection to the controller fails, no new network connections can be set up46 If the connection to the controller stays down long enough, no packets can pass through the switch at all46 This setting determines the switch's response to such a situation46 It may be set to one of the following:
standalone
If no message is received from the controller for three times the inactivity probe interval (see inactivity_probe), then Open vSwitch will take over responsibility for setting up flows46 In this mode, Open vSwitch causes the bridge to act like an ordinary MAC-learning switch46 Open vSwitch will continue to retry connecting to the controller in the background and, when the connection succeeds, it will discontinue its standalone behavior46
secure
Open vSwitch will not set up flows on its own when the controller connection fails or when no controllers are defined46 The bridge will continue to retry connecting to any defined controllers forever46
The default is standalone if the value is unset, but future versions of Open vSwitch may change the default46
The standalone mode can create forwarding loops on a bridge that has more than one uplink port unless STP is enabled46 To avoid loops on such a bridge, configure secure mode or enable STP (see stp_enable)46
When more than one controller is configured, fail_mode is considered only when none of the configured controllers can be contacted46
Changing fail_mode when no primary controllers are configured clears the flow table46
datapath_id: optional string
Reports the OpenFlow datapath ID in use46 Exactly 16 hex digits46 (Setting this column has no useful effect46 Set other-config:datapath-id instead46)
datapath_version: string
Reports the version number of the Open vSwitch datapath in use46 This allows management software to detect and report discrepancies between Open vSwitch userspace and datapath versions46 (The ovs_version column in the Open_vSwitch reports the Open vSwitch userspace version46) The version reported depends on the datapath in use:
When the kernel module included in the Open vSwitch source tree is used, this column reports the Open vSwitch version from which the module was taken46
When the kernel module that is part of the upstream Linux kernel is used, this column reports <unknown>46
When the datapath is built into the ovs-vswitchd binary, this column reports <built-in>46 A built-in datapath is by definition the same version as the rest of the Open VSwitch userspace46
Other datapaths (such as the Hyper-V kernel datapath) currently report <unknown>46
A version discrepancy between ovs-vswitchd and the datapath in use is not normally cause for alarm46 The Open vSwitch kernel datapaths for Linux and Hyper-V, in particular, are designed for maximum inter-version compatibility: any userspace version works with with any kernel version46 Some reasons do exist to insist on particular user/kernel pairings46 First, newer kernel versions add new features, that can only be used by new-enough userspace, e46g46 VXLAN tunneling requires certain minimal userspace and kernel versions46 Second, as an extension to the first reason, some newer kernel versions add new features for enhancing performance that only new-enough userspace versions can take advantage of46
other_config : datapath-id: optional string
Exactly 16 hex digits to set the OpenFlow datapath ID to a specific value46 May not be all-zero46
other_config : dp-desc: optional string
Human readable description of datapath46 It it a maximum 256 byte-long free-form string to describe the datapath for debugging purposes, e46g46 switch3 in room 312046
other_config : disable-in-band: optional string, either true or false
If set to true, disable in-band control on the bridge regardless of controller and manager settings46
other_config : in-band-queue: optional string, containing an integer, in range 0 to 4,294,967,295
A queue ID as a nonnegative integer46 This sets the OpenFlow queue ID that will be used by flows set up by in-band control on this bridge46 If unset, or if the port used by an in-band control flow does not have QoS configured, or if the port does not have a queue with the specified ID, the default queue is used instead46
protocols: set of strings, one of OpenFlow11, OpenFlow10, OpenFlow13, OpenFlow12, OpenFlow15, or OpenFlow14
List of OpenFlow protocols that may be used when negotiating a connection with a controller46 OpenFlow 1460, 1461, 1462, and 1463 are enabled by default if this column is empty46
OpenFlow 1464 is not enabled by default because its implementation is missing features46
OpenFlow 1465 has the same risks as OpenFlow 1464, but it is even more experimental because the OpenFlow 1465 specification is still under development and thus subject to change46 Pass --enable-of15 to ovs-vswitchd to allow OpenFlow 1465 to be enabled46

Spanning Tree Configuration: The IEEE 802461D Spanning Tree Protocol (STP) is a network protocol that ensures loop-free topologies46 It allows redundant links to be included in the network to provide automatic backup paths if the active links fails46

These settings configure the slower-to-converge but still widely supported version of Spanning Tree Protocol, sometimes known as 802461D-199846 Open vSwitch also supports the newer Rapid Spanning Tree Protocol (RSTP), documented later in the section titled Rapid Spanning Tree Configuration46

STP Configuration:

stp_enable: boolean
Enable spanning tree on the bridge46 By default, STP is disabled on bridges46 Bond, internal, and mirror ports are not supported and will not participate in the spanning tree46
STP and RSTP are mutually exclusive46 If both are enabled, RSTP will be used46
other_config : stp-system-id: optional string
The bridge's STP identifier (the lower 48 bits of the bridge-id) in the form xx:xx:xx:xx:xx:xx46 By default, the identifier is the MAC address of the bridge46
other_config : stp-priority: optional string, containing an integer, in range 0 to 65,535
The bridge's relative priority value for determining the root bridge (the upper 16 bits of the bridge-id)46 A bridge with the lowest bridge-id is elected the root46 By default, the priority is 0x800046
other_config : stp-hello-time: optional string, containing an integer, in range 1 to 10
The interval between transmissions of hello messages by designated ports, in seconds46 By default the hello interval is 2 seconds46
other_config : stp-max-age: optional string, containing an integer, in range 6 to 40
The maximum age of the information transmitted by the bridge when it is the root bridge, in seconds46 By default, the maximum age is 20 seconds46
other_config : stp-forward-delay: optional string, containing an integer, in range 4 to 30
The delay to wait between transitioning root and designated ports to forwarding, in seconds46 By default, the forwarding delay is 15 seconds46
other_config : mcast-snooping-aging-time: optional string, containing an integer, at least 1
The maximum number of seconds to retain a multicast snooping entry for which no packets have been seen46 The default is currently 300 seconds (5 minutes)46 The value, if specified, is forced into a reasonable range, currently 15 to 3600 seconds46
other_config : mcast-snooping-table-size: optional string, containing an integer, at least 1
The maximum number of multicast snooping addresses to learn46 The default is currently 204846 The value, if specified, is forced into a reasonable range, currently 10 to 1,000,00046
other_config : mcast-snooping-disable-flood-unregistered: optional string, either true or false
If set to false, unregistered multicast packets are forwarded to all ports46 If set to true, unregistered multicast packets are forwarded to ports connected to multicast routers46

STP Status: These key-value pairs report the status of 802461D-199846 They are present only if STP is enabled (via the stp_enable column)46

status : stp_bridge_id: optional string
The bridge ID used in spanning tree advertisements, in the form xxxx46yyyyyyyyyyyy where the xs are the STP priority, the ys are the STP system ID, and each x and y is a hex digit46
status : stp_designated_root: optional string
The designated root for this spanning tree, in the same form as status:stp_bridge_id46 If this bridge is the root, this will have the same value as status:stp_bridge_id, otherwise it will differ46
status : stp_root_path_cost: optional string
The path cost of reaching the designated bridge46 A lower number is better46 The value is 0 if this bridge is the root, otherwise it is higher46

Rapid Spanning Tree: Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol that ensures loop-free topologies46 RSTP superseded STP with the publication of 802461D-200446 Compared to STP, RSTP converges more quickly and recovers more quickly from failures46

RSTP Configuration:

rstp_enable: boolean
Enable Rapid Spanning Tree on the bridge46 By default, RSTP is disabled on bridges46 Bond, internal, and mirror ports are not supported and will not participate in the spanning tree46
STP and RSTP are mutually exclusive46 If both are enabled, RSTP will be used46
other_config : rstp-address: optional string
The bridge's RSTP address (the lower 48 bits of the bridge-id) in the form xx:xx:xx:xx:xx:xx46 By default, the address is the MAC address of the bridge46
other_config : rstp-priority: optional string, containing an integer, in range 0 to 61,440
The bridge's relative priority value for determining the root bridge (the upper 16 bits of the bridge-id)46 A bridge with the lowest bridge-id is elected the root46 By default, the priority is 0x8000 (32768)46 This value needs to be a multiple of 4096, otherwise it's rounded to the nearest inferior one46
other_config : rstp-ageing-time: optional string, containing an integer, in range 10 to 1,000,000
The Ageing Time parameter for the Bridge46 The default value is 300 seconds46
other_config : rstp-force-protocol-version: optional string, containing an integer
The Force Protocol Version parameter for the Bridge46 This can take the value 0 (STP Compatibility mode) or 2 (the default, normal operation)46
other_config : rstp-max-age: optional string, containing an integer, in range 6 to 40
The maximum age of the information transmitted by the Bridge when it is the Root Bridge46 The default value is 2046
other_config : rstp-forward-delay: optional string, containing an integer, in range 4 to 30
The delay used by STP Bridges to transition Root and Designated Ports to Forwarding46 The default value is 1546
other_config : rstp-transmit-hold-count: optional string, containing an integer, in range 1 to 10
The Transmit Hold Count used by the Port Transmit state machine to limit transmission rate46 The default value is 646

RSTP Status: These key-value pairs report the status of 802461D-200446 They are present only if RSTP is enabled (via the rstp_enable column)46

rstp_status : rstp_bridge_id: optional string
The bridge ID used in rapid spanning tree advertisements, in the form x46yyy46zzzzzzzzzzzz where x is the RSTP priority, the ys are a locally assigned system ID extension, the zs are the STP system ID, and each x, y, or z is a hex digit46
rstp_status : rstp_root_id: optional string
The root of this spanning tree, in the same form as rstp_status:rstp_bridge_id46 If this bridge is the root, this will have the same value as rstp_status:rstp_bridge_id, otherwise it will differ46
rstp_status : rstp_root_path_cost: optional string, containing an integer, at least 0
The path cost of reaching the root46 A lower number is better46 The value is 0 if this bridge is the root, otherwise it is higher46
rstp_status : rstp_designated_id: optional string
The RSTP designated ID, in the same form as rstp_status:rstp_bridge_id46
rstp_status : rstp_designated_port_id: optional string
The RSTP designated port ID, as a 4-digit hex number46
rstp_status : rstp_bridge_port_id: optional string
The RSTP bridge port ID, as a 4-digit hex number46

Multicast Snooping Configuration: Multicast snooping (RFC 4541) monitors the Internet Group Management Protocol (IGMP) and Multicast Listener Discovery traffic between hosts and multicast routers46 The switch uses what IGMP and MLD snooping learns to forward multicast traffic only to interfaces that are connected to interested receivers46 Currently it supports IGMPv1, IGMPv2, IGMPv3, MLDv1 and MLDv2 protocols46

mcast_snooping_enable: boolean
Enable multicast snooping on the bridge46 For now, the default is disabled46

Other Features:

datapath_type: string
Name of datapath provider46 The kernel datapath has type system46 The userspace datapath has type netdev46 A manager may refer to the datapath_types column of the Open_vSwitch table for a list of the types accepted by this Open vSwitch instance46
external_ids : bridge-id: optional string
A unique identifier of the bridge46 On Citrix XenServer this will commonly be the same as external_ids:xs-network-uuids46
external_ids : xs-network-uuids: optional string
Semicolon-delimited set of universally unique identifier(s) for the network with which this bridge is associated on a Citrix XenServer host46 The network identifiers are RFC 4122 UUIDs as displayed by, e46g46, xe network-list46
other_config : hwaddr: optional string
An Ethernet address in the form xx:xx:xx:xx:xx:xx to set the hardware address of the local port and influence the datapath ID46
other_config : forward-bpdu: optional string, either true or false
Controls forwarding of BPDUs and other network control frames when NORMAL action is invoked46 When this option is false or unset, frames with reserved Ethernet addresses (see table below) will not be forwarded46 When this option is true, such frames will not be treated specially46
The above general rule has the following exceptions:
If STP is enabled on the bridge (see the stp_enable column in the Bridge table), the bridge processes all received STP packets and never passes them to OpenFlow or forwards them46 This is true even if STP is disabled on an individual port46
If LLDP is enabled on an interface (see the lldp column in the Interface table), the interface processes received LLDP packets and never passes them to OpenFlow or forwards them46
Set this option to true if the Open vSwitch bridge connects different Ethernet networks and is not configured to participate in STP46
This option affects packets with the following destination MAC addresses:
01:80:c2:00:00:00
IEEE 802461D Spanning Tree Protocol (STP)46
01:80:c2:00:00:01
IEEE Pause frame46
01:80:c2:00:00:0x
Other reserved protocols46
00:e0:2b:00:00:00
Extreme Discovery Protocol (EDP)46
00:e0:2b:00:00:04 and 00:e0:2b:00:00:06
Ethernet Automatic Protection Switching (EAPS)46
01:00:0c:cc:cc:cc
Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP), Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP), and others46
01:00:0c:cc:cc:cd
Cisco Shared Spanning Tree Protocol PVSTP+46
01:00:0c:cd:cd:cd
Cisco STP Uplink Fast46
01:00:0c:00:00:00
Cisco Inter Switch Link46
01:00:0c:cc:cc:cx
Cisco CFM46
other_config : mac-aging-time: optional string, containing an integer, at least 1
The maximum number of seconds to retain a MAC learning entry for which no packets have been seen46 The default is currently 300 seconds (5 minutes)46 The value, if specified, is forced into a reasonable range, currently 15 to 3600 seconds46
A short MAC aging time allows a network to more quickly detect that a host is no longer connected to a switch port46 However, it also makes it more likely that packets will be flooded unnecessarily, when they are addressed to a connected host that rarely transmits packets46 To reduce the incidence of unnecessary flooding, use a MAC aging time longer than the maximum interval at which a host will ordinarily transmit packets46
other_config : mac-table-size: optional string, containing an integer, at least 1
The maximum number of MAC addresses to learn46 The default is currently 204846 The value, if specified, is forced into a reasonable range, currently 10 to 1,000,00046

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

other_config: map of string-string pairs
external_ids: map of string-string pairs

Port TABLE

A port within a Bridge46

Most commonly, a port has exactly one ``interface,'' pointed to by its interfaces column46 Such a port logically corresponds to a port on a physical Ethernet switch46 A port with more than one interface is a ``bonded port'' (see Bonding Configuration)46

Some properties that one might think as belonging to a port are actually part of the port's Interface members46

Summary:


name
immutable string (must be unique within table)
interfaces
set of 1 or more Interfaces
VLAN Configuration:

vlan_mode
optional string, one of access, native-tagged, native-untagged, or trunk
tag
optional integer, in range 0 to 4,095
trunks
set of up to 4,096 integers, in range 0 to 4,095
other_config : priority-tags
optional string, either true or false

Bonding Configuration:

bond_mode
optional string, one of active-backup, balance-tcp, or balance-slb
other_config : bond-hash-basis
optional string, containing an integer
Link Failure Detection:

other_config : bond-detect-mode
optional string, either miimon or carrier
other_config : bond-miimon-interval
optional string, containing an integer
bond_updelay
integer
bond_downdelay
integer

LACP Configuration:

lacp
optional string, one of active, passive, or off
other_config : lacp-system-id
optional string
other_config : lacp-system-priority
optional string, containing an integer, in range 1 to 65,535
other_config : lacp-time
optional string, either slow or fast
other_config : lacp-fallback-ab
optional string, either true or false

Rebalancing Configuration:

other_config : bond-rebalance-interval
optional string, containing an integer, in range 0 to 10,000

bond_fake_iface
boolean

Spanning Tree Protocol:
STP Configuration:

other_config : stp-enable
optional string, either true or false
other_config : stp-port-num
optional string, containing an integer, in range 1 to 255
other_config : stp-port-priority
optional string, containing an integer, in range 0 to 255
other_config : stp-path-cost
optional string, containing an integer, in range 0 to 65,535

STP Status:

status : stp_port_id
optional string
status : stp_state
optional string, one of disabled, forwarding, learning, listening, or blocking
status : stp_sec_in_state
optional string, containing an integer, at least 0
status : stp_role
optional string, one of designated, alternate, or root

Rapid Spanning Tree Protocol:
RSTP Configuration:

other_config : rstp-enable
optional string, either true or false
other_config : rstp-port-priority
optional string, containing an integer, in range 0 to 240
other_config : rstp-port-num
optional string, containing an integer, in range 1 to 4,095
other_config : rstp-port-path-cost
optional string, containing an integer
other_config : rstp-port-admin-edge
optional string, either true or false
other_config : rstp-port-auto-edge
optional string, either true or false
other_config : rstp-port-mcheck
optional string, either true or false

RSTP Status:

rstp_status : rstp_port_id
optional string
rstp_status : rstp_port_role
optional string, one of Backup, Designated, Alternate, Root, or Disabled
rstp_status : rstp_port_state
optional string, one of Disabled, Discarding, Forwarding, or Learning
rstp_status : rstp_designated_bridge_id
optional string
rstp_status : rstp_designated_port_id
optional string
rstp_status : rstp_designated_path_cost
optional string, containing an integer

RSTP Statistics:

rstp_statistics : rstp_tx_count
optional integer
rstp_statistics : rstp_rx_count
optional integer
rstp_statistics : rstp_error_count
optional integer
rstp_statistics : rstp_uptime
optional integer

Multicast Snooping:

other_config : mcast-snooping-flood
optional string, either true or false
other_config : mcast-snooping-flood-reports
optional string, either true or false

Other Features:

qos
optional QoS
mac
optional string
fake_bridge
boolean
external_ids : fake-bridge-id-*
optional string
other_config : transient
optional string, either true or false

bond_active_slave
optional string
Port Statistics:
Statistics: STP transmit and receive counters:

statistics : stp_tx_count
optional integer
statistics : stp_rx_count
optional integer
statistics : stp_error_count
optional integer

Common Columns:

other_config
map of string-string pairs
external_ids
map of string-string pairs

Details:

name: immutable string (must be unique within table)
Port name46 Should be alphanumeric and no more than about 8 bytes long46 May be the same as the interface name, for non-bonded ports46 Must otherwise be unique among the names of ports, interfaces, and bridges on a host46
interfaces: set of 1 or more Interfaces
The port's interfaces46 If there is more than one, this is a bonded Port46

VLAN Configuration: Bridge ports support the following types of VLAN configuration:

trunk
A trunk port carries packets on one or more specified VLANs specified in the trunks column (often, on every VLAN)46 A packet that ingresses on a trunk port is in the VLAN specified in its 802461Q header, or VLAN 0 if the packet has no 802461Q header46 A packet that egresses through a trunk port will have an 802461Q header if it has a nonzero VLAN ID46
Any packet that ingresses on a trunk port tagged with a VLAN that the port does not trunk is dropped46
access
An access port carries packets on exactly one VLAN specified in the tag column46 Packets egressing on an access port have no 802461Q header46
Any packet with an 802461Q header with a nonzero VLAN ID that ingresses on an access port is dropped, regardless of whether the VLAN ID in the header is the access port's VLAN ID46
native-tagged
A native-tagged port resembles a trunk port, with the exception that a packet without an 802461Q header that ingresses on a native-tagged port is in the ``native VLAN'' (specified in the tag column)46
native-untagged
A native-untagged port resembles a native-tagged port, with the exception that a packet that egresses on a native-untagged port in the native VLAN will not have an 802461Q header46

A packet will only egress through bridge ports that carry the VLAN of the packet, as described by the rules above46

vlan_mode: optional string, one of access, native-tagged, native-untagged, or trunk
The VLAN mode of the port, as described above46 When this column is empty, a default mode is selected as follows:
If tag contains a value, the port is an access port46 The trunks column should be empty46
Otherwise, the port is a trunk port46 The trunks column value is honored if it is present46
tag: optional integer, in range 0 to 4,095
For an access port, the port's implicitly tagged VLAN46 For a native-tagged or native-untagged port, the port's native VLAN46 Must be empty if this is a trunk port46
trunks: set of up to 4,096 integers, in range 0 to 4,095
For a trunk, native-tagged, or native-untagged port, the 802461Q VLAN or VLANs that this port trunks; if it is empty, then the port trunks all VLANs46 Must be empty if this is an access port46
A native-tagged or native-untagged port always trunks its native VLAN, regardless of whether trunks includes that VLAN46
other_config : priority-tags: optional string, either true or false
An 802461Q header contains two important pieces of information: a VLAN ID and a priority46 A frame with a zero VLAN ID, called a ``priority-tagged'' frame, is supposed to be treated the same way as a frame without an 802461Q header at all (except for the priority)46
However, some network elements ignore any frame that has 802461Q header at all, even when the VLAN ID is zero46 Therefore, by default Open vSwitch does not output priority-tagged frames, instead omitting the 802461Q header entirely if the VLAN ID is zero46 Set this key to true to enable priority-tagged frames on a port46
Regardless of this setting, Open vSwitch omits the 802461Q header on output if both the VLAN ID and priority would be zero46
All frames output to native-tagged ports have a nonzero VLAN ID, so this setting is not meaningful on native-tagged ports46

Bonding Configuration: A port that has more than one interface is a ``bonded port46'' Bonding allows for load balancing and fail-over46

The following types of bonding will work with any kind of upstream switch46 On the upstream switch, do not configure the interfaces as a bond:

balance-slb
Balances flows among slaves based on source MAC address and output VLAN, with periodic rebalancing as traffic patterns change46
active-backup
Assigns all flows to one slave, failing over to a backup slave when the active slave is disabled46 This is the only bonding mode in which interfaces may be plugged into different upstream switches46

The following modes require the upstream switch to support 802463ad with successful LACP negotiation46 If LACP negotiation fails and other-config:lacp-fallback-ab is true, then active-backup mode is used:

balance-tcp
Balances flows among slaves based on L2, L3, and L4 protocol information such as destination MAC address, IP address, and TCP port46

These columns apply only to bonded ports46 Their values are otherwise ignored46

bond_mode: optional string, one of active-backup, balance-tcp, or balance-slb
The type of bonding used for a bonded port46 Defaults to active-backup if unset46
other_config : bond-hash-basis: optional string, containing an integer
An integer hashed along with flows when choosing output slaves in load balanced bonds46 When changed, all flows will be assigned different hash values possibly causing slave selection decisions to change46 Does not affect bonding modes which do not employ load balancing such as active-backup46

Link Failure Detection: An important part of link bonding is detecting that links are down so that they may be disabled46 These settings determine how Open vSwitch detects link failure46

other_config : bond-detect-mode: optional string, either miimon or carrier
The means used to detect link failures46 Defaults to carrier which uses each interface's carrier to detect failures46 When set to miimon, will check for failures by polling each interface's MII46
other_config : bond-miimon-interval: optional string, containing an integer
The interval, in milliseconds, between successive attempts to poll each interface's MII46 Relevant only when other_config:bond-detect-mode is miimon46
bond_updelay: integer
The number of milliseconds for which the link must stay up on an interface before the interface is considered to be up46 Specify 0 to enable the interface immediately46
This setting is honored only when at least one bonded interface is already enabled46 When no interfaces are enabled, then the first bond interface to come up is enabled immediately46
bond_downdelay: integer
The number of milliseconds for which the link must stay down on an interface before the interface is considered to be down46 Specify 0 to disable the interface immediately46

LACP Configuration: LACP, the Link Aggregation Control Protocol, is an IEEE standard that allows switches to automatically detect that they are connected by multiple links and aggregate across those links46 These settings control LACP behavior46

lacp: optional string, one of active, passive, or off
Configures LACP on this port46 LACP allows directly connected switches to negotiate which links may be bonded46 LACP may be enabled on non-bonded ports for the benefit of any switches they may be connected to46 active ports are allowed to initiate LACP negotiations46 passive ports are allowed to participate in LACP negotiations initiated by a remote switch, but not allowed to initiate such negotiations themselves46 If LACP is enabled on a port whose partner switch does not support LACP, the bond will be disabled, unless other-config:lacp-fallback-ab is set to true46 Defaults to off if unset46
other_config : lacp-system-id: optional string
The LACP system ID of this Port46 The system ID of a LACP bond is used to identify itself to its partners46 Must be a nonzero MAC address46 Defaults to the bridge Ethernet address if unset46
other_config : lacp-system-priority: optional string, containing an integer, in range 1 to 65,535
The LACP system priority of this Port46 In LACP negotiations, link status decisions are made by the system with the numerically lower priority46
other_config : lacp-time: optional string, either slow or fast
The LACP timing which should be used on this Port46 By default slow is used46 When configured to be fast LACP heartbeats are requested at a rate of once per second causing connectivity problems to be detected more quickly46 In slow mode, heartbeats are requested at a rate of once every 30 seconds46
other_config : lacp-fallback-ab: optional string, either true or false
Determines the behavior of openvswitch bond in LACP mode46 If the partner switch does not support LACP, setting this option to true allows openvswitch to fallback to active-backup46 If the option is set to false, the bond will be disabled46 In both the cases, once the partner switch is configured to LACP mode, the bond will use LACP46

Rebalancing Configuration: These settings control behavior when a bond is in balance-slb or balance-tcp mode46

other_config : bond-rebalance-interval: optional string, containing an integer, in range 0 to 10,000
For a load balanced bonded port, the number of milliseconds between successive attempts to rebalance the bond, that is, to move flows from one interface on the bond to another in an attempt to keep usage of each interface roughly equal46 If zero, load balancing is disabled on the bond (link failure still cause flows to move)46 If less than 1000ms, the rebalance interval will be 1000ms46
bond_fake_iface: boolean
For a bonded port, whether to create a fake internal interface with the name of the port46 Use only for compatibility with legacy software that requires this46

Spanning Tree Protocol: The configuration here is only meaningful, and the status is only populated, when 802461D-1998 Spanning Tree Protocol is enabled on the port's Bridge with its stp_enable column46

STP Configuration:

other_config : stp-enable: optional string, either true or false
When STP is enabled on a bridge, it is enabled by default on all of the bridge's ports except bond, internal, and mirror ports (which do not work with STP)46 If this column's value is false, STP is disabled on the port46
other_config : stp-port-num: optional string, containing an integer, in range 1 to 255
The port number used for the lower 8 bits of the port-id46 By default, the numbers will be assigned automatically46 If any port's number is manually configured on a bridge, then they must all be46
other_config : stp-port-priority: optional string, containing an integer, in range 0 to 255
The port's relative priority value for determining the root port (the upper 8 bits of the port-id)46 A port with a lower port-id will be chosen as the root port46 By default, the priority is 0x8046
other_config : stp-path-cost: optional string, containing an integer, in range 0 to 65,535
Spanning tree path cost for the port46 A lower number indicates a faster link46 By default, the cost is based on the maximum speed of the link46

STP Status:

status : stp_port_id: optional string
The port ID used in spanning tree advertisements for this port, as 4 hex digits46 Configuring the port ID is described in the stp-port-num and stp-port-priority keys of the other_config section earlier46
status : stp_state: optional string, one of disabled, forwarding, learning, listening, or blocking
STP state of the port46
status : stp_sec_in_state: optional string, containing an integer, at least 0
The amount of time this port has been in the current STP state, in seconds46
status : stp_role: optional string, one of designated, alternate, or root
STP role of the port46

Rapid Spanning Tree Protocol: The configuration here is only meaningful, and the status and statistics are only populated, when 802461D-1998 Spanning Tree Protocol is enabled on the port's Bridge with its stp_enable column46

RSTP Configuration:

other_config : rstp-enable: optional string, either true or false
When RSTP is enabled on a bridge, it is enabled by default on all of the bridge's ports except bond, internal, and mirror ports (which do not work with RSTP)46 If this column's value is false, RSTP is disabled on the port46
other_config : rstp-port-priority: optional string, containing an integer, in range 0 to 240
The port's relative priority value for determining the root port, in multiples of 1646 By default, the port priority is 0x80 (128)46 Any value in the lower 4 bits is rounded off46 The significant upper 4 bits become the upper 4 bits of the port-id46 A port with the lowest port-id is elected as the root46
other_config : rstp-port-num: optional string, containing an integer, in range 1 to 4,095
The local RSTP port number, used as the lower 12 bits of the port-id46 By default the port numbers are assigned automatically, and typically may not correspond to the OpenFlow port numbers46 A port with the lowest port-id is elected as the root46
other_config : rstp-port-path-cost: optional string, containing an integer
The port path cost46 The Port's contribution, when it is the Root Port, to the Root Path Cost for the Bridge46 By default the cost is automatically calculated from the port's speed46
other_config : rstp-port-admin-edge: optional string, either true or false
The admin edge port parameter for the Port46 Default is false46
other_config : rstp-port-auto-edge: optional string, either true or false
The auto edge port parameter for the Port46 Default is true46
other_config : rstp-port-mcheck: optional string, either true or false
The mcheck port parameter for the Port46 Default is false46 May be set to force the Port Protocol Migration state machine to transmit RST BPDUs for a MigrateTime period, to test whether all STP Bridges on the attached LAN have been removed and the Port can continue to transmit RSTP BPDUs46 Setting mcheck has no effect if the Bridge is operating in STP Compatibility mode46
Changing the value from true to false has no effect, but needs to be done if this behavior is to be triggered again by subsequently changing the value from false to true46

RSTP Status:

rstp_status : rstp_port_id: optional string
The port ID used in spanning tree advertisements for this port, as 4 hex digits46 Configuring the port ID is described in the rstp-port-num and rstp-port-priority keys of the other_config section earlier46
rstp_status : rstp_port_role: optional string, one of Backup, Designated, Alternate, Root, or Disabled
RSTP role of the port46
rstp_status : rstp_port_state: optional string, one of Disabled, Discarding, Forwarding, or Learning
RSTP state of the port46
rstp_status : rstp_designated_bridge_id: optional string
The port's RSTP designated bridge ID, in the same form as rstp_status:rstp_bridge_id in the Bridge table46
rstp_status : rstp_designated_port_id: optional string
The port's RSTP designated port ID, as 4 hex digits46
rstp_status : rstp_designated_path_cost: optional string, containing an integer
The port's RSTP designated path cost46 Lower is better46

RSTP Statistics:

rstp_statistics : rstp_tx_count: optional integer
Number of RSTP BPDUs transmitted through this port46
rstp_statistics : rstp_rx_count: optional integer
Number of valid RSTP BPDUs received by this port46
rstp_statistics : rstp_error_count: optional integer
Number of invalid RSTP BPDUs received by this port46
rstp_statistics : rstp_uptime: optional integer
The duration covered by the other RSTP statistics, in seconds46

Multicast Snooping:

other_config : mcast-snooping-flood: optional string, either true or false
If set to true, multicast packets (except Reports) are unconditionally forwarded to the specific port46
other_config : mcast-snooping-flood-reports: optional string, either true or false
If set to true, multicast Reports are unconditionally forwarded to the specific port46

Other Features:

qos: optional QoS
Quality of Service configuration for this port46
mac: optional string
The MAC address to use for this port for the purpose of choosing the bridge's MAC address46 This column does not necessarily reflect the port's actual MAC address, nor will setting it change the port's actual MAC address46
fake_bridge: boolean
Does this port represent a sub-bridge for its tagged VLAN within the Bridge? See ovs-vsctl(8) for more information46
external_ids : fake-bridge-id-*: optional string
External IDs for a fake bridge (see the fake_bridge column) are defined by prefixing a Bridge external_ids key with fake-bridge-, e46g46 fake-bridge-xs-network-uuids46
other_config : transient: optional string, either true or false
If set to true, the port will be removed when ovs-ctl start --delete-transient-ports is used46
bond_active_slave: optional string
For a bonded port, record the mac address of the current active slave46

Port Statistics: Key-value pairs that report port statistics46 The update period is controlled by other_config:stats-update-interval in the Open_vSwitch table46

Statistics: STP transmit and receive counters:

statistics : stp_tx_count: optional integer
Number of STP BPDUs sent on this port by the spanning tree library46
statistics : stp_rx_count: optional integer
Number of STP BPDUs received on this port and accepted by the spanning tree library46
statistics : stp_error_count: optional integer
Number of bad STP BPDUs received on this port46 Bad BPDUs include runt packets and those with an unexpected protocol ID46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

other_config: map of string-string pairs
external_ids: map of string-string pairs

Interface TABLE

An interface within a Port46

Summary:


Core Features:

name
immutable string (must be unique within table)
ifindex
optional integer, in range 0 to 4,294,967,295
mac_in_use
optional string
mac
optional string
error
optional string
OpenFlow Port Number:

ofport
optional integer
ofport_request
optional integer, in range 1 to 65,279

System-Specific Details:

type
string

Tunnel Options:

options : remote_ip
optional string
options : local_ip
optional string
options : in_key
optional string
options : out_key
optional string
options : key
optional string
options : tos
optional string
options : ttl
optional string
options : df_default
optional string, either true or false
Tunnel Options: vxlan only:

options : exts
optional string

Tunnel Options: gre, ipsec_gre, geneve, and vxlan:

options : csum
optional string, either true or false

Tunnel Options: ipsec_gre only:

options : peer_cert
optional string
options : certificate
optional string
options : private_key
optional string
options : psk
optional string

Patch Options:

options : peer
optional string

Interface Status:

admin_state
optional string, either down or up
link_state
optional string, either down or up
link_resets
optional integer
link_speed
optional integer
duplex
optional string, either full or half
mtu
optional integer
lacp_current
optional boolean
status
map of string-string pairs
status : driver_name
optional string
status : driver_version
optional string
status : firmware_version
optional string
status : source_ip
optional string
status : tunnel_egress_iface
optional string
status : tunnel_egress_iface_carrier
optional string, either down or up

Statistics:
Statistics: Successful transmit and receive counters:

statistics : rx_packets
optional integer
statistics : rx_bytes
optional integer
statistics : tx_packets
optional integer
statistics : tx_bytes
optional integer

Statistics: Receive errors:

statistics : rx_dropped
optional integer
statistics : rx_frame_err
optional integer
statistics : rx_over_err
optional integer
statistics : rx_crc_err
optional integer
statistics : rx_errors
optional integer

Statistics: Transmit errors:

statistics : tx_dropped
optional integer
statistics : collisions
optional integer
statistics : tx_errors
optional integer

Ingress Policing:

ingress_policing_rate
integer, at least 0
ingress_policing_burst
integer, at least 0

Bidirectional Forwarding Detection (BFD):
BFD Configuration:

bfd : enable
optional string, either true or false
bfd : min_rx
optional string, containing an integer, at least 1
bfd : min_tx
optional string, containing an integer, at least 1
bfd : decay_min_rx
optional string, containing an integer
bfd : forwarding_if_rx
optional string, either true or false
bfd : cpath_down
optional string, either true or false
bfd : check_tnl_key
optional string, either true or false
bfd : bfd_local_src_mac
optional string
bfd : bfd_local_dst_mac
optional string
bfd : bfd_remote_dst_mac
optional string
bfd : bfd_src_ip
optional string
bfd : bfd_dst_ip
optional string

BFD Status:

bfd_status : state
optional string, one of down, init, up, or admin_down
bfd_status : forwarding
optional string, either true or false
bfd_status : diagnostic
optional string
bfd_status : remote_state
optional string, one of down, init, up, or admin_down
bfd_status : remote_diagnostic
optional string
bfd_status : flap_count
optional string, containing an integer, at least 0

Connectivity Fault Management:

cfm_mpid
optional integer
cfm_flap_count
optional integer
cfm_fault
optional boolean
cfm_fault_status : recv
none
cfm_fault_status : rdi
none
cfm_fault_status : maid
none
cfm_fault_status : loopback
none
cfm_fault_status : overflow
none
cfm_fault_status : override
none
cfm_fault_status : interval
none
cfm_remote_opstate
optional string, either down or up
cfm_health
optional integer, in range 0 to 100
cfm_remote_mpids
set of integers
other_config : cfm_interval
optional string, containing an integer
other_config : cfm_extended
optional string, either true or false
other_config : cfm_demand
optional string, either true or false
other_config : cfm_opstate
optional string, either down or up
other_config : cfm_ccm_vlan
optional string, containing an integer, in range 1 to 4,095
other_config : cfm_ccm_pcp
optional string, containing an integer, in range 1 to 7

Bonding Configuration:

other_config : lacp-port-id
optional string, containing an integer, in range 1 to 65,535
other_config : lacp-port-priority
optional string, containing an integer, in range 1 to 65,535
other_config : lacp-aggregation-key
optional string, containing an integer, in range 1 to 65,535

Virtual Machine Identifiers:

external_ids : attached-mac
optional string
external_ids : iface-id
optional string
external_ids : iface-status
optional string, either active or inactive
external_ids : xs-vif-uuid
optional string
external_ids : xs-network-uuid
optional string
external_ids : vm-id
optional string
external_ids : xs-vm-uuid
optional string

VLAN Splinters:

other_config : enable-vlan-splinters
optional string, either true or false

Auto Attach Configuration:

lldp : enable
optional string, either true or false

Common Columns:

other_config
map of string-string pairs
external_ids
map of string-string pairs

Details:

Core Features:

name: immutable string (must be unique within table)
Interface name46 Should be alphanumeric and no more than about 8 bytes long46 May be the same as the port name, for non-bonded ports46 Must otherwise be unique among the names of ports, interfaces, and bridges on a host46
ifindex: optional integer, in range 0 to 4,294,967,295
A positive interface index as defined for SNMP MIB-II in RFCs 1213 and 2863, if the interface has one, otherwise 046 The ifindex is useful for seamless integration with protocols such as SNMP and sFlow46
mac_in_use: optional string
The MAC address in use by this interface46
mac: optional string
Ethernet address to set for this interface46 If unset then the default MAC address is used:
For the local interface, the default is the lowest-numbered MAC address among the other bridge ports, either the value of the mac in its Port record, if set, or its actual MAC (for bonded ports, the MAC of its slave whose name is first in alphabetical order)46 Internal ports and bridge ports that are used as port mirroring destinations (see the Mirror table) are ignored46
For other internal interfaces, the default MAC is randomly generated46
External interfaces typically have a MAC address associated with their hardware46
Some interfaces may not have a software-controllable MAC address46
error: optional string
If the configuration of the port failed, as indicated by -1 in ofport, Open vSwitch sets this column to an error description in human readable form46 Otherwise, Open vSwitch clears this column46

OpenFlow Port Number: When a client adds a new interface, Open vSwitch chooses an OpenFlow port number for the new port46 If the client that adds the port fills in ofport_request, then Open vSwitch tries to use its value as the OpenFlow port number46 Otherwise, or if the requested port number is already in use or cannot be used for another reason, Open vSwitch automatically assigns a free port number46 Regardless of how the port number was obtained, Open vSwitch then reports in ofport the port number actually assigned46

Open vSwitch limits the port numbers that it automatically assigns to the range 1 through 32,767, inclusive46 Controllers therefore have free use of ports 32,768 and up46

ofport: optional integer
OpenFlow port number for this interface46 Open vSwitch sets this column's value, so other clients should treat it as read-only46
The OpenFlow ``local'' port (OFPP_LOCAL) is 65,53446 The other valid port numbers are in the range 1 to 65,279, inclusive46 Value -1 indicates an error adding the interface46
ofport_request: optional integer, in range 1 to 65,279
Requested OpenFlow port number for this interface46
A client should ideally set this column's value in the same database transaction that it uses to create the interface46 Open vSwitch version 2461 and later will honor a later request for a specific port number, althuogh it might confuse some controllers: OpenFlow does not have a way to announce a port number change, so Open vSwitch represents it over OpenFlow as a port deletion followed immediately by a port addition46
If ofport_request is set or changed to some other port's automatically assigned port number, Open vSwitch chooses a new port number for the latter port46

System-Specific Details:

type: string
The interface type46 The types supported by a particular instance of Open vSwitch are listed in the iface_types column in the Open_vSwitch table46 The following types are defined:
system
An ordinary network device, e46g46 eth0 on Linux46 Sometimes referred to as ``external interfaces'' since they are generally connected to hardware external to that on which the Open vSwitch is running46 The empty string is a synonym for system46
internal
A simulated network device that sends and receives traffic46 An internal interface whose name is the same as its bridge's name is called the ``local interface46'' It does not make sense to bond an internal interface, so the terms ``port'' and ``interface'' are often used imprecisely for internal interfaces46
tap
A TUN/TAP device managed by Open vSwitch46
geneve
An Ethernet over Geneve (http://tools46ietf46org/html/draft-ietf-nvo3-geneve-00) IPv4 tunnel46 A description of how to match and set Geneve options can be found in the ovs-ofctl manual page46
gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4 tunnel46
ipsec_gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4 IPsec tunnel46
vxlan
An Ethernet tunnel over the UDP-based VXLAN protocol described in RFC 734846
Open vSwitch uses UDP destination port 478946 The source port used for VXLAN traffic varies on a per-flow basis and is in the ephemeral port range46
lisp
A layer 3 tunnel over the experimental, UDP-based Locator/ID Separation Protocol (RFC 6830)46
Only IPv4 and IPv6 packets are supported by the protocol, and they are sent and received without an Ethernet header46 Traffic to/from LISP ports is expected to be configured explicitly, and the ports are not intended to participate in learning based switching46 As such, they are always excluded from packet flooding46
stt
The Stateless TCP Tunnel (STT) is particularly useful when tunnel endpoints are in end-systems, as it utilizes the capabilities of standard network interface cards to improve performance46 STT utilizes a TCP-like header inside the IP header46 It is stateless, i46e46, there is no TCP connection state of any kind associated with the tunnel46 The TCP-like header is used to leverage the capabilities of existing network interface cards, but should not be interpreted as implying any sort of connection state between endpoints46 Since the STT protocol does not engage in the usual TCP 3-way handshake, so it will have difficulty traversing stateful firewalls46 The protocol is documented at http://www46ietf46org/archive/id/draft-davie-stt-0646txt All traffic uses a default destination port of 747146 STT is only available in kernel datapath on kernel 3465 or newer46
patch
A pair of virtual devices that act as a patch cable46
null
An ignored interface46 Deprecated and slated for removal in February 201346

Tunnel Options: These options apply to interfaces with type of geneve, gre, ipsec_gre, vxlan, lisp and stt46

Each tunnel must be uniquely identified by the combination of type, options:remote_ip, options:local_ip, and options:in_key46 If two ports are defined that are the same except one has an optional identifier and the other does not, the more specific one is matched first46 options:in_key is considered more specific than options:local_ip if a port defines one and another port defines the other46

options : remote_ip: optional string
Required46 The remote tunnel endpoint, one of:
An IPv4 address (not a DNS name), e46g46 192461684604612346 Only unicast endpoints are supported46
The word flow46 The tunnel accepts packets from any remote tunnel endpoint46 To process only packets from a specific remote tunnel endpoint, the flow entries may match on the tun_src field46 When sending packets to a remote_ip=flow tunnel, the flow actions must explicitly set the tun_dst field to the IP address of the desired remote tunnel endpoint, e46g46 with a set_field action46
The remote tunnel endpoint for any packet received from a tunnel is available in the tun_src field for matching in the flow table46
options : local_ip: optional string
Optional46 The tunnel destination IP that received packets must match46 Default is to match all addresses46 If specified, may be one of:
An IPv4 address (not a DNS name), e46g46 19246168461246346
The word flow46 The tunnel accepts packets sent to any of the local IP addresses of the system running OVS46 To process only packets sent to a specific IP address, the flow entries may match on the tun_dst field46 When sending packets to a local_ip=flow tunnel, the flow actions may explicitly set the tun_src field to the desired IP address, e46g46 with a set_field action46 However, while routing the tunneled packet out, the local system may override the specified address with the local IP address configured for the outgoing system interface46
This option is valid only for tunnels also configured with the remote_ip=flow option46
The tunnel destination IP address for any packet received from a tunnel is available in the tun_dst field for matching in the flow table46
options : in_key: optional string
Optional46 The key that received packets must contain, one of:
046 The tunnel receives packets with no key or with a key of 046 This is equivalent to specifying no options:in_key at all46
A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE) or 64-bit (for STT) number46 The tunnel receives only packets with the specified key46
The word flow46 The tunnel accepts packets with any key46 The key will be placed in the tun_id field for matching in the flow table46 The ovs-ofctl manual page contains additional information about matching fields in OpenFlow flows46
options : out_key: optional string
Optional46 The key to be set on outgoing packets, one of:
046 Packets sent through the tunnel will have no key46 This is equivalent to specifying no options:out_key at all46
A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or 64-bit (for STT) number46 Packets sent through the tunnel will have the specified key46
The word flow46 Packets sent through the tunnel will have the key set using the set_tunnel Nicira OpenFlow vendor extension (0 is used in the absence of an action)46 The ovs-ofctl manual page contains additional information about the Nicira OpenFlow vendor extensions46
options : key: optional string
Optional46 Shorthand to set in_key and out_key at the same time46
options : tos: optional string
Optional46 The value of the ToS bits to be set on the encapsulating packet46 ToS is interpreted as DSCP and ECN bits, ECN part must be zero46 It may also be the word inherit, in which case the ToS will be copied from the inner packet if it is IPv4 or IPv6 (otherwise it will be 0)46 The ECN fields are always inherited46 Default is 046
options : ttl: optional string
Optional46 The TTL to be set on the encapsulating packet46 It may also be the word inherit, in which case the TTL will be copied from the inner packet if it is IPv4 or IPv6 (otherwise it will be the system default, typically 64)46 Default is the system default TTL46
options : df_default: optional string, either true or false
Optional46 If enabled, the Don't Fragment bit will be set on tunnel outer headers to allow path MTU discovery46 Default is enabled; set to false to disable46

Tunnel Options: vxlan only:

options : exts: optional string
Optional46 Comma separated list of optional VXLAN extensions to enable46 The following extensions are supported:
gbp: VXLAN-GBP allows to transport the group policy context of a packet across the VXLAN tunnel to other network peers46 See the field description of tun_gbp_id and tun_gbp_flags in ovs-ofctl(8) for additional information46 (https://tools46ietf46org/html/draft-smith-vxlan-group-policy)

Tunnel Options: gre, ipsec_gre, geneve, and vxlan: gre, ipsec_gre, geneve, and vxlan interfaces support these options46

options : csum: optional string, either true or false
Optional46 Compute encapsulation header (either GRE or UDP) checksums on outgoing packets46 Default is disabled, set to true to enable46 Checksums present on incoming packets will be validated regardless of this setting46
When using the upstream Linux kernel module, computation of checksums for geneve and vxlan requires Linux kernel version 4460 or higher46 gre supports checksums for all versions of Open vSwitch that support GRE46 The out of tree kernel module distributed as part of OVS can compute all tunnel checksums on any kernel version that it is compatible with46
This option is supported for ipsec_gre, but not useful because GRE checksums are weaker than, and redundant with, IPsec payload authentication46

Tunnel Options: ipsec_gre only: Only ipsec_gre interfaces support these options46

options : peer_cert: optional string
Required for certificate authentication46 A string containing the peer's certificate in PEM format46 Additionally the host's certificate must be specified with the certificate option46
options : certificate: optional string
Required for certificate authentication46 The name of a PEM file containing a certificate that will be presented to the peer during authentication46
options : private_key: optional string
Optional for certificate authentication46 The name of a PEM file containing the private key associated with certificate46 If certificate contains the private key, this option may be omitted46
options : psk: optional string
Required for pre-shared key authentication46 Specifies a pre-shared key for authentication that must be identical on both sides of the tunnel46

Patch Options: Only patch interfaces support these options46

options : peer: optional string
The name of the Interface for the other side of the patch46 The named Interface's own peer option must specify this Interface's name46 That is, the two patch interfaces must have reversed name and peer values46

Interface Status: Status information about interfaces attached to bridges, updated every 5 seconds46 Not all interfaces have all of these properties; virtual interfaces don't have a link speed, for example46 Non-applicable columns will have empty values46

admin_state: optional string, either down or up
The administrative state of the physical network link46
link_state: optional string, either down or up
The observed state of the physical network link46 This is ordinarily the link's carrier status46 If the interface's Port is a bond configured for miimon monitoring, it is instead the network link's miimon status46
link_resets: optional integer
The number of times Open vSwitch has observed the link_state of this Interface change46
link_speed: optional integer
The negotiated speed of the physical network link46 Valid values are positive integers greater than 046
duplex: optional string, either full or half
The duplex mode of the physical network link46
mtu: optional integer
The MTU (maximum transmission unit); i46e46 the largest amount of data that can fit into a single Ethernet frame46 The standard Ethernet MTU is 1500 bytes46 Some physical media and many kinds of virtual interfaces can be configured with higher MTUs46
This column will be empty for an interface that does not have an MTU as, for example, some kinds of tunnels do not46
lacp_current: optional boolean
Boolean value indicating LACP status for this interface46 If true, this interface has current LACP information about its LACP partner46 This information may be used to monitor the health of interfaces in a LACP enabled port46 This column will be empty if LACP is not enabled46
status: map of string-string pairs
Key-value pairs that report port status46 Supported status values are type-dependent; some interfaces may not have a valid status:driver_name, for example46
status : driver_name: optional string
The name of the device driver controlling the network adapter46
status : driver_version: optional string
The version string of the device driver controlling the network adapter46
status : firmware_version: optional string
The version string of the network adapter's firmware, if available46
status : source_ip: optional string
The source IP address used for an IPv4 tunnel end-point, such as gre46
status : tunnel_egress_iface: optional string
Egress interface for tunnels46 Currently only relevant for tunnels on Linux systems, this column will show the name of the interface which is responsible for routing traffic destined for the configured options:remote_ip46 This could be an internal interface such as a bridge port46
status : tunnel_egress_iface_carrier: optional string, either down or up
Whether carrier is detected on status:tunnel_egress_iface46

Statistics: Key-value pairs that report interface statistics46 The current implementation updates these counters periodically46 The update period is controlled by other_config:stats-update-interval in the Open_vSwitch table46 Future implementations may update them when an interface is created, when they are queried (e46g46 using an OVSDB select operation), and just before an interface is deleted due to virtual interface hot-unplug or VM shutdown, and perhaps at other times, but not on any regular periodic basis46

These are the same statistics reported by OpenFlow in its struct ofp_port_stats structure46 If an interface does not support a given statistic, then that pair is omitted46

Statistics: Successful transmit and receive counters:

statistics : rx_packets: optional integer
Number of received packets46
statistics : rx_bytes: optional integer
Number of received bytes46
statistics : tx_packets: optional integer
Number of transmitted packets46
statistics : tx_bytes: optional integer
Number of transmitted bytes46

Statistics: Receive errors:

statistics : rx_dropped: optional integer
Number of packets dropped by RX46
statistics : rx_frame_err: optional integer
Number of frame alignment errors46
statistics : rx_over_err: optional integer
Number of packets with RX overrun46
statistics : rx_crc_err: optional integer
Number of CRC errors46
statistics : rx_errors: optional integer
Total number of receive errors, greater than or equal to the sum of the above46

Statistics: Transmit errors:

statistics : tx_dropped: optional integer
Number of packets dropped by TX46
statistics : collisions: optional integer
Number of collisions46
statistics : tx_errors: optional integer
Total number of transmit errors, greater than or equal to the sum of the above46

Ingress Policing: These settings control ingress policing for packets received on this interface46 On a physical interface, this limits the rate at which traffic is allowed into the system from the outside; on a virtual interface (one connected to a virtual machine), this limits the rate at which the VM is able to transmit46

Policing is a simple form of quality-of-service that simply drops packets received in excess of the configured rate46 Due to its simplicity, policing is usually less accurate and less effective than egress QoS (which is configured using the QoS and Queue tables)46

Policing is currently implemented only on Linux46 The Linux implementation uses a simple ``token bucket'' approach:

The size of the bucket corresponds to ingress_policing_burst46 Initially the bucket is full46
Whenever a packet is received, its size (converted to tokens) is compared to the number of tokens currently in the bucket46 If the required number of tokens are available, they are removed and the packet is forwarded46 Otherwise, the packet is dropped46
Whenever it is not full, the bucket is refilled with tokens at the rate specified by ingress_policing_rate46

Policing interacts badly with some network protocols, and especially with fragmented IP packets46 Suppose that there is enough network activity to keep the bucket nearly empty all the time46 Then this token bucket algorithm will forward a single packet every so often, with the period depending on packet size and on the configured rate46 All of the fragments of an IP packets are normally transmitted back-to-back, as a group46 In such a situation, therefore, only one of these fragments will be forwarded and the rest will be dropped46 IP does not provide any way for the intended recipient to ask for only the remaining fragments46 In such a case there are two likely possibilities for what will happen next: either all of the fragments will eventually be retransmitted (as TCP will do), in which case the same problem will recur, or the sender will not realize that its packet has been dropped and data will simply be lost (as some UDP-based protocols will do)46 Either way, it is possible that no forward progress will ever occur46

ingress_policing_rate: integer, at least 0
Maximum rate for data received on this interface, in kbps46 Data received faster than this rate is dropped46 Set to 0 (the default) to disable policing46
ingress_policing_burst: integer, at least 0
Maximum burst size for data received on this interface, in kb46 The default burst size if set to 0 is 1000 kb46 This value has no effect if ingress_policing_rate is 046
Specifying a larger burst size lets the algorithm be more forgiving, which is important for protocols like TCP that react severely to dropped packets46 The burst size should be at least the size of the interface's MTU46 Specifying a value that is numerically at least as large as 10% of ingress_policing_rate helps TCP come closer to achieving the full rate46

Bidirectional Forwarding Detection (BFD): BFD, defined in RFC 5880 and RFC 5881, allows point-to-point detection of connectivity failures by occasional transmission of BFD control messages46 Open vSwitch implements BFD to serve as a more popular and standards compliant alternative to CFM46

BFD operates by regularly transmitting BFD control messages at a rate negotiated independently in each direction46 Each endpoint specifies the rate at which it expects to receive control messages, and the rate at which it is willing to transmit them46 Open vSwitch uses a detection multiplier of three, meaning that an endpoint signals a connectivity fault if three consecutive BFD control messages fail to arrive46 In the case of a unidirectional connectivity issue, the system not receiving BFD control messages signals the problem to its peer in the messages it transmits46

The Open vSwitch implementation of BFD aims to comply faithfully with RFC 5880 requirements46 Open vSwitch does not implement the optional Authentication or ``Echo Mode'' features46

BFD Configuration: A controller sets up key-value pairs in the bfd column to enable and configure BFD46

bfd : enable: optional string, either true or false
True to enable BFD on this Interface46 If not specified, BFD will not be enabled by default46
bfd : min_rx: optional string, containing an integer, at least 1
The shortest interval, in milliseconds, at which this BFD session offers to receive BFD control messages46 The remote endpoint may choose to send messages at a slower rate46 Defaults to 100046
bfd : min_tx: optional string, containing an integer, at least 1
The shortest interval, in milliseconds, at which this BFD session is willing to transmit BFD control messages46 Messages will actually be transmitted at a slower rate if the remote endpoint is not willing to receive as quickly as specified46 Defaults to 10046
bfd : decay_min_rx: optional string, containing an integer
An alternate receive interval, in milliseconds, that must be greater than or equal to bfd:min_rx46 The implementation switches from bfd:min_rx to bfd:decay_min_rx when there is no obvious incoming data traffic at the interface, to reduce the CPU and bandwidth cost of monitoring an idle interface46 This feature may be disabled by setting a value of 046 This feature is reset whenever bfd:decay_min_rx or bfd:min_rx changes46
bfd : forwarding_if_rx: optional string, either true or false
When true, traffic received on the Interface is used to indicate the capability of packet I/O46 BFD control packets are still transmitted and received46 At least one BFD control packet must be received every 100 * bfd:min_rx amount of time46 Otherwise, even if traffic are received, the bfd:forwarding will be false46
bfd : cpath_down: optional string, either true or false
Set to true to notify the remote endpoint that traffic should not be forwarded to this system for some reason other than a connectivty failure on the interface being monitored46 The typical underlying reason is ``concatenated path down,'' that is, that connectivity beyond the local system is down46 Defaults to false46
bfd : check_tnl_key: optional string, either true or false
Set to true to make BFD accept only control messages with a tunnel key of zero46 By default, BFD accepts control messages with any tunnel key46
bfd : bfd_local_src_mac: optional string
Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the MAC used as source for transmitted BFD packets46 The default is the mac address of the BFD enabled interface46
bfd : bfd_local_dst_mac: optional string
Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the MAC used as destination for transmitted BFD packets46 The default is 00:23:20:00:00:0146
bfd : bfd_remote_dst_mac: optional string
Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the MAC used for checking the destination of received BFD packets46 Packets with different destination MAC will not be considered as BFD packets46 If not specified the destination MAC address of received BFD packets are not checked46
bfd : bfd_src_ip: optional string
Set to an IPv4 address to set the IP address used as source for transmitted BFD packets46 The default is 1694625446146146
bfd : bfd_dst_ip: optional string
Set to an IPv4 address to set the IP address used as destination for transmitted BFD packets46 The default is 1694625446146046

BFD Status: The switch sets key-value pairs in the bfd_status column to report the status of BFD on this interface46 When BFD is not enabled, with bfd:enable, the switch clears all key-value pairs from bfd_status46

bfd_status : state: optional string, one of down, init, up, or admin_down
Reports the state of the BFD session46 The BFD session is fully healthy and negotiated if UP46
bfd_status : forwarding: optional string, either true or false
Reports whether the BFD session believes this Interface may be used to forward traffic46 Typically this means the local session is signaling UP, and the remote system isn't signaling a problem such as concatenated path down46
bfd_status : diagnostic: optional string
A diagnostic code specifying the local system's reason for the last change in session state46 The error messages are defined in section 4461 of [RFC 5880]46
bfd_status : remote_state: optional string, one of down, init, up, or admin_down
Reports the state of the remote endpoint's BFD session46
bfd_status : remote_diagnostic: optional string
A diagnostic code specifying the remote system's reason for the last change in session state46 The error messages are defined in section 4461 of [RFC 5880]46
bfd_status : flap_count: optional string, containing an integer, at least 0
Counts the number of bfd_status:forwarding flaps since start46 A flap is considered as a change of the bfd_status:forwarding value46

Connectivity Fault Management: 802461ag Connectivity Fault Management (CFM) allows a group of Maintenance Points (MPs) called a Maintenance Association (MA) to detect connectivity problems with each other46 MPs within a MA should have complete and exclusive interconnectivity46 This is verified by occasionally broadcasting Continuity Check Messages (CCMs) at a configurable transmission interval46

According to the 802461ag specification, each Maintenance Point should be configured out-of-band with a list of Remote Maintenance Points it should have connectivity to46 Open vSwitch differs from the specification in this area46 It simply assumes the link is faulted if no Remote Maintenance Points are reachable, and considers it not faulted otherwise46

When operating over tunnels which have no in_key, or an in_key of flow46 CFM will only accept CCMs with a tunnel key of zero46

cfm_mpid: optional integer
A Maintenance Point ID (MPID) uniquely identifies each endpoint within a Maintenance Association46 The MPID is used to identify this endpoint to other Maintenance Points in the MA46 Each end of a link being monitored should have a different MPID46 Must be configured to enable CFM on this Interface46
According to the 802461ag specification, MPIDs can only range between [1, 8191]46 However, extended mode (see other_config:cfm_extended) supports eight byte MPIDs46
cfm_flap_count: optional integer
Counts the number of cfm fault flapps since boot46 A flap is considered to be a change of the cfm_fault value46
cfm_fault: optional boolean
Indicates a connectivity fault triggered by an inability to receive heartbeats from any remote endpoint46 When a fault is triggered on Interfaces participating in bonds, they will be disabled46
Faults can be triggered for several reasons46 Most importantly they are triggered when no CCMs are received for a period of 3465 times the transmission interval46 Faults are also triggered when any CCMs indicate that a Remote Maintenance Point is not receiving CCMs but able to send them46 Finally, a fault is triggered if a CCM is received which indicates unexpected configuration46 Notably, this case arises when a CCM is received which advertises the local MPID46
cfm_fault_status : recv: none
Indicates a CFM fault was triggered due to a lack of CCMs received on the Interface46
cfm_fault_status : rdi: none
Indicates a CFM fault was triggered due to the reception of a CCM with the RDI bit flagged46 Endpoints set the RDI bit in their CCMs when they are not receiving CCMs themselves46 This typically indicates a unidirectional connectivity failure46
cfm_fault_status : maid: none
Indicates a CFM fault was triggered due to the reception of a CCM with a MAID other than the one Open vSwitch uses46 CFM broadcasts are tagged with an identification number in addition to the MPID called the MAID46 Open vSwitch only supports receiving CCM broadcasts tagged with the MAID it uses internally46
cfm_fault_status : loopback: none
Indicates a CFM fault was triggered due to the reception of a CCM advertising the same MPID configured in the cfm_mpid column of this Interface46 This may indicate a loop in the network46
cfm_fault_status : overflow: none
Indicates a CFM fault was triggered because the CFM module received CCMs from more remote endpoints than it can keep track of46
cfm_fault_status : override: none
Indicates a CFM fault was manually triggered by an administrator using an ovs-appctl command46
cfm_fault_status : interval: none
Indicates a CFM fault was triggered due to the reception of a CCM frame having an invalid interval46
cfm_remote_opstate: optional string, either down or up
When in extended mode, indicates the operational state of the remote endpoint as either up or down46 See other_config:cfm_opstate46
cfm_health: optional integer, in range 0 to 100
Indicates the health of the interface as a percentage of CCM frames received over 21 other_config:cfm_intervals46 The health of an interface is undefined if it is communicating with more than one cfm_remote_mpids46 It reduces if healthy heartbeats are not received at the expected rate, and gradually improves as healthy heartbeats are received at the desired rate46 Every 21 other_config:cfm_intervals, the health of the interface is refreshed46
As mentioned above, the faults can be triggered for several reasons46 The link health will deteriorate even if heartbeats are received but they are reported to be unhealthy46 An unhealthy heartbeat in this context is a heartbeat for which either some fault is set or is out of sequence46 The interface health can be 100 only on receiving healthy heartbeats at the desired rate46
cfm_remote_mpids: set of integers
When CFM is properly configured, Open vSwitch will occasionally receive CCM broadcasts46 These broadcasts contain the MPID of the sending Maintenance Point46 The list of MPIDs from which this Interface is receiving broadcasts from is regularly collected and written to this column46
other_config : cfm_interval: optional string, containing an integer
The interval, in milliseconds, between transmissions of CFM heartbeats46 Three missed heartbeat receptions indicate a connectivity fault46
In standard operation only intervals of 3, 10, 100, 1,000, 10,000, 60,000, or 600,000 ms are supported46 Other values will be rounded down to the nearest value on the list46 Extended mode (see other_config:cfm_extended) supports any interval up to 65,535 ms46 In either mode, the default is 1000 ms46
We do not recommend using intervals less than 100 ms46
other_config : cfm_extended: optional string, either true or false
When true, the CFM module operates in extended mode46 This causes it to use a nonstandard destination address to avoid conflicting with compliant implementations which may be running concurrently on the network46 Furthermore, extended mode increases the accuracy of the cfm_interval configuration parameter by breaking wire compatibility with 802461ag compliant implementations46 And extended mode allows eight byte MPIDs46 Defaults to false46
other_config : cfm_demand: optional string, either true or false
When true, and other_config:cfm_extended is true, the CFM module operates in demand mode46 When in demand mode, traffic received on the Interface is used to indicate liveness46 CCMs are still transmitted and received46 At least one CCM must be received every 100 * other_config:cfm_interval amount of time46 Otherwise, even if traffic are received, the CFM module will raise the connectivity fault46
Demand mode has a couple of caveats:
To ensure that ovs-vswitchd has enough time to pull statistics from the datapath, the fault detection interval is set to 3465 * MAX(other_config:cfm_interval, 500) ms46
To avoid ambiguity, demand mode disables itself when there are multiple remote maintenance points46
If the Interface is heavily congested, CCMs containing the other_config:cfm_opstate status may be dropped causing changes in the operational state to be delayed46 Similarly, if CCMs containing the RDI bit are not received, unidirectional link failures may not be detected46
other_config : cfm_opstate: optional string, either down or up
When down, the CFM module marks all CCMs it generates as operationally down without triggering a fault46 This allows remote maintenance points to choose not to forward traffic to the Interface on which this CFM module is running46 Currently, in Open vSwitch, the opdown bit of CCMs affects Interfaces participating in bonds, and the bundle OpenFlow action46 This setting is ignored when CFM is not in extended mode46 Defaults to up46
other_config : cfm_ccm_vlan: optional string, containing an integer, in range 1 to 4,095
When set, the CFM module will apply a VLAN tag to all CCMs it generates with the given value46 May be the string random in which case each CCM will be tagged with a different randomly generated VLAN46
other_config : cfm_ccm_pcp: optional string, containing an integer, in range 1 to 7
When set, the CFM module will apply a VLAN tag to all CCMs it generates with the given PCP value, the VLAN ID of the tag is governed by the value of other_config:cfm_ccm_vlan46 If other_config:cfm_ccm_vlan is unset, a VLAN ID of zero is used46

Bonding Configuration:

other_config : lacp-port-id: optional string, containing an integer, in range 1 to 65,535
The LACP port ID of this Interface46 Port IDs are used in LACP negotiations to identify individual ports participating in a bond46
other_config : lacp-port-priority: optional string, containing an integer, in range 1 to 65,535
The LACP port priority of this Interface46 In LACP negotiations Interfaces with numerically lower priorities are preferred for aggregation46
other_config : lacp-aggregation-key: optional string, containing an integer, in range 1 to 65,535
The LACP aggregation key of this Interface46 Interfaces with different aggregation keys may not be active within a given Port at the same time46

Virtual Machine Identifiers: These key-value pairs specifically apply to an interface that represents a virtual Ethernet interface connected to a virtual machine46 These key-value pairs should not be present for other types of interfaces46 Keys whose names end in -uuid have values that uniquely identify the entity in question46 For a Citrix XenServer hypervisor, these values are UUIDs in RFC 4122 format46 Other hypervisors may use other formats46

external_ids : attached-mac: optional string
The MAC address programmed into the ``virtual hardware'' for this interface, in the form xx:xx:xx:xx:xx:xx46 For Citrix XenServer, this is the value of the MAC field in the VIF record for this interface46
external_ids : iface-id: optional string
A system-unique identifier for the interface46 On XenServer, this will commonly be the same as external_ids:xs-vif-uuid46
external_ids : iface-status: optional string, either active or inactive
Hypervisors may sometimes have more than one interface associated with a given external_ids:iface-id, only one of which is actually in use at a given time46 For example, in some circumstances XenServer has both a ``tap'' and a ``vif'' interface for a single external_ids:iface-id, but only uses one of them at a time46 A hypervisor that behaves this way must mark the currently in use interface active and the others inactive46 A hypervisor that never has more than one interface for a given external_ids:iface-id may mark that interface active or omit external_ids:iface-status entirely46
During VM migration, a given external_ids:iface-id might transiently be marked active on two different hypervisors46 That is, active means that this external_ids:iface-id is the active instance within a single hypervisor, not in a broader scope46 There is one exception: some hypervisors support ``migration'' from a given hypervisor to itself (most often for test purposes)46 During such a ``migration,'' two instances of a single external_ids:iface-id might both be briefly marked active on a single hypervisor46
external_ids : xs-vif-uuid: optional string
The virtual interface associated with this interface46
external_ids : xs-network-uuid: optional string
The virtual network to which this interface is attached46
external_ids : vm-id: optional string
The VM to which this interface belongs46 On XenServer, this will be the same as external_ids:xs-vm-uuid46
external_ids : xs-vm-uuid: optional string
The VM to which this interface belongs46

VLAN Splinters: The ``VLAN splinters'' feature increases Open vSwitch compatibility with buggy network drivers in old versions of Linux that do not properly support VLANs when VLAN devices are not used, at some cost in memory and performance46

When VLAN splinters are enabled on a particular interface, Open vSwitch creates a VLAN device for each in-use VLAN46 For sending traffic tagged with a VLAN on the interface, it substitutes the VLAN device46 Traffic received on the VLAN device is treated as if it had been received on the interface on the particular VLAN46

VLAN splinters consider a VLAN to be in use if:

The VLAN is the tag value in any Port record46
The VLAN is listed within the trunks column of the Port record of an interface on which VLAN splinters are enabled46 An empty trunks does not influence the in-use VLANs: creating 4,096 VLAN devices is impractical because it will exceed the current 1,024 port per datapath limit46
An OpenFlow flow within any bridge matches the VLAN46

The same set of in-use VLANs applies to every interface on which VLAN splinters are enabled46 That is, the set is not chosen separately for each interface but selected once as the union of all in-use VLANs based on the rules above46

It does not make sense to enable VLAN splinters on an interface for an access port, or on an interface that is not a physical port46

VLAN splinters are deprecated46 When broken device drivers are no longer in widespread use, we will delete this feature46

other_config : enable-vlan-splinters: optional string, either true or false
Set to true to enable VLAN splinters on this interface46 Defaults to false46
VLAN splinters increase kernel and userspace memory overhead, so do not use them unless they are needed46
VLAN splinters do not support 802461p priority tags46 Received priorities will appear to be 0, regardless of their actual values, and priorities on transmitted packets will also be cleared to 046

Auto Attach Configuration: Auto Attach configuration for a particular interface46

lldp : enable: optional string, either true or false
True to enable LLDP on this Interface46 If not specified, LLDP will be disabled by default46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

other_config: map of string-string pairs
external_ids: map of string-string pairs

Flow_Table TABLE

Configuration for a particular OpenFlow table46

Summary:


name
optional string
Eviction Policy:

flow_limit
optional integer, at least 0
overflow_policy
optional string, either refuse or evict
groups
set of strings

Classifier Optimization:

prefixes
set of up to 3 strings

Common Columns:

external_ids
map of string-string pairs

Details:

name: optional string
The table's name46 Set this column to change the name that controllers will receive when they request table statistics, e46g46 ovs-ofctl dump-tables46 The name does not affect switch behavior46

Eviction Policy: Open vSwitch supports limiting the number of flows that may be installed in a flow table, via the flow_limit column46 When adding a flow would exceed this limit, by default Open vSwitch reports an error, but there are two ways to configure Open vSwitch to instead delete (``evict'') a flow to make room for the new one:

Set the overflow_policy column to evict46
Send an OpenFlow 1464+ ``table mod request'' to enable eviction for the flow table (e46g46 ovs-ofctl -O OpenFlow14 mod-table br0 0 evict to enable eviction on flow table 0 of bridge br0)46

When a flow must be evicted due to overflow, the flow to evict is chosen through an approximation of the following algorithm46 This algorithm is used regardless of how eviction was enabled:

1.
Divide the flows in the table into groups based on the values of the fields or subfields specified in the groups column, so that all of the flows in a given group have the same values for those fields46 If a flow does not specify a given field, that field's value is treated as 046 If groups is empty, then all of the flows in the flow table are treated as a single group46
2.
Consider the flows in the largest group, that is, the group that contains the greatest number of flows46 If two or more groups all have the same largest number of flows, consider the flows in all of those groups46
3.
If the flows under consideration have different importance values, eliminate from consideration any flows except those with the lowest importance46 (``Importance,'' a 16-bit integer value attached to each flow, was introduced in OpenFlow 146446 Flows inserted with older versions of OpenFlow always have an importance of 046)
4.
Among the flows under consideration, choose the flow that expires soonest for eviction46

The eviction process only considers flows that have an idle timeout or a hard timeout46 That is, eviction never deletes permanent flows46 (Permanent flows do count against flow_limit46)

flow_limit: optional integer, at least 0
If set, limits the number of flows that may be added to the table46 Open vSwitch may limit the number of flows in a table for other reasons, e46g46 due to hardware limitations or for resource availability or performance reasons46
overflow_policy: optional string, either refuse or evict
Controls the switch's behavior when an OpenFlow flow table modification request would add flows in excess of flow_limit46 The supported values are:
refuse
Refuse to add the flow or flows46 This is also the default policy when overflow_policy is unset46
evict
Delete a flow chosen according to the algorithm described above46
groups: set of strings
When overflow_policy is evict, this controls how flows are chosen for eviction when the flow table would otherwise exceed flow_limit flows46 Its value is a set of NXM fields or sub-fields, each of which takes one of the forms field[] or field[start4646end], e46g46 NXM_OF_IN_PORT[]46 Please see nicira-ext46h for a complete list of NXM field names46
Open vSwitch ignores any invalid or unknown field specifications46
When eviction is not enabled, via overflow_policy or an OpenFlow 1464+ ``table mod,'' this column has no effect46

Classifier Optimization:

prefixes: set of up to 3 strings
This string set specifies which fields should be used for address prefix tracking46 Prefix tracking allows the classifier to skip rules with longer than necessary prefixes, resulting in better wildcarding for datapath flows46
Prefix tracking may be beneficial when a flow table contains matches on IP address fields with different prefix lengths46 For example, when a flow table contains IP address matches on both full addresses and proper prefixes, the full address matches will typically cause the datapath flow to un-wildcard the whole address field (depending on flow entry priorities)46 In this case each packet with a different address gets handed to the userspace for flow processing and generates its own datapath flow46 With prefix tracking enabled for the address field in question packets with addresses matching shorter prefixes would generate datapath flows where the irrelevant address bits are wildcarded, allowing the same datapath flow to handle all the packets within the prefix in question46 In this case many userspace upcalls can be avoided and the overall performance can be better46
This is a performance optimization only, so packets will receive the same treatment with or without prefix tracking46
The supported fields are: tun_id, tun_src, tun_dst, nw_src, nw_dst (or aliases ip_src and ip_dst), ipv6_src, and ipv6_dst46 (Using this feature for tun_id would only make sense if the tunnel IDs have prefix structure similar to IP addresses46)
By default, the prefixes=ip_dst,ip_src are used on each flow table46 This instructs the flow classifier to track the IP destination and source addresses used by the rules in this specific flow table46
The keyword none is recognized as an explicit override of the default values, causing no prefix fields to be tracked46
To set the prefix fields, the flow table record needs to exist:
ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0
Creates a flow table record for the OpenFlow table number 046
ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src
Enables prefix tracking for IP source and destination address fields46
There is a maximum number of fields that can be enabled for any one flow table46 Currently this limit is 346

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

QoS TABLE

Quality of Service (QoS) configuration for each Port that references it46

Summary:


type
string
queues
map of integer-Queue pairs, key in range 0 to 4,294,967,295
Configuration for linux-htb and linux-hfsc:

other_config : max-rate
optional string, containing an integer

Common Columns:

other_config
map of string-string pairs
external_ids
map of string-string pairs

Details:

type: string
The type of QoS to implement46 The currently defined types are listed below:
linux-htb
Linux ``hierarchy token bucket'' classifier46 See tc-htb(8) (also at http://linux46die46net/man/8/tc-htb) and the HTB manual (http://luxik46cdi46cz/~devik/qos/htb/manual/userg46htm) for information on how this classifier works and how to configure it46
linux-hfsc
Linux "Hierarchical Fair Service Curve" classifier46 See http://linux-ip46net/articles/hfsc46en/ for information on how this classifier works46
linux-sfq
Linux ``Stochastic Fairness Queueing'' classifier46 See tc-sfq(8) (also at http://linux46die46net/man/8/tc-sfq) for information on how this classifier works46
linux-codel
Linux ``Controlled Delay'' classifier46 See tc-codel(8) (also at http://man746org/linux/man-pages/man8/tc-codel46846html) for information on how this classifier works46
linux-fq_codel
Linux ``Fair Queuing with Controlled Delay'' classifier46 See tc-fq_codel(8) (also at http://man746org/linux/man-pages/man8/tc-fq_codel46846html) for information on how this classifier works46
queues: map of integer-Queue pairs, key in range 0 to 4,294,967,295
A map from queue numbers to Queue records46 The supported range of queue numbers depend on type46 The queue numbers are the same as the queue_id used in OpenFlow in struct ofp_action_enqueue and other structures46
Queue 0 is the ``default queue46'' It is used by OpenFlow output actions when no specific queue has been set46 When no configuration for queue 0 is present, it is automatically configured as if a Queue record with empty dscp and other_config columns had been specified46 (Before version 1466, Open vSwitch would leave queue 0 unconfigured in this case46 With some queuing disciplines, this dropped all packets destined for the default queue46)

Configuration for linux-htb and linux-hfsc: The linux-htb and linux-hfsc classes support the following key-value pair:

other_config : max-rate: optional string, containing an integer
Maximum rate shared by all queued traffic, in bit/s46 Optional46 If not specified, for physical interfaces, the default is the link rate46 For other interfaces or if the link rate cannot be determined, the default is currently 100 Mbps46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

other_config: map of string-string pairs
external_ids: map of string-string pairs

Queue TABLE

A configuration for a port output queue, used in configuring Quality of Service (QoS) features46 May be referenced by queues column in QoS table46

Summary:


dscp
optional integer, in range 0 to 63
Configuration for linux-htb QoS:

other_config : min-rate
optional string, containing an integer, at least 1
other_config : max-rate
optional string, containing an integer, at least 1
other_config : burst
optional string, containing an integer, at least 1
other_config : priority
optional string, containing an integer, in range 0 to 4,294,967,295

Configuration for linux-hfsc QoS:

other_config : min-rate
optional string, containing an integer, at least 1
other_config : max-rate
optional string, containing an integer, at least 1

Common Columns:

other_config
map of string-string pairs
external_ids
map of string-string pairs

Details:

dscp: optional integer, in range 0 to 63
If set, Open vSwitch will mark all traffic egressing this Queue with the given DSCP bits46 Traffic egressing the default Queue is only marked if it was explicitly selected as the Queue at the time the packet was output46 If unset, the DSCP bits of traffic egressing this Queue will remain unchanged46

Configuration for linux-htb QoS: QoS type linux-htb may use queue_ids less than 6144046 It has the following key-value pairs defined46

other_config : min-rate: optional string, containing an integer, at least 1
Minimum guaranteed bandwidth, in bit/s46
other_config : max-rate: optional string, containing an integer, at least 1
Maximum allowed bandwidth, in bit/s46 Optional46 If specified, the queue's rate will not be allowed to exceed the specified value, even if excess bandwidth is available46 If unspecified, defaults to no limit46
other_config : burst: optional string, containing an integer, at least 1
Burst size, in bits46 This is the maximum amount of ``credits'' that a queue can accumulate while it is idle46 Optional46 Details of the linux-htb implementation require a minimum burst size, so a too-small burst will be silently ignored46
other_config : priority: optional string, containing an integer, in range 0 to 4,294,967,295
A queue with a smaller priority will receive all the excess bandwidth that it can use before a queue with a larger value receives any46 Specific priority values are unimportant; only relative ordering matters46 Defaults to 0 if unspecified46

Configuration for linux-hfsc QoS: QoS type linux-hfsc may use queue_ids less than 6144046 It has the following key-value pairs defined46

other_config : min-rate: optional string, containing an integer, at least 1
Minimum guaranteed bandwidth, in bit/s46
other_config : max-rate: optional string, containing an integer, at least 1
Maximum allowed bandwidth, in bit/s46 Optional46 If specified, the queue's rate will not be allowed to exceed the specified value, even if excess bandwidth is available46 If unspecified, defaults to no limit46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

other_config: map of string-string pairs
external_ids: map of string-string pairs

Mirror TABLE

A port mirror within a Bridge46

A port mirror configures a bridge to send selected frames to special ``mirrored'' ports, in addition to their normal destinations46 Mirroring traffic may also be referred to as SPAN or RSPAN, depending on how the mirrored traffic is sent46

When a packet enters an Open vSwitch bridge, it becomes eligible for mirroring based on its ingress port and VLAN46 As the packet travels through the flow tables, each time it is output to a port, it becomes eligible for mirroring based on the egress port and VLAN46 In Open vSwitch 2465 and later, mirroring occurs just after a packet first becomes eligible, using the packet as it exists at that point; in Open vSwitch 2464 and earlier, mirroring occurs only after a packet has traversed all the flow tables, using the original packet as it entered the bridge46 This makes a difference only when the flow table modifies the packet: in Open vSwitch 2464, the modifications are never visible to mirrors, whereas in Open vSwitch 2465 and later modifications made before the first output that makes it eligible for mirroring to a particular destination are visible46

A packet that enters an Open vSwitch bridge is mirrored to a particular destination only once, even if it is eligible for multiple reasons46 For example, a packet would be mirrored to a particular output_port only once, even if it is selected for mirroring to that port by select_dst_port and select_src_port in the same or different Mirror records46

Summary:


name
string
Selecting Packets for Mirroring:

select_all
boolean
select_dst_port
set of weak reference to Ports
select_src_port
set of weak reference to Ports
select_vlan
set of up to 4,096 integers, in range 0 to 4,095

Mirroring Destination Configuration:

output_port
optional weak reference to Port
output_vlan
optional integer, in range 1 to 4,095

Statistics: Mirror counters:

statistics : tx_packets
optional integer
statistics : tx_bytes
optional integer

Common Columns:

external_ids
map of string-string pairs

Details:

name: string
Arbitrary identifier for the Mirror46

Selecting Packets for Mirroring: To be selected for mirroring, a given packet must enter or leave the bridge through a selected port and it must also be in one of the selected VLANs46

select_all: boolean
If true, every packet arriving or departing on any port is selected for mirroring46
select_dst_port: set of weak reference to Ports
Ports on which departing packets are selected for mirroring46
select_src_port: set of weak reference to Ports
Ports on which arriving packets are selected for mirroring46
select_vlan: set of up to 4,096 integers, in range 0 to 4,095
VLANs on which packets are selected for mirroring46 An empty set selects packets on all VLANs46

Mirroring Destination Configuration: These columns are mutually exclusive46 Exactly one of them must be nonempty46

output_port: optional weak reference to Port
Output port for selected packets, if nonempty46
Specifying a port for mirror output reserves that port exclusively for mirroring46 No frames other than those selected for mirroring via this column will be forwarded to the port, and any frames received on the port will be discarded46
The output port may be any kind of port supported by Open vSwitch46 It may be, for example, a physical port (sometimes called SPAN) or a GRE tunnel46
output_vlan: optional integer, in range 1 to 4,095
Output VLAN for selected packets, if nonempty46
The frames will be sent out all ports that trunk output_vlan, as well as any ports with implicit VLAN output_vlan46 When a mirrored frame is sent out a trunk port, the frame's VLAN tag will be set to output_vlan, replacing any existing tag; when it is sent out an implicit VLAN port, the frame will not be tagged46 This type of mirroring is sometimes called RSPAN46
See the documentation for other_config:forward-bpdu in the Interface table for a list of destination MAC addresses which will not be mirrored to a VLAN to avoid confusing switches that interpret the protocols that they represent46
Please note: Mirroring to a VLAN can disrupt a network that contains unmanaged switches46 Consider an unmanaged physical switch with two ports: port 1, connected to an end host, and port 2, connected to an Open vSwitch configured to mirror received packets into VLAN 123 on port 246 Suppose that the end host sends a packet on port 1 that the physical switch forwards to port 246 The Open vSwitch forwards this packet to its destination and then reflects it back on port 2 in VLAN 12346 This reflected packet causes the unmanaged physical switch to replace the MAC learning table entry, which correctly pointed to port 1, with one that incorrectly points to port 246 Afterward, the physical switch will direct packets destined for the end host to the Open vSwitch on port 2, instead of to the end host on port 1, disrupting connectivity46 If mirroring to a VLAN is desired in this scenario, then the physical switch must be replaced by one that learns Ethernet addresses on a per-VLAN basis46 In addition, learning should be disabled on the VLAN containing mirrored traffic46 If this is not done then intermediate switches will learn the MAC address of each end host from the mirrored traffic46 If packets being sent to that end host are also mirrored, then they will be dropped since the switch will attempt to send them out the input port46 Disabling learning for the VLAN will cause the switch to correctly send the packet out all ports configured for that VLAN46 If Open vSwitch is being used as an intermediate switch, learning can be disabled by adding the mirrored VLAN to flood_vlans in the appropriate Bridge table or tables46
Mirroring to a GRE tunnel has fewer caveats than mirroring to a VLAN and should generally be preferred46

Statistics: Mirror counters: Key-value pairs that report mirror statistics46 The update period is controlled by other_config:stats-update-interval in the Open_vSwitch table46

statistics : tx_packets: optional integer
Number of packets transmitted through this mirror46
statistics : tx_bytes: optional integer
Number of bytes transmitted through this mirror46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

Controller TABLE

An OpenFlow controller46

Open vSwitch supports two kinds of OpenFlow controllers:

Primary controllers
This is the kind of controller envisioned by the OpenFlow 1460 specification46 Usually, a primary controller implements a network policy by taking charge of the switch's flow table46
Open vSwitch initiates and maintains persistent connections to primary controllers, retrying the connection each time it fails or drops46 The fail_mode column in the Bridge table applies to primary controllers46
Open vSwitch permits a bridge to have any number of primary controllers46 When multiple controllers are configured, Open vSwitch connects to all of them simultaneously46 Because OpenFlow 1460 does not specify how multiple controllers coordinate in interacting with a single switch, more than one primary controller should be specified only if the controllers are themselves designed to coordinate with each other46 (The Nicira-defined NXT_ROLE OpenFlow vendor extension may be useful for this46)
Service controllers
These kinds of OpenFlow controller connections are intended for occasional support and maintenance use, e46g46 with ovs-ofctl46 Usually a service controller connects only briefly to inspect or modify some of a switch's state46
Open vSwitch listens for incoming connections from service controllers46 The service controllers initiate and, if necessary, maintain the connections from their end46 The fail_mode column in the Bridge table does not apply to service controllers46
Open vSwitch supports configuring any number of service controllers46

The target determines the type of controller46

Summary:


Core Features:

target
string
connection_mode
optional string, either in-band or out-of-band

Controller Failure Detection and Handling:

max_backoff
optional integer, at least 1,000
inactivity_probe
optional integer

Asynchronous Messages:

enable_async_messages
optional boolean
Controller Rate Limiting:

controller_rate_limit
optional integer, at least 100
controller_burst_limit
optional integer, at least 25
Controller Rate Limiting Statistics:

status : packet-in-TYPE-bypassed
optional string, containing an integer, at least 0
status : packet-in-TYPE-queued
optional string, containing an integer, at least 0
status : packet-in-TYPE-dropped
optional string, containing an integer, at least 0
status : packet-in-TYPE-backlog
optional string, containing an integer, at least 0

Additional In-Band Configuration:

local_ip
optional string
local_netmask
optional string
local_gateway
optional string

Controller Status:

is_connected
boolean
role
optional string, one of slave, other, or master
status : last_error
optional string
status : state
optional string, one of ACTIVE, VOID, CONNECTING, IDLE, or BACKOFF
status : sec_since_connect
optional string, containing an integer, at least 0
status : sec_since_disconnect
optional string, containing an integer, at least 1

Connection Parameters:

other_config : dscp
optional string, containing an integer

Common Columns:

external_ids
map of string-string pairs
other_config
map of string-string pairs

Details:

Core Features:

target: string
Connection method for controller46
The following connection methods are currently supported for primary controllers:
ssl:ip[:port]
The specified SSL port on the host at the given ip, which must be expressed as an IP address (not a DNS name)46 The ssl column in the Open_vSwitch table must point to a valid SSL configuration when this form is used46
If port is not specified, it defaults to 665346
SSL support is an optional feature that is not always built as part of Open vSwitch46
tcp:ip[:port]
The specified TCP port on the host at the given ip, which must be expressed as an IP address (not a DNS name), where ip can be IPv4 or IPv6 address46 If ip is an IPv6 address, wrap it in square brackets, e46g46 tcp:[::1]:665346
If port is not specified, it defaults to 665346
The following connection methods are currently supported for service controllers:
pssl:[port][:ip]
Listens for SSL connections on the specified TCP port46 If ip, which must be expressed as an IP address (not a DNS name), is specified, then connections are restricted to the specified local IP address (either IPv4 or IPv6)46 If ip is an IPv6 address, wrap it in square brackets, e46g46 pssl:6653:[::1]46
If port is not specified, it defaults to 665346 If ip is not specified then it listens only on IPv4 (but not IPv6) addresses46 The ssl column in the Open_vSwitch table must point to a valid SSL configuration when this form is used46
If port is not specified, it currently to 665346
SSL support is an optional feature that is not always built as part of Open vSwitch46
ptcp:[port][:ip]
Listens for connections on the specified TCP port46 If ip, which must be expressed as an IP address (not a DNS name), is specified, then connections are restricted to the specified local IP address (either IPv4 or IPv6)46 If ip is an IPv6 address, wrap it in square brackets, e46g46 ptcp:6653:[::1]46 If ip is not specified then it listens only on IPv4 addresses46
If port is not specified, it defaults to 665346
When multiple controllers are configured for a single bridge, the target values must be unique46 Duplicate target values yield unspecified results46
connection_mode: optional string, either in-band or out-of-band
If it is specified, this setting must be one of the following strings that describes how Open vSwitch contacts this OpenFlow controller over the network:
in-band
In this mode, this controller's OpenFlow traffic travels over the bridge associated with the controller46 With this setting, Open vSwitch allows traffic to and from the controller regardless of the contents of the OpenFlow flow table46 (Otherwise, Open vSwitch would never be able to connect to the controller, because it did not have a flow to enable it46) This is the most common connection mode because it is not necessary to maintain two independent networks46
out-of-band
In this mode, OpenFlow traffic uses a control network separate from the bridge associated with this controller, that is, the bridge does not use any of its own network devices to communicate with the controller46 The control network must be configured separately, before or after ovs-vswitchd is started46
If not specified, the default is implementation-specific46

Controller Failure Detection and Handling:

max_backoff: optional integer, at least 1,000
Maximum number of milliseconds to wait between connection attempts46 Default is implementation-specific46
inactivity_probe: optional integer
Maximum number of milliseconds of idle time on connection to controller before sending an inactivity probe message46 If Open vSwitch does not communicate with the controller for the specified number of seconds, it will send a probe46 If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect46 Default is implementation-specific46 A value of 0 disables inactivity probes46

Asynchronous Messages: OpenFlow switches send certain messages to controllers spontanenously, that is, not in response to any request from the controller46 These messages are called ``asynchronous messages46'' These columns allow asynchronous messages to be limited or disabled to ensure the best use of network resources46

enable_async_messages: optional boolean
The OpenFlow protocol enables asynchronous messages at time of connection establishment, which means that a controller can receive asynchronous messages, potentially many of them, even if it turns them off immediately after connecting46 Set this column to false to change Open vSwitch behavior to disable, by default, all asynchronous messages46 The controller can use the NXT_SET_ASYNC_CONFIG Nicira extension to OpenFlow to turn on any messages that it does want to receive, if any46

Controller Rate Limiting: A switch can forward packets to a controller over the OpenFlow protocol46 Forwarding packets this way at too high a rate can overwhelm a controller, frustrate use of the OpenFlow connection for other purposes, increase the latency of flow setup, and use an unreasonable amount of bandwidth46 Therefore, Open vSwitch supports limiting the rate of packet forwarding to a controller46

There are two main reasons in OpenFlow for a packet to be sent to a controller: either the packet ``misses'' in the flow table, that is, there is no matching flow, or a flow table action says to send the packet to the controller46 Open vSwitch limits the rate of each kind of packet separately at the configured rate46 Therefore, the actual rate that packets are sent to the controller can be up to twice the configured rate, when packets are sent for both reasons46

This feature is specific to forwarding packets over an OpenFlow connection46 It is not general-purpose QoS46 See the QoS table for quality of service configuration, and ingress_policing_rate in the Interface table for ingress policing configuration46

controller_rate_limit: optional integer, at least 100
The maximum rate at which the switch will forward packets to the OpenFlow controller, in packets per second46 If no value is specified, rate limiting is disabled46
controller_burst_limit: optional integer, at least 25
When a high rate triggers rate-limiting, Open vSwitch queues packets to the controller for each port and transmits them to the controller at the configured rate46 This value limits the number of queued packets46 Ports on a bridge share the packet queue fairly46
This value has no effect unless controller_rate_limit is configured46 The current default when this value is not specified is one-quarter of controller_rate_limit, meaning that queuing can delay forwarding a packet to the controller by up to 250 ms46

Controller Rate Limiting Statistics: These values report the effects of rate limiting46 Their values are relative to establishment of the most recent OpenFlow connection, or since rate limiting was enabled, whichever happened more recently46 Each consists of two values, one with TYPE replaced by miss for rate limiting flow table misses, and the other with TYPE replaced by action for rate limiting packets sent by OpenFlow actions46

These statistics are reported only when controller rate limiting is enabled46

status : packet-in-TYPE-bypassed: optional string, containing an integer, at least 0
Number of packets sent directly to the controller, without queuing, because the rate did not exceed the configured maximum46
status : packet-in-TYPE-queued: optional string, containing an integer, at least 0
Number of packets added to the queue to send later46
status : packet-in-TYPE-dropped: optional string, containing an integer, at least 0
Number of packets added to the queue that were later dropped due to overflow46 This value is less than or equal to status:packet-in-TYPE-queued46
status : packet-in-TYPE-backlog: optional string, containing an integer, at least 0
Number of packets currently queued46 The other statistics increase monotonically, but this one fluctuates between 0 and the controller_burst_limit as conditions change46

Additional In-Band Configuration: These values are considered only in in-band control mode (see connection_mode)46

When multiple controllers are configured on a single bridge, there should be only one set of unique values in these columns46 If different values are set for these columns in different controllers, the effect is unspecified46

local_ip: optional string
The IP address to configure on the local port, e46g46 192461684604612346 If this value is unset, then local_netmask and local_gateway are ignored46
local_netmask: optional string
The IP netmask to configure on the local port, e46g46 255462554625546046 If local_ip is set but this value is unset, then the default is chosen based on whether the IP address is class A, B, or C46
local_gateway: optional string
The IP address of the gateway to configure on the local port, as a string, e46g46 1924616846046146 Leave this column unset if this network has no gateway46

Controller Status:

is_connected: boolean
true if currently connected to this controller, false otherwise46
role: optional string, one of slave, other, or master
The level of authority this controller has on the associated bridge46 Possible values are:
other
Allows the controller access to all OpenFlow features46
master
Equivalent to other, except that there may be at most one master controller at a time46 When a controller configures itself as master, any existing master is demoted to the slave role46
slave
Allows the controller read-only access to OpenFlow features46 Attempts to modify the flow table will be rejected with an error46 Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS messages46
status : last_error: optional string
A human-readable description of the last error on the connection to the controller; i46e46 strerror(errno)46 This key will exist only if an error has occurred46
status : state: optional string, one of ACTIVE, VOID, CONNECTING, IDLE, or BACKOFF
The state of the connection to the controller:
VOID
Connection is disabled46
BACKOFF
Attempting to reconnect at an increasing period46
CONNECTING
Attempting to connect46
ACTIVE
Connected, remote host responsive46
IDLE
Connection is idle46 Waiting for response to keep-alive46
These values may change in the future46 They are provided only for human consumption46
status : sec_since_connect: optional string, containing an integer, at least 0
The amount of time since this controller last successfully connected to the switch (in seconds)46 Value is empty if controller has never successfully connected46
status : sec_since_disconnect: optional string, containing an integer, at least 1
The amount of time since this controller last disconnected from the switch (in seconds)46 Value is empty if controller has never disconnected46

Connection Parameters: Additional configuration for a connection between the controller and the Open vSwitch46

other_config : dscp: optional string, containing an integer
The Differentiated Service Code Point (DSCP) is specified using 6 bits in the Type of Service (TOS) field in the IP header46 DSCP provides a mechanism to classify the network traffic and provide Quality of Service (QoS) on IP networks46 The DSCP value specified here is used when establishing the connection between the controller and the Open vSwitch46 If no value is specified, a default value of 48 is chosen46 Valid DSCP values must be in the range 0 to 6346

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs
other_config: map of string-string pairs

Manager TABLE

Configuration for a database connection to an Open vSwitch database (OVSDB) client46

This table primarily configures the Open vSwitch database (ovsdb-server), not the Open vSwitch switch (ovs-vswitchd)46 The switch does read the table to determine what connections should be treated as in-band46

The Open vSwitch database server can initiate and maintain active connections to remote clients46 It can also listen for database connections46

Summary:


Core Features:

target
string (must be unique within table)
connection_mode
optional string, either in-band or out-of-band

Client Failure Detection and Handling:

max_backoff
optional integer, at least 1,000
inactivity_probe
optional integer

Status:

is_connected
boolean
status : last_error
optional string
status : state
optional string, one of ACTIVE, VOID, CONNECTING, IDLE, or BACKOFF
status : sec_since_connect
optional string, containing an integer, at least 0
status : sec_since_disconnect
optional string, containing an integer, at least 0
status : locks_held
optional string
status : locks_waiting
optional string
status : locks_lost
optional string
status : n_connections
optional string, containing an integer, at least 2
status : bound_port
optional string, containing an integer

Connection Parameters:

other_config : dscp
optional string, containing an integer

Common Columns:

external_ids
map of string-string pairs
other_config
map of string-string pairs

Details:

Core Features:

target: string (must be unique within table)
Connection method for managers46
The following connection methods are currently supported:
ssl:ip[:port]
The specified SSL port on the host at the given ip, which must be expressed as an IP address (not a DNS name)46 The ssl column in the Open_vSwitch table must point to a valid SSL configuration when this form is used46
If port is not specified, it defaults to 664046
SSL support is an optional feature that is not always built as part of Open vSwitch46
tcp:ip[:port]
The specified TCP port on the host at the given ip, which must be expressed as an IP address (not a DNS name), where ip can be IPv4 or IPv6 address46 If ip is an IPv6 address, wrap it in square brackets, e46g46 tcp:[::1]:664046
If port is not specified, it defaults to 664046
pssl:[port][:ip]
Listens for SSL connections on the specified TCP port46 Specify 0 for port to have the kernel automatically choose an available port46 If ip, which must be expressed as an IP address (not a DNS name), is specified, then connections are restricted to the specified local IP address (either IPv4 or IPv6 address)46 If ip is an IPv6 address, wrap in square brackets, e46g46 pssl:6640:[::1]46 If ip is not specified then it listens only on IPv4 (but not IPv6) addresses46 The ssl column in the Open_vSwitch table must point to a valid SSL configuration when this form is used46
If port is not specified, it defaults to 664046
SSL support is an optional feature that is not always built as part of Open vSwitch46
ptcp:[port][:ip]
Listens for connections on the specified TCP port46 Specify 0 for port to have the kernel automatically choose an available port46 If ip, which must be expressed as an IP address (not a DNS name), is specified, then connections are restricted to the specified local IP address (either IPv4 or IPv6 address)46 If ip is an IPv6 address, wrap it in square brackets, e46g46 ptcp:6640:[::1]46 If ip is not specified then it listens only on IPv4 addresses46
If port is not specified, it defaults to 664046
When multiple managers are configured, the target values must be unique46 Duplicate target values yield unspecified results46
connection_mode: optional string, either in-band or out-of-band
If it is specified, this setting must be one of the following strings that describes how Open vSwitch contacts this OVSDB client over the network:
in-band
In this mode, this connection's traffic travels over a bridge managed by Open vSwitch46 With this setting, Open vSwitch allows traffic to and from the client regardless of the contents of the OpenFlow flow table46 (Otherwise, Open vSwitch would never be able to connect to the client, because it did not have a flow to enable it46) This is the most common connection mode because it is not necessary to maintain two independent networks46
out-of-band
In this mode, the client's traffic uses a control network separate from that managed by Open vSwitch, that is, Open vSwitch does not use any of its own network devices to communicate with the client46 The control network must be configured separately, before or after ovs-vswitchd is started46
If not specified, the default is implementation-specific46

Client Failure Detection and Handling:

max_backoff: optional integer, at least 1,000
Maximum number of milliseconds to wait between connection attempts46 Default is implementation-specific46
inactivity_probe: optional integer
Maximum number of milliseconds of idle time on connection to the client before sending an inactivity probe message46 If Open vSwitch does not communicate with the client for the specified number of seconds, it will send a probe46 If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect46 Default is implementation-specific46 A value of 0 disables inactivity probes46

Status:

is_connected: boolean
true if currently connected to this manager, false otherwise46
status : last_error: optional string
A human-readable description of the last error on the connection to the manager; i46e46 strerror(errno)46 This key will exist only if an error has occurred46
status : state: optional string, one of ACTIVE, VOID, CONNECTING, IDLE, or BACKOFF
The state of the connection to the manager:
VOID
Connection is disabled46
BACKOFF
Attempting to reconnect at an increasing period46
CONNECTING
Attempting to connect46
ACTIVE
Connected, remote host responsive46
IDLE
Connection is idle46 Waiting for response to keep-alive46
These values may change in the future46 They are provided only for human consumption46
status : sec_since_connect: optional string, containing an integer, at least 0
The amount of time since this manager last successfully connected to the database (in seconds)46 Value is empty if manager has never successfully connected46
status : sec_since_disconnect: optional string, containing an integer, at least 0
The amount of time since this manager last disconnected from the database (in seconds)46 Value is empty if manager has never disconnected46
status : locks_held: optional string
Space-separated list of the names of OVSDB locks that the connection holds46 Omitted if the connection does not hold any locks46
status : locks_waiting: optional string
Space-separated list of the names of OVSDB locks that the connection is currently waiting to acquire46 Omitted if the connection is not waiting for any locks46
status : locks_lost: optional string
Space-separated list of the names of OVSDB locks that the connection has had stolen by another OVSDB client46 Omitted if no locks have been stolen from this connection46
status : n_connections: optional string, containing an integer, at least 2
When target specifies a connection method that listens for inbound connections (e46g46 ptcp: or pssl:) and more than one connection is actually active, the value is the number of active connections46 Otherwise, this key-value pair is omitted46
When multiple connections are active, status columns and key-value pairs (other than this one) report the status of one arbitrarily chosen connection46
status : bound_port: optional string, containing an integer
When target is ptcp: or pssl:, this is the TCP port on which the OVSDB server is listening46 (This is is particularly useful when target specifies a port of 0, allowing the kernel to choose any available port46)

Connection Parameters: Additional configuration for a connection between the manager and the Open vSwitch Database46

other_config : dscp: optional string, containing an integer
The Differentiated Service Code Point (DSCP) is specified using 6 bits in the Type of Service (TOS) field in the IP header46 DSCP provides a mechanism to classify the network traffic and provide Quality of Service (QoS) on IP networks46 The DSCP value specified here is used when establishing the connection between the manager and the Open vSwitch46 If no value is specified, a default value of 48 is chosen46 Valid DSCP values must be in the range 0 to 6346

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs
other_config: map of string-string pairs

NetFlow TABLE

A NetFlow target46 NetFlow is a protocol that exports a number of details about terminating IP flows, such as the principals involved and duration46

Summary:


targets
set of 1 or more strings
engine_id
optional integer, in range 0 to 255
engine_type
optional integer, in range 0 to 255
active_timeout
integer, at least -1
add_id_to_interface
boolean
Common Columns:

external_ids
map of string-string pairs

Details:

targets: set of 1 or more strings
NetFlow targets in the form ip:port46 The ip must be specified numerically, not as a DNS name46
engine_id: optional integer, in range 0 to 255
Engine ID to use in NetFlow messages46 Defaults to datapath index if not specified46
engine_type: optional integer, in range 0 to 255
Engine type to use in NetFlow messages46 Defaults to datapath index if not specified46
active_timeout: integer, at least -1
The interval at which NetFlow records are sent for flows that are still active, in seconds46 A value of 0 requests the default timeout (currently 600 seconds); a value of -1 disables active timeouts46
The NetFlow passive timeout, for flows that become inactive, is not configurable46 It will vary depending on the Open vSwitch version, the forms and contents of the OpenFlow flow tables, CPU and memory usage, and network activity46 A typical passive timeout is about a second46
add_id_to_interface: boolean
If this column's value is false, the ingress and egress interface fields of NetFlow flow records are derived from OpenFlow port numbers46 When it is true, the 7 most significant bits of these fields will be replaced by the least significant 7 bits of the engine id46 This is useful because many NetFlow collectors do not expect multiple switches to be sending messages from the same host, so they do not store the engine information which could be used to disambiguate the traffic46
When this option is enabled, a maximum of 508 ports are supported46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

SSL TABLE

SSL configuration for an Open_vSwitch46

Summary:


private_key
string
certificate
string
ca_cert
string
bootstrap_ca_cert
boolean
Common Columns:

external_ids
map of string-string pairs

Details:

private_key: string
Name of a PEM file containing the private key used as the switch's identity for SSL connections to the controller46
certificate: 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's private key, identifying a trustworthy switch46
ca_cert: string
Name of a PEM file containing the CA certificate used to verify that the switch is connected to a trustworthy controller46
bootstrap_ca_cert: boolean
If set to true, 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 file46 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 obtained46 This option exposes the SSL connection to a man-in-the-middle attack obtaining the initial CA certificate46 It may still be useful for bootstrapping46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

sFlow TABLE

A set of sFlow(R) targets46 sFlow is a protocol for remote monitoring of switches46

Summary:


agent
optional string
header
optional integer
polling
optional integer
sampling
optional integer
targets
set of 1 or more strings
Common Columns:

external_ids
map of string-string pairs

Details:

agent: optional string
Name of the network device whose IP address should be reported as the ``agent address'' to collectors46 If not specified, the agent device is figured from the first target address and the routing table46 If the routing table does not contain a route to the target, the IP address defaults to the local_ip in the collector's Controller46 If an agent IP address cannot be determined any of these ways, sFlow is disabled46
header: optional integer
Number of bytes of a sampled packet to send to the collector46 If not specified, the default is 128 bytes46
polling: optional integer
Polling rate in seconds to send port statistics to the collector46 If not specified, defaults to 30 seconds46
sampling: optional integer
Rate at which packets should be sampled and sent to the collector46 If not specified, defaults to 400, which means one out of 400 packets, on average, will be sent to the collector46
targets: set of 1 or more strings
sFlow targets in the form ip:port46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

IPFIX TABLE

Configuration for sending packets to IPFIX collectors46

IPFIX is a protocol that exports a number of details about flows46 The IPFIX implementation in Open vSwitch samples packets at a configurable rate, extracts flow information from those packets, optionally caches and aggregates the flow information, and sends the result to one or more collectors46

IPFIX in Open vSwitch can be configured two different ways:

With per-bridge sampling, Open vSwitch performs IPFIX sampling automatically on all packets that pass through a bridge46 To configure per-bridge sampling, create an IPFIX record and point a Bridge table's ipfix column to it46 The Flow_Sample_Collector_Set table is not used for per-bridge sampling46
With flow-based sampling, sample actions in the OpenFlow flow table drive IPFIX sampling46 See ovs-ofctl(8) for a description of the sample action46
Flow-based sampling also requires database configuration: create a IPFIX record that describes the IPFIX configuration and a Flow_Sample_Collector_Set record that points to the Bridge whose flow table holds the sample actions and to IPFIX record46 The ipfix in the Bridge table is not used for flow-based sampling46

Summary:


targets
set of strings
cache_active_timeout
optional integer, in range 0 to 4,200
cache_max_flows
optional integer, in range 0 to 4,294,967,295
Per-Bridge Sampling:

sampling
optional integer, in range 1 to 4,294,967,295
obs_domain_id
optional integer, in range 0 to 4,294,967,295
obs_point_id
optional integer, in range 0 to 4,294,967,295
other_config : enable-tunnel-sampling
optional string, either true or false
other_config : enable-input-sampling
optional string, either true or false
other_config : enable-output-sampling
optional string, either true or false

Common Columns:

external_ids
map of string-string pairs

Details:

targets: set of strings
IPFIX target collectors in the form ip:port46
cache_active_timeout: optional integer, in range 0 to 4,200
The maximum period in seconds for which an IPFIX flow record is cached and aggregated before being sent46 If not specified, defaults to 046 If 0, caching is disabled46
cache_max_flows: optional integer, in range 0 to 4,294,967,295
The maximum number of IPFIX flow records that can be cached at a time46 If not specified, defaults to 046 If 0, caching is disabled46

Per-Bridge Sampling: These values affect only per-bridge sampling46 See above for a description of the differences between per-bridge and flow-based sampling46

sampling: optional integer, in range 1 to 4,294,967,295
The rate at which packets should be sampled and sent to each target collector46 If not specified, defaults to 400, which means one out of 400 packets, on average, will be sent to each target collector46
obs_domain_id: optional integer, in range 0 to 4,294,967,295
The IPFIX Observation Domain ID sent in each IPFIX packet46 If not specified, defaults to 046
obs_point_id: optional integer, in range 0 to 4,294,967,295
The IPFIX Observation Point ID sent in each IPFIX flow record46 If not specified, defaults to 046
other_config : enable-tunnel-sampling: optional string, either true or false
Set to true to enable sampling and reporting tunnel header 7-tuples in IPFIX flow records46 Tunnel sampling is disabled by default46
The following enterprise entities report the sampled tunnel info:
tunnelType:
ID: 891, and enterprise ID 6876 (VMware)46
type: unsigned 8-bit integer46
data type semantics: identifier46
description: Identifier of the layer 2 network overlay network encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE, 0x07 GENEVE46
tunnelKey:
ID: 892, and enterprise ID 6876 (VMware)46
type: variable-length octetarray46
data type semantics: identifier46
description: Key which is used for identifying an individual traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI), GRE (32-bit key), or LISP (24-bit instance ID) tunnel46 The key is encoded in this octetarray as a 3-, 4-, or 8-byte integer ID in network byte order46
tunnelSourceIPv4Address:
ID: 893, and enterprise ID 6876 (VMware)46
type: unsigned 32-bit integer46
data type semantics: identifier46
description: The IPv4 source address in the tunnel IP packet header46
tunnelDestinationIPv4Address:
ID: 894, and enterprise ID 6876 (VMware)46
type: unsigned 32-bit integer46
data type semantics: identifier46
description: The IPv4 destination address in the tunnel IP packet header46
tunnelProtocolIdentifier:
ID: 895, and enterprise ID 6876 (VMware)46
type: unsigned 8-bit integer46
data type semantics: identifier46
description: The value of the protocol number in the tunnel IP packet header46 The protocol number identifies the tunnel IP packet payload type46
tunnelSourceTransportPort:
ID: 896, and enterprise ID 6876 (VMware)46
type: unsigned 16-bit integer46
data type semantics: identifier46
description: The source port identifier in the tunnel transport header46 For the transport protocols UDP, TCP, and SCTP, this is the source port number given in the respective header46
tunnelDestinationTransportPort:
ID: 897, and enterprise ID 6876 (VMware)46
type: unsigned 16-bit integer46
data type semantics: identifier46
description: The destination port identifier in the tunnel transport header46 For the transport protocols UDP, TCP, and SCTP, this is the destination port number given in the respective header46
other_config : enable-input-sampling: optional string, either true or false
By default, Open vSwitch samples and reports flows at bridge port input in IPFIX flow records46 Set this column to false to disable input sampling46
other_config : enable-output-sampling: optional string, either true or false
By default, Open vSwitch samples and reports flows at bridge port output in IPFIX flow records46 Set this column to false to disable output sampling46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

Flow_Sample_Collector_Set TABLE

A set of IPFIX collectors of packet samples generated by OpenFlow sample actions46 This table is used only for IPFIX flow-based sampling, not for per-bridge sampling (see the IPFIX table for a description of the two forms)46

Summary:


id
integer, in range 0 to 4,294,967,295
bridge Bridge
ipfix
optional IPFIX
Common Columns:

external_ids
map of string-string pairs

Details:

id: integer, in range 0 to 4,294,967,295
The ID of this collector set, unique among the bridge's collector sets, to be used as the collector_set_id in OpenFlow sample actions46
bridge: Bridge
The bridge into which OpenFlow sample actions can be added to send packet samples to this set of IPFIX collectors46
ipfix: optional IPFIX
Configuration of the set of IPFIX collectors to send one flow record per sampled packet to46

Common Columns: The overall purpose of these columns is described under Common Columns at the beginning of this document46

external_ids: map of string-string pairs

AutoAttach TABLE

Auto Attach configuration within a bridge46 The IETF Auto-Attach SPBM draft standard describes a compact method of using IEEE 802461AB Link Layer Discovery Protocol (LLDP) together with a IEEE 802461aq Shortest Path Bridging (SPB) network to automatically attach network devices to individual services in a SPB network46 The intent here is to allow network applications and devices using OVS to be able to easily take advantage of features offered by industry standard SPB networks46

Auto Attach (AA) uses LLDP to communicate between a directly connected Auto Attach Client (AAC) and Auto Attach Server (AAS)46 The LLDP protocol is extended to add two new Type-Length-Value tuples (TLVs)46 The first new TLV supports the ongoing discovery of directly connected AA correspondents46 Auto Attach operates by regularly transmitting AA discovery TLVs between the AA client and AA server46 By exchanging these discovery messages, both the AAC and AAS learn the system name and system description of their peer46 In the OVS context, OVS operates as the AA client and the AA server resides on a switch at the edge of the SPB network46

Once AA discovery has been completed the AAC then uses the second new TLV to deliver identifier mappings from the AAC to the AAS46 A primary feature of Auto Attach is to facilitate the mapping of VLANs defined outside the SPB network onto service ids (ISIDs) defined within the SPM network46 By doing so individual external VLANs can be mapped onto specific SPB network services46 These VLAN id to ISID mappings can be configured and managed locally using new options added to the ovs-vsctl command46

The Auto Attach OVS feature does not provide a full implementation of the LLDP protocol46 Support for the mandatory TLVs as defined by the LLDP standard and support for the AA TLV extensions is provided46 LLDP protocol support in OVS can be enabled or disabled on a port by port basis46 LLDP support is disabled by default46

Summary:


system_name
string
system_description
string
mappings
map of integer-integer pairs, key in range 0 to 16,777,215, value in range 0 to 4,095

Details:

system_name: string
The system_name string is exported in LLDP messages46 It should uniquely identify the bridge in the network46
system_description: string
The system_description string is exported in LLDP messages46 It should describe the type of software and hardware46
mappings: map of integer-integer pairs, key in range 0 to 16,777,215, value in range 0 to 4,095
A mapping from SPB network Individual Service Identifier (ISID) to VLAN id46