ovs-vswitchd.conf.db − Open_vSwitch database schema
A database with this schema holds the configuration for one Open vSwitch daemon. The top-level configuration for the daemon is the Open_vSwitch table, which must have exactly one record. Records in other tables are significant only when they can be reached directly or indirectly from the Open_vSwitch table. 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’’ tables.
Most tables contain two special columns, named other_config and external_ids. These columns have the same form and purpose each place that they appear, so we describe them here to save space later.
other_config: map of string-string pairs
Key-value pairs for configuring rarely used features. Supported keys, along with the forms taken by their values, are documented individually for each table.
A few tables do not have other_config columns because no key-value pairs have yet been defined for them.
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 itself. 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 unique. In some cases, where key-value pairs have been defined that are likely to be widely useful, they are documented individually for each table.
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 configuration.
Bridge |
Bridge configuration. |
|||
Port |
Port configuration. |
|||
Interface |
One physical network device in a Port. |
Flow_Table
OpenFlow table configuration
QoS |
Quality of Service configuration |
|||
Queue |
QoS output queue. |
|||
Mirror |
Port mirroring. |
Controller
OpenFlow controller configuration.
Manager |
OVSDB management connection. |
|||
NetFlow |
NetFlow configuration. |
|||
Datapath |
Datapath configuration. |
|||
CT_Zone |
CT_Zone configuration. |
CT_Timeout_Policy
CT_Timeout_Policy configuration.
SSL |
SSL configuration. |
|||
sFlow |
sFlow configuration. |
|||
IPFIX |
IPFIX configuration. |
Flow_Sample_Collector_Set
Flow_Sample_Collector_Set configuration.
AutoAttach
AutoAttach configuration.
Configuration for an Open vSwitch daemon. There must be exactly one record in the Open_vSwitch table.
Configuration:
datapaths |
map of string-Datapath pairs |
|||
bridges |
set of Bridges |
|||
ssl |
optional SSL |
|||
external_ids : system-id |
optional string |
external_ids : xs-system-uuid
optional string
external_ids : hostname |
optional string |
|||
external_ids : rundir |
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 : max-revalidator
optional string, containing an integer, at least 100
other_config : min-revalidate-pps
optional string, containing an integer, at least 1
other_config : offloaded-stats-delay
optional string, containing an integer, at least 0
other_config : hw-offload |
optional string, either true or false |
other_config : n-offload-threads
optional string, containing an integer, in range 1 to 10
other_config : tc-policy |
optional string, one of none, skip_hw, or skip_sw | ||
other_config : dpdk-init |
optional string, one of false, true, or try |
other_config : dpdk-lcore-mask
optional string, containing an integer, at least 1
other_config : pmd-cpu-mask
optional string
other_config : dpdk-alloc-mem
optional string, containing an integer, at least 0
other_config : dpdk-socket-mem
optional string
other_config : dpdk-socket-limit
optional string
other_config : dpdk-hugepage-dir
optional string
other_config : dpdk-extra |
optional string |
other_config : vhost-sock-dir
optional string
other_config : vhost-iommu-support
optional string, either true or false
other_config : vhost-postcopy-support
optional string, either true or false
other_config : per-port-memory
optional string, either true or false
other_config : tx-flush-interval
optional string, containing an integer, in range 0 to 1,000,000
other_config : pmd-perf-metrics
optional string, either true or false
other_config : smc-enable |
optional string, either true or false |
other_config : pmd-rxq-assign
optional string, one of cycles, group, or roundrobin
other_config : pmd-rxq-isolate
optional string, either true or false
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
other_config : emc-insert-inv-prob
optional string, containing an integer, in range 0 to 4,294,967,295
other_config : vlan-limit |
optional string, containing an integer, at least 0 |
other_config : bundle-idle-timeout
optional string, containing an integer, at least 1
other_config : offload-rebalance
optional string, either true or false
other_config : pmd-auto-lb |
optional string, either true or false |
other_config : pmd-auto-lb-rebal-interval
optional string, containing an integer, in range 0 to 20,000
other_config : pmd-auto-lb-load-threshold
optional string, containing an integer, in range 0 to 100
other_config : pmd-auto-lb-improvement-threshold
optional string, containing an integer, in range 0 to 100
other_config : userspace-tso-enable
optional string, either true or false
Status:
next_cfg |
integer |
|||
cur_cfg |
integer |
|||
dpdk_initialized |
boolean |
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 |
|||
dpdk_version |
optional string |
Capabilities:
datapath_types |
set of strings |
|||
iface_types |
set of strings |
Database Configuration:
manager_options |
set of Managers |
IPsec:
other_config : private_key |
optional string |
|||
other_config : certificate |
optional string |
|||
other_config : ca_cert |
optional string |
Plaintext Tunnel Policy:
other_config : ipsec_skb_mark
optional string
Common Columns:
other_config |
map of string-string pairs |
|||
external_ids |
map of string-string pairs |
Configuration:
datapaths: map of string-Datapath pairs
Map of datapath types to datapaths. The datapath_type column of the Bridge table is used as a key for this map. The value points
to
a row in the Datapath table.
bridges: set of Bridges
Set of bridges managed by the daemon.
ssl: optional SSL
SSL used globally by the daemon.
external_ids : system-id: optional string
A unique identifier for the Open vSwitch’s physical host. The form of the identifier depends on the type of the host. On a Citrix XenServer, this will likely be the same as external_ids:xs-system-uuid.
external_ids : xs-system-uuid: optional string
The Citrix XenServer universally unique identifier for the physical host as displayed by xe host−list.
external_ids : hostname: optional string
The hostname for the host running Open vSwitch. This is a fully qualified domain name since version 2.6.2.
external_ids : rundir: optional string
In Open vSwitch 2.8 and later, the run directory of the running Open vSwitch daemon. This directory is used for runtime state such as control and management sockets. The value of other_config:vhost-sock-dir is relative to this directory.
other_config :
stats-update-interval: optional string, containing an
integer, at least 5,000
Interval for updating statistics to the database, in milliseconds. This option will affect the update of the statistics column in the following tables: Port, Interface , Mirror.
Default value is 5000 ms.
Getting statistics more frequently can be achieved via OpenFlow.
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 switch. This behavior is ordinarily desirable. However, if ovs−vswitchd is restarting as part of a ‘‘hot-upgrade,’’ then this leads to a relatively long period during which packets are mishandled.
This option allows for improvement. 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 datapath. When this value is later set to false, ovs−vswitchd will start receiving packets from the datapath and re-setup the flows.
Additionally, ovs−vswitchd is prevented from connecting to controllers when this value is set to true. This prevents controllers from making changes to the flow table in the middle of flow restoration, which could result in undesirable intermediate states. Once this value has been set to false and the desired flow state has been restored, ovs−vswitchd will be able to reconnect to controllers and process any new flow table modifications.
Thus, with this option, the procedure for a hot-upgrade of ovs−vswitchd becomes roughly the following:
1. |
Stop ovs−vswitchd. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2. |
Set other_config:flow-restore-wait to true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3. |
Start ovs−vswitchd. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4. |
Use ovs−ofctl (or some other program, such as an OpenFlow controller) to restore the OpenFlow flow table to the desired state.
The ovs−ctl’s ‘‘restart’’ and ‘‘force-reload-kmod’’ functions use the above config option during hot upgrades. other_config :
flow-limit: optional string, containing an integer, at
The maximum number of flows allowed in the datapath flow table. Internally OVS will choose a flow limit which will likely be lower than this number, based on real time network conditions. Tweaking this value is discouraged unless you know exactly what you’re doing. The default is 200000. other_config : max-idle:
optional string, containing an integer, at The maximum time (in ms) that idle flows will remain cached in the datapath. 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 conditions. Tweaking this value is discouraged unless you know exactly what you’re doing. The default is 10000. other_config :
max-revalidator: optional string, containing an integer,
The maximum time (in ms) that revalidator threads will wait before executing flow revalidation. Note that this is maximum allowed value. Actual timeout used by OVS is minimum of max-idle and max-revalidator values. Tweaking this value is discouraged unless you know exactly what you’re doing. The default is 500. other_config :
min-revalidate-pps: optional string, containing an Set minimum pps that flow must have in order to be revalidated when revalidation duration exceeds half of max-revalidator config variable. The default is 5. other_config :
offloaded-stats-delay: optional string, containing an
Set worst case delay (in ms) it might take before statistics of offloaded flows are updated. Offloaded flows younger than this delay will always be revalidated regardless of other_config:min-revalidate-pps. The default is 2000. other_config : hw-offload: optional string, either true or false Set this value to true to enable netdev flow offload. The default value is false. Changing this value requires restarting the daemon Currently Open vSwitch supports hardware offloading on Linux systems. On other systems, this value is ignored. This functionality is considered ’experimental’. Depending on which OpenFlow matches and actions are configured, which kernel version is used, and what hardware is available, Open vSwitch may not be able to offload functionality to hardware. In order to dump HW offloaded flows use ovs−appctl dpctl/dump−flows, ovs−dpctl doesn’t support this functionality. See ovs-vswitchd(8) for details. other_config :
n-offload-threads: optional string, containing an Set this value to the number of threads created to manage hardware offloads. The default value is 1. Changing this value requires restarting the daemon. This is only relevant for userspace datapath and only if other_config:hw-offload is enabled. other_config : tc-policy:
optional string, one of none, skip_hw, or
Specified the policy used with HW offloading. Options:
skip_sw Offload rule to HW only. skip_hw Add software rule without offloading rule to HW. This is only relevant if other_config:hw-offload is enabled. The default value is none. other_config : dpdk-init: optional string, one of false, true, or try Set this value to true or try to enable runtime support for DPDK ports. The vswitch must have compile-time support for DPDK as well. A value of true will cause the ovs-vswitchd process to abort if DPDK cannot be initialized. A value of try will allow the ovs-vswitchd process to continue running even if DPDK cannot be initialized. The default value is false. Changing this value requires restarting the daemon If this value is false at startup, any dpdk ports which are configured in the bridge will fail due to memory errors. other_config :
dpdk-lcore-mask: optional string, containing an integer,
Specifies the CPU cores where dpdk lcore threads should be spawned. The DPDK lcore threads are used for DPDK library tasks, such as library internal message processing, logging, etc. Value should be in the form of a hex string (so ’0x123’) similar to the ’taskset’ mask input. The lowest order bit corresponds to the first CPU core. A set bit means the corresponding core is available and an lcore thread will be created and pinned to it. If the input does not cover all cores, those uncovered cores are considered not set. For performance reasons, it is best to set this to a single core on the system, rather than allow lcore threads to float. If not specified, the value will be determined by choosing the lowest CPU core from initial cpu affinity list. Otherwise, the value will be passed directly to the DPDK library. other_config : pmd-cpu-mask: optional string Specifies CPU mask for setting the cpu affinity of PMD (Poll Mode Driver) threads. Value should be in the form of hex string, similar to the dpdk EAL ’-c COREMASK’ option input or the ’taskset’ mask input. The lowest order bit corresponds to the first CPU core. A set bit means the corresponding core is available and a pmd thread will be created and pinned to it. If the input does not cover all cores, those uncovered cores are considered not set. If not specified, one pmd thread will be created for each numa node and pinned to any available core on the numa node by default. other_config :
dpdk-alloc-mem: optional string, containing an integer,
Specifies the amount of memory to preallocate from the hugepage pool, regardless of socket. It is recommended that dpdk-socket-mem is used instead. other_config : dpdk-socket-mem: optional string Specifies the amount of memory to preallocate from the hugepage pool, on a per-socket basis. The specifier is a comma-separated string, in ascending order of CPU socket. E.g. On a four socket system 1024,0,2048 would set socket 0 to preallocate 1024MB, socket 1 to preallocate 0MB, socket 2 to preallocate 2048MB and socket 3 (no value given) to preallocate 0MB. If other_config:dpdk-socket-mem and other_config:dpdk-alloc-mem are not specified, neither will be used and there will be no default value for each numa node. DPDK defaults will be used instead. If other_config:dpdk-socket-mem and other_config:dpdk-alloc-mem are specified at the same time, other_config:dpdk-socket-mem will be used as default. Changing this value requires restarting the daemon. other_config : dpdk-socket-limit: optional string Limits the maximum amount of memory that can be used from the hugepage pool, on a per-socket basis. The specifier is a comma-separated list of memory limits per socket. 0 will disable the limit for a particular socket. If not specified, OVS will not configure limits by default. Changing this value requires restarting the daemon. other_config : dpdk-hugepage-dir: optional string Specifies the path to the hugetlbfs mount point. If not specified, this will be guessed by the DPDK library (default is /dev/hugepages). Changing this value requires restarting the daemon. other_config : dpdk-extra: optional string Specifies additional eal command line arguments for DPDK. The default is empty. Changing this value requires restarting the daemon other_config : vhost-sock-dir: optional string Specifies a relative path from external_ids:rundir to the vhost-user unix domain socket files. If this value is unset, the sockets are put directly in external_ids:rundir. Changing this value requires restarting the daemon. other_config :
vhost-iommu-support: optional string, either true
or vHost IOMMU is a security feature, which restricts the vhost memory that a virtio device may access. vHost IOMMU support is disabled by default, due to a bug in QEMU implementations of the vhost REPLY_ACK protocol, (on which vHost IOMMU relies) prior to v2.9.1. Setting this value to true enables vHost IOMMU support for vHost User Client ports in OvS-DPDK, starting from DPDK v17.11. Changing this value requires restarting the daemon. other_config :
vhost-postcopy-support: optional string, either
true or vHost post-copy is a feature which allows switching live migration of VM attached to dpdkvhostuserclient port to post-copy mode if default pre-copy migration can not be converged or takes too long to converge. Setting this value to true enables vHost post-copy support for all dpdkvhostuserclient ports. Available starting from DPDK v18.11 and QEMU 2.12. Changing this value requires restarting the daemon. other_config : per-port-memory: optional string, either true or false By default OVS DPDK uses a shared memory model wherein devices that have the same MTU and socket values can share the same mempool. Setting this value to true changes this behaviour. Per port memory allow DPDK devices to use private memory per device. This can provide greater transparency as regards memory usage but potentially at the cost of greater memory requirements. Changing this value requires restarting the daemon if dpdk-init has already been set to true. other_config :
tx-flush-interval: optional string, containing an Specifies the time in microseconds that a packet can wait in output batch for sending i.e. amount of time that packet can spend in an intermediate output queue before sending to netdev. This option can be used to configure balance between throughput and latency. Lower values decreases latency while higher values may be useful to achieve higher performance. Defaults to 0 i.e. instant packet sending (latency optimized). other_config : pmd-perf-metrics: optional string, either true or false Enables recording of detailed PMD performance metrics for analysis and trouble-shooting. This can have a performance impact in the order of 1%. Defaults to false but can be changed at any time. other_config : smc-enable: optional string, either true or false Signature match cache or SMC is a cache between EMC and megaflow cache. It does not store the full key of the flow, so it is more memory efficient comparing to EMC cache. SMC is especially useful when flow count is larger than EMC capacity. Defaults to false but can be changed at any time. other_config :
pmd-rxq-assign: optional string, one of cycles,
group, Specifies how RX queues will be automatically assigned to CPU cores. Options:
roundrobin Rxqs will be round-robined across CPU cores.
The default value is cycles. Changing this value will affect an automatic re-assignment of Rxqs to CPUs. Note: Rxqs mapped to CPU cores with pmd−rxq−affinity are unaffected. other_config : pmd-rxq-isolate: optional string, either true or false Specifies if a CPU core will be isolated after being pinned with an Rx queue. Set this value to false to non-isolate a CPU core after it is pinned with an Rxq using pmd−rxq−affinity. This will allow OVS to assign other Rxqs to that CPU core. The default value is true. This can only be false when pmd−rxq−assign is set to group. other_config :
n-handler-threads: optional string, containing an Attempts to specify the number of threads for software datapaths to use for handling new flows. Some datapaths may choose to ignore this and it will be set to a sensible option for the datapath type. This configuration is per datapath. If you have more than one software datapath (e.g. some system bridges and some netdev bridges), then the total number of threads is n−handler−threads times the number of software datapaths. other_config :
n-revalidator-threads: optional string, containing an
Attempts to specify the number of threads for software datapaths to use for revalidating flows in the datapath. Some datapaths may choose to ignore this and will set to a sensible option for the datapath type. Typically, there is a direct correlation between the number of revalidator threads, and the number of flows allowed in the datapath. The default is the number of cpu cores divided by four plus one. If n−handler−threads is set, the default changes to the number of cpu cores minus the number of handler threads. This configuration is per datapath. If you have more than one software datapath (e.g. some system bridges and some netdev bridges), then the total number of threads is n−handler−threads times the number of software datapaths. other_config :
emc-insert-inv-prob: optional string, containing an Specifies the inverse probability (1/emc-insert-inv-prob) of a flow being inserted into the Exact Match Cache (EMC). On average one in every emc−insert−inv−prob packets that generate a unique flow will cause an insertion into the EMC. A value of 1 will result in an insertion for every flow (1/1 = 100%) whereas a value of zero will result in no insertions and essentially disable the EMC. Defaults to 100 ie. there is (1/100 =) 1% chance of EMC insertion. other_config :
vlan-limit: optional string, containing an integer, at
Limits the number of VLAN headers that can be matched to the specified number. Further VLAN headers will be treated as payload, e.g. a packet with more 802.1q headers will match Ethernet type 0x8100. Open vSwitch userspace currently supports at most 2 VLANs, and each datapath has its own limit. If vlan−limit is nonzero, it acts as a further limit. If this value is absent, the default is currently 1. This maintains backward compatibility with controllers that were designed for use with Open vSwitch versions earlier than 2.8, which only supported one VLAN. other_config :
bundle-idle-timeout: optional string, containing an The maximum time (in seconds) that idle bundles will wait to be expired since it was either opened, modified or closed. OpenFlow specification mandates the timeout to be at least one second. The default is 10 seconds. other_config : offload-rebalance: optional string, either true or false Configures HW offload rebalancing, that allows to dynamically offload and un-offload flows while an offload-device is out of resources (OOR). This policy allows flows to be selected for offloading based on the packets-per-second (pps) rate of flows. Set this value to true to enable this option. The default value is false. Changing this value requires restarting the daemon. This is only relevant if HW offloading is enabled (hw-offload). When this policy is enabled, it also requires ’tc-policy’ to be set to ’skip_sw’. other_config : pmd-auto-lb: optional string, either true or false Configures PMD Auto Load Balancing that allows automatic assignment of RX queues to PMDs if any of PMDs is overloaded (i.e. a processing cycles > other_config:pmd-auto-lb-load-threshold). It uses current scheme of cycle based assignment of RX queues that are not statically pinned to PMDs. The default value is false. Set this value to true to enable this option. It is currently disabled by default and an experimental feature. This only comes in effect if cycle based assignment is enabled and there are more than one non-isolated PMDs present and at least one of it polls more than one queue. other_config :
pmd-auto-lb-rebal-interval: optional string, containing
The minimum time (in minutes) 2 consecutive PMD Auto Load Balancing iterations. The defaul value is 1 min. If configured to 0 then it would be converted to default value i.e. 1 min This option can be configured to avoid frequent trigger of auto load balancing of PMDs. For e.g. set the value (in min) such that it occurs once in few hours or a day or a week. other_config :
pmd-auto-lb-load-threshold: optional string, containing
Specifies the minimum PMD thread load threshold (% of used cycles) of any non-isolated PMD threads when a PMD Auto Load Balance may be triggered. The default value is 95%. other_config :
pmd-auto-lb-improvement-threshold: optional string, Specifies the minimum evaluated % improvement in load distribution across the non-isolated PMD threads that will allow a PMD Auto Load Balance to occur. Note, setting this parameter to 0 will always allow an auto load balance to occur regardless of estimated improvement or not. The default value is 25%. other_config :
userspace-tso-enable: optional string, either
true or Set this value to true to enable userspace support for TCP Segmentation Offloading (TSO). When it is enabled, the interfaces can provide an oversized TCP segment to the datapath and the datapath will offload the TCP segmentation and checksum calculation to the interfaces when necessary. The default value is false. Changing this value requires restarting the daemon. The feature only works if Open vSwitch is built with DPDK support. The feature is considered experimental. Status: next_cfg: integer Sequence number for client to increment. 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 number. cur_cfg: integer Sequence number that Open vSwitch sets to the current value of next_cfg after it finishes applying a set of configuration changes. dpdk_initialized: boolean True if other_config:dpdk-init is set to true and the DPDK library is successfully initialized. Statistics: The
statistics column contains key-value pairs that
report statistics about a system running an Open vSwitch.
These are updated periodically (currently, every 5 seconds).
Key-value pairs that cannot be determined or that do not
apply to a platform are omitted. Statistics are disabled by default to avoid overhead in the common case when statistics gathering is not useful. Set this value to true to enable populating the statistics column or to false to explicitly disable it. 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 integer. This may be less than the number installed, if some are not online or if they are not available to the operating system. Open vSwitch userspace processes are not multithreaded, but the Linux kernel-based datapath is. 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, respectively. 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 running. In respective order, these values are:
On Linux, all five values can be determined and are included. On other operating systems, only the first two values can be determined, so the list will only have two values. 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 (e.g. process_ovs−vswitchd). The value is a comma-separated list of integers. The integers represent the following, with memory measured in kilobytes and durations in milliseconds:
The interpretation of some of these values depends on whether the process was started with the −−monitor. If it was not, then the crash count will always be 0 and the two durations will always be the same. 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 restart. There will be one key-value pair for each file in Open vSwitch’s ‘‘run directory’’ (usually /var/run/openvswitch) whose name ends in .pid, whose contents are a process ID, and which is locked by a running process. The name is taken from the pidfile’s name. Currently Open vSwitch is only able to obtain all of the above detail on Linux systems. On other systems, the same key-value pairs will be present but the values will always be the empty string. statistics : file_systems: optional string A space-separated list of information on local, writable file systems. Each item in the list describes one file system and consists in turn of a comma-separated list of the following:
This key-value pair is omitted if there are no local, writable file systems or if Open vSwitch cannot obtain the needed information. Version Reporting: These columns
report the types and versions of the hardware and software
running Open vSwitch. We recommend in general that software
should test whether specific features are supported instead
of relying on version number checks. These values are
primarily intended for reporting to human administrators.
The Open vSwitch version number, e.g. 1.1.0. db_version: optional string The database schema version number, e.g. 1.2.3. See ovsdb-tool(1) for an explanation of the numbering scheme. The schema version is part of the database schema, so it can also be retrieved by fetching the schema using the Open vSwitch database protocol. system_type: optional string An identifier for the type of system on top of which Open vSwitch runs, e.g. XenServer or KVM. System integrators are responsible for choosing and setting an appropriate value for this column. system_version: optional string The version of the system identified by system_type, e.g. 5.6.100−39265p on XenServer 5.6.100 build 39265. System integrators are responsible for choosing and setting an appropriate value for this column. dpdk_version: optional string The version of the linked DPDK library. Capabilities: These columns
report capabilities of the Open vSwitch instance. This column reports the different dpifs registered with the system. These are the values that this instance supports in the datapath_type column of the Bridge table. iface_types: set of strings This column reports the different netdevs registered with the system. These are the values that this instance supports in the type column of the Interface table. Database Configuration: These columns primarily configure the Open vSwitch database (ovsdb−server), not the Open vSwitch switch (ovs−vswitchd). The OVSDB database also uses the ssl settings. The Open vSwitch
switch does read the database configuration to determine
remote IP addresses to which in-band control should apply.
Database clients to which the Open vSwitch database server should connect or to which it should listen, along with options for how these connections should be configured. See the Manager table for more information. For this column to serve its purpose, ovsdb−server must be configured to honor it. The easiest way to do this is to invoke ovsdb−server with the option −−remote=db:Open_vSwitch,Open_vSwitch,manager_options The startup scripts that accompany Open vSwitch do this by default. IPsec: These settings control the global configuration of IPsec tunnels. The options column of the Interface table configures IPsec for individual tunnels. OVS IPsec supports the following three forms of authentication. Currently, all IPsec tunnels must use the same form:
other_config : private_key: optional string Name of a PEM file containing the private key used as the switch’s identity for IPsec tunnels. other_config : certificate: optional string Name of a PEM file containing a certificate that certifies the switch’s private key, and identifies a trustworthy switch for IPsec tunnels. The certificate must be x.509 version 3 and with the string in common name (CN) also set in the subject alternative name (SAN). other_config : ca_cert: optional string Name of a PEM file containing the CA certificate used to verify that a remote switch of the IPsec tunnel is trustworthy. Plaintext Tunnel Policy: When an IPsec
tunnel is configured in this database, multiple independent
components take responsibility for implementing it.
ovs−vswitchd and its datapath handle packet
forwarding to the tunnel and a separate daemon pushes the
tunnel’s IPsec policy configuration to the kernel or
other entity that implements it. There is a race: if the
former configuration completes before the latter, then
packets sent by the local host over the tunnel can be
transmitted in plaintext. Using this setting, OVS users can
avoid this undesirable situation. This setting takes the form value/mask. If it is specified, then the skb_mark field in every outgoing tunneled packet sent in plaintext is compared against it and, if it matches, the packet is dropped. This is a global setting that is applied to every tunneled packet, regardless of whether IPsec encryption is enabled for the tunnel, the type of tunnel, or whether OVS is involved. Example policies:
(empty) If this setting is empty or unset, then all unencrypted tunneled packets are transmitted in the usual way. Common Columns: The overall
purpose of these columns is described under Common
Columns at the beginning of this document. Bridge TABLEConfiguration for a bridge within an Open_vSwitch. A Bridge record represents an Ethernet switch with one or more ‘‘ports,’’ which are the Port records pointed to by the Bridge’s ports column. Summary:Core Features:
OpenFlow Configuration:
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 other_config : controller-queue-size optional string, containing an integer, in range 1 to 512
Spanning Tree Configuration: STP Configuration:
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_designated_root optional string status : stp_root_path_cost optional string Rapid Spanning Tree: RSTP Configuration:
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:
Other Features:
external_ids : xs-network-uuids 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:
Details:Core Features: name: immutable string (must be unique within table) Bridge identifier. Must be unique among the names of ports, interfaces, and bridges on a host. The name must be alphanumeric and must not contain forward or backward slashes. The name of a bridge is also the name of an Interface (and a Port) within the bridge, so the restrictions on the name column in the Interface table, particularly on length, also apply to bridge names. Refer to the documentation for Interface names for details. ports: set of Ports Ports included in the bridge. mirrors: set of Mirrors Port mirroring configuration. netflow: optional NetFlow NetFlow configuration. sflow: optional sFlow sFlow(R) configuration. ipfix: optional IPFIX IPFIX configuration. 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 MACs. This should ordinarily be used to disable MAC learning on VLANs used for mirroring (RSPAN VLANs). It may also be useful for debugging. SLB bonding (see the bond_mode column in the Port table) is incompatible with flood_vlans. Consider using another bonding mode or a different type of mirror instead. auto_attach: optional AutoAttach Auto Attach configuration. OpenFlow Configuration: controller: set of Controllers OpenFlow controller set. If unset, then no OpenFlow controllers will be used. If there are primary controllers, removing all of them clears the OpenFlow flow tables, group table, and meter table. If there are no primary controllers, adding one also clears these tables. 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 these tables. flow_tables: map of integer-Flow_Table pairs, key in range 0 to 254 Configuration for OpenFlow tables. Each pair maps from an OpenFlow table ID to configuration for that table. fail_mode: optional string, either secure or standalone When a controller is
configured, it is, ordinarily, responsible for setting up
all flows on the switch. Thus, if the connection to the
controller fails, no new network connections can be set up.
If the connection to the controller stays down long enough,
no packets can pass through the switch at all. This setting
determines the switch’s response to such a situation.
It may be set to one of the following: 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 flows. In this mode, Open vSwitch causes the bridge to act like an ordinary MAC-learning switch. Open vSwitch will continue to retry connecting to the controller in the background and, when the connection succeeds, it will discontinue its standalone behavior.
The default is standalone if the value is unset, but future versions of Open vSwitch may change the default. The standalone mode can create forwarding loops on a bridge that has more than one uplink port unless STP is enabled. To avoid loops on such a bridge, configure secure mode or enable STP (see stp_enable). The fail_mode setting applies only to primary controllers. When more than one primary controller is configured, fail_mode is considered only when none of the configured controllers can be contacted. Changing fail_mode when no primary controllers are configured clears the OpenFlow flow tables, group table, and meter table. datapath_id: optional string Reports the OpenFlow datapath ID in use. Exactly 16 hex digits. (Setting this column has no useful effect. Set other-config:datapath-id instead.) datapath_version: string Reports the datapath version. This column is maintained for backwards compatibility. The preferred locatation is the datapath_id column of the Datapath table. The full documentation for this column is there. other_config : datapath-id: optional string Overrides the default OpenFlow datapath ID, setting it to the specified value specified in hex. The value must either have a 0x prefix or be exactly 16 hex digits long. May not be all-zero. other_config : dp-desc: optional string Human readable description of datapath. It is a maximum 256 byte-long free-form string to describe the datapath for debugging purposes, e.g. switch3 in room 3120. The value is returned by the switch as a part of reply to OFPMP_DESC request (ofp_desc). The OpenFlow specification (e.g. 1.3.5) describes the ofp_desc structure to contaion "NULL terminated ASCII strings". For the compatibility reasons no more than 255 ASCII characters should be used. other_config : dp-sn: optional string Serial number. It is a maximum 32 byte-long free-form string to provide an additional switch identification. The value is returned by the switch as a part of reply to OFPMP_DESC request (ofp_desc). Same as mentioned in the description of other-config:dp-desc, the string should be no more than 31 ASCII characters for the compatibility. 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 settings. other_config :
in-band-queue: optional string, containing an integer,
A queue ID as a nonnegative integer. This sets the OpenFlow queue ID that will be used by flows set up by in-band control on this bridge. 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 instead. other_config :
controller-queue-size: optional string, containing an
This sets the maximum size of the queue of packets that need to be sent to the OpenFlow management controller. The value must be less than 512. If not specified the queue size is limited to 100 packets by default. Note: increasing the queue size might have a negative impact on latency. protocols: set of
strings, one of OpenFlow10, OpenFlow11,
OpenFlow12, List of OpenFlow protocols that may be used when negotiating a connection with a controller. OpenFlow 1.0, 1.1, 1.2, 1.3, 1.4, and 1.5 are enabled by default if this column is empty. Spanning Tree Configuration: The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol that ensures loop-free topologies. It allows redundant links to be included in the network to provide automatic backup paths if the active links fails. These settings configure the slower-to-converge but still widely supported version of Spanning Tree Protocol, sometimes known as 802.1D−1998. Open vSwitch also supports the newer Rapid Spanning Tree Protocol (RSTP), documented later in the section titled Rapid Spanning Tree Configuration. STP Configuration: stp_enable: boolean Enable spanning tree on the bridge. By default, STP is disabled on bridges. Bond, internal, and mirror ports are not supported and will not participate in the spanning tree. STP and RSTP are mutually exclusive. If both are enabled, RSTP will be used. 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:xx. By default, the identifier is the MAC address of the bridge. other_config :
stp-priority: optional string, containing an integer, in
The bridge’s relative priority value for determining the root bridge (the upper 16 bits of the bridge-id). A bridge with the lowest bridge-id is elected the root. By default, the priority is 0x8000. other_config :
stp-hello-time: optional string, containing an integer,
The interval between transmissions of hello messages by designated ports, in seconds. By default the hello interval is 2 seconds. other_config :
stp-max-age: optional string, containing an integer, in
The maximum age of the information transmitted by the bridge when it is the root bridge, in seconds. By default, the maximum age is 20 seconds. other_config :
stp-forward-delay: optional string, containing an The delay to wait between transitioning root and designated ports to forwarding, in seconds. By default, the forwarding delay is 15 seconds. other_config :
mcast-snooping-aging-time: optional string, containing
The maximum number of seconds to retain a multicast snooping entry for which no packets have been seen. The default is currently 300 seconds (5 minutes). The value, if specified, is forced into a reasonable range, currently 15 to 3600 seconds. other_config :
mcast-snooping-table-size: optional string, containing
The maximum number of multicast snooping addresses to learn. The default is currently 2048. The value, if specified, is forced into a reasonable range, currently 10 to 1,000,000. other_config :
mcast-snooping-disable-flood-unregistered: optional If set to false, unregistered multicast packets are forwarded to all ports. If set to true, unregistered multicast packets are forwarded to ports connected to multicast routers. STP Status: These key-value
pairs report the status of 802.1D−1998. They are
present only if STP is enabled (via the stp_enable
column). The bridge ID used in spanning tree advertisements, in the form xxxx.yyyyyyyyyyyy where the xs are the STP priority, the ys are the STP system ID, and each x and y is a hex digit. status : stp_designated_root: optional string The designated root for this spanning tree, in the same form as status:stp_bridge_id. If this bridge is the root, this will have the same value as status:stp_bridge_id, otherwise it will differ. status : stp_root_path_cost: optional string The path cost of reaching the designated bridge. A lower number is better. The value is 0 if this bridge is the root, otherwise it is higher. Rapid Spanning Tree: Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol that ensures loop-free topologies. RSTP superseded STP with the publication of 802.1D−2004. Compared to STP, RSTP converges more quickly and recovers more quickly from failures. RSTP Configuration: rstp_enable: boolean Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled on bridges. Bond, internal, and mirror ports are not supported and will not participate in the spanning tree. STP and RSTP are mutually exclusive. If both are enabled, RSTP will be used. 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:xx. By default, the address is the MAC address of the bridge. other_config :
rstp-priority: optional string, containing an integer,
The bridge’s relative priority value for determining the root bridge (the upper 16 bits of the bridge-id). A bridge with the lowest bridge-id is elected the root. By default, the priority is 0x8000 (32768). This value needs to be a multiple of 4096, otherwise it’s rounded to the nearest inferior one. other_config :
rstp-ageing-time: optional string, containing an The Ageing Time parameter for the Bridge. The default value is 300 seconds. other_config :
rstp-force-protocol-version: optional string, containing
The Force Protocol Version parameter for the Bridge. This can take the value 0 (STP Compatibility mode) or 2 (the default, normal operation). other_config :
rstp-max-age: optional string, containing an integer, in
The maximum age of the information transmitted by the Bridge when it is the Root Bridge. The default value is 20. other_config :
rstp-forward-delay: optional string, containing an The delay used by STP Bridges to transition Root and Designated Ports to Forwarding. The default value is 15. other_config :
rstp-transmit-hold-count: optional string, containing an
The Transmit Hold Count used by the Port Transmit state machine to limit transmission rate. The default value is 6. RSTP Status: These key-value
pairs report the status of 802.1D−2004. They are
present only if RSTP is enabled (via the rstp_enable
column). The bridge ID used in rapid spanning tree advertisements, in the form x.yyy.zzzzzzzzzzzz 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 digit. rstp_status : rstp_root_id: optional string The root of this spanning tree, in the same form as rstp_status:rstp_bridge_id. If this bridge is the root, this will have the same value as rstp_status:rstp_bridge_id, otherwise it will differ. rstp_status :
rstp_root_path_cost: optional string, containing an The path cost of reaching the root. A lower number is better. The value is 0 if this bridge is the root, otherwise it is higher. rstp_status : rstp_designated_id: optional string The RSTP designated ID, in the same form as rstp_status:rstp_bridge_id. rstp_status : rstp_designated_port_id: optional string The RSTP designated port ID, as a 4-digit hex number. rstp_status : rstp_bridge_port_id: optional string The RSTP bridge port ID, as a 4-digit hex number. Multicast Snooping Configuration: Multicast
snooping (RFC 4541) monitors the Internet Group Management
Protocol (IGMP) and Multicast Listener Discovery traffic
between hosts and multicast routers. The switch uses what
IGMP and MLD snooping learns to forward multicast traffic
only to interfaces that are connected to interested
receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
MLDv1 and MLDv2 protocols. Enable multicast snooping on the bridge. For now, the default is disabled. Other Features: datapath_type: string Name of datapath provider. The kernel datapath has type system. The userspace datapath has type netdev. 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 instance. external_ids : bridge-id: optional string A unique identifier of the bridge. On Citrix XenServer this will commonly be the same as external_ids:xs-network-uuids. 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 host. The network identifiers are RFC 4122 UUIDs as displayed by, e.g., xe network−list. 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 ID. other_config : forward-bpdu: optional string, either true or false Controls forwarding of BPDUs and other network control frames when NORMAL action is invoked. When this option is false or unset, frames with reserved Ethernet addresses (see table below) will not be forwarded. When this option is true, such frames will not be treated specially. The above general rule has the following exceptions:
Set this option to true if the Open vSwitch bridge connects different Ethernet networks and is not configured to participate in STP. This option
affects packets with the following destination MAC
addresses: IEEE 802.1D Spanning Tree Protocol (STP). 01:80:c2:00:00:01 IEEE Pause frame. 01:80:c2:00:00:0x Other reserved protocols. 00:e0:2b:00:00:00 Extreme Discovery Protocol (EDP). 00:e0:2b:00:00:04 and 00:e0:2b:00:00:06 Ethernet Automatic Protection Switching (EAPS). 01:00:0c:cc:cc:cc Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP), Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP), and others. 01:00:0c:cc:cc:cd Cisco Shared Spanning Tree Protocol PVSTP+. 01:00:0c:cd:cd:cd Cisco STP Uplink Fast. 01:00:0c:00:00:00 Cisco Inter Switch Link. 01:00:0c:cc:cc:cx Cisco CFM. other_config :
mac-aging-time: optional string, containing an integer,
The maximum number of seconds to retain a MAC learning entry for which no packets have been seen. The default is currently 300 seconds (5 minutes). The value, if specified, is forced into a reasonable range, currently 15 to 3600 seconds. A short MAC aging time allows a network to more quickly detect that a host is no longer connected to a switch port. However, it also makes it more likely that packets will be flooded unnecessarily, when they are addressed to a connected host that rarely transmits packets. To reduce the incidence of unnecessary flooding, use a MAC aging time longer than the maximum interval at which a host will ordinarily transmit packets. other_config :
mac-table-size: optional string, containing an integer,
The maximum number of MAC addresses to learn. The default is currently 8192. The value, if specified, is forced into a reasonable range, currently 10 to 1,000,000. Common Columns: The overall
purpose of these columns is described under Common
Columns at the beginning of this document. Port TABLEA port within a Bridge. Most commonly, a port has exactly one ‘‘interface,’’ pointed to by its interfaces column. Such a port logically corresponds to a port on a physical Ethernet switch. A port with more than one interface is a ‘‘bonded port’’ (see Bonding Configuration). Some properties that one might think as belonging to a port are actually part of the port’s Interface members. Summary:
VLAN Configuration:
other_config : qinq-ethtype optional string, either 802.1ad or 802.1q other_config : priority-tags optional string, one of always, if−nonzero, or never Bonding Configuration:
other_config : bond-hash-basis optional string, containing an integer other_config : lb-output-action optional string, either true or false other_config : bond-primary optional string Link Failure Detection: other_config : bond-detect-mode optional string, either carrier or miimon other_config : bond-miimon-interval optional string, containing an integer
LACP Configuration:
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-fallback-ab optional string, either true or false Rebalancing Configuration: other_config : bond-rebalance-interval optional string, containing an integer, in range 0 to 2,147,483,647
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_sec_in_state optional string, containing an integer, at least 0
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-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 Alternate, Backup, Designated, Disabled, or Root 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:
external_ids : fake-bridge-id-* 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:
Details:name: immutable string (must be unique within table) Port name. For a non-bonded port, this should be the same as its interface’s name. Port names must otherwise be unique among the names of ports, interfaces, and bridges on a host. Because port and interfaces names are usually the same, the restrictions on the name column in the Interface table, particularly on length, also apply to port names. Refer to the documentation for Interface names for details. interfaces: set of 1 or more Interfaces The port’s interfaces. If there is more than one, this is a bonded Port. VLAN Configuration: In short, a VLAN (short for ‘‘virtual LAN’’) is a way to partition a single switch into multiple switches. VLANs can be confusing, so for an introduction, please refer to the question ‘‘What’s a VLAN?’’ in the Open vSwitch FAQ. A VLAN is sometimes encoded into a packet using a 802.1Q or 802.1ad VLAN header, but every packet is part of some VLAN whether or not it is encoded in the packet. (A packet that appears to have no VLAN is part of VLAN 0, by default.) As a result, it’s useful to think of a VLAN as a metadata property of a packet, separate from how the VLAN is encoded. For a given port, this column determines how the encoding of a packet that ingresses or egresses the port maps to the packet’s VLAN. When a packet enters the switch, its VLAN is determined based on its setting in this column and its VLAN headers, if any, and then, conceptually, the VLAN headers are then stripped off. Conversely, when a packet exits the switch, its VLAN and the settings in this column determine what VLAN headers, if any, are pushed onto the packet before it egresses the port. The VLAN configuration in this column affects Open vSwitch only when it is doing ‘‘normal switching.’’ It does not affect flows set up by an OpenFlow controller, outside of the OpenFlow ‘‘normal action.’’ Bridge ports support the following types of VLAN configuration:
Any packet that ingresses on a trunk port tagged with a VLAN that the port does not trunk is dropped.
Any packet with an 802.1Q 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 ID. native-tagged A native-tagged port resembles a trunk port, with the exception that a packet without an 802.1Q header that ingresses on a native-tagged port is in the ‘‘native VLAN’’ (specified in the tag column). 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 802.1Q header. dot1q-tunnel A dot1q-tunnel port is somewhat like an access port. Like an access port, it carries packets on the single VLAN specified in the tag column and this VLAN, called the service VLAN, does not appear in an 802.1Q header for packets that ingress or egress on the port. The main difference lies in the behavior when packets that include a 802.1Q header ingress on the port. Whereas an access port drops such packets, a dot1q-tunnel port treats these as double-tagged with the outer service VLAN tag and the inner customer VLAN taken from the 802.1Q header. Correspondingly, to egress on the port, a packet outer VLAN (or only VLAN) must be tag, which is removed before egress, which exposes the inner (customer) VLAN if one is present. If cvlans is set, only allows packets in the specified customer VLANs. A packet will
only egress through bridge ports that carry the VLAN of the
packet, as described by the rules above. The VLAN mode of the port, as described above. When this column is empty, a default mode is selected as follows:
tag: optional integer, in range 0 to 4,095 For an access port, the port’s implicitly tagged VLAN. For a native-tagged or native-untagged port, the port’s native VLAN. Must be empty if this is a trunk port. trunks: set of up to 4,096 integers, in range 0 to 4,095 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN or VLANs that this port trunks; if it is empty, then the port trunks all VLANs. Must be empty if this is an access port. A native-tagged or native-untagged port always trunks its native VLAN, regardless of whether trunks includes that VLAN. cvlans: set of up to 4,096 integers, in range 0 to 4,095 For a dot1q-tunnel port, the customer VLANs that this port includes. If this is empty, the port includes all customer VLANs. For other kinds of ports, this setting is ignored. other_config : qinq-ethtype: optional string, either 802.1ad or 802.1q For a dot1q-tunnel port, this is the TPID for the service tag, that is, for the 802.1Q header that contains the service VLAN ID. Because packets that actually ingress and egress a dot1q-tunnel port do not include an 802.1Q header for the service VLAN, this does not affect packets on the dot1q-tunnel port itself. Rather, it determines the service VLAN for a packet that ingresses on a dot1q-tunnel port and egresses on a trunk port. The value 802.1ad specifies TPID 0x88a8, which is also the default if the setting is omitted. The value 802.1q specifies TPID 0x8100. For other kinds of ports, this setting is ignored. other_config :
priority-tags: optional string, one of always,
An 802.1Q header contains two important pieces of information: a VLAN ID and a priority. 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 802.1Q header at all (except for the priority). However, some network elements ignore any frame that has 802.1Q header at all, even when the VLAN ID is zero. Therefore, by default Open vSwitch does not output priority-tagged frames, instead omitting the 802.1Q header entirely if the VLAN ID is zero. Set this key to if−nonzero to enable priority-tagged frames on a port. For if−nonzero Open vSwitch omits the 802.1Q header on output if both the VLAN ID and priority would be zero. Set to always to retain the 802.1Q header in such frames as well. All frames output to native-tagged ports have a nonzero VLAN ID, so this setting is not meaningful on native-tagged ports. Bonding Configuration: A port that has more than one interface is a ‘‘bonded port.’’ Bonding allows for load balancing and fail-over. The following types of bonding will work with any kind of upstream switch. On the upstream switch, do not configure the interfaces as a bond: balance−slb Balances flows among members based on source MAC address and output VLAN, with periodic rebalancing as traffic patterns change. active−backup Assigns all flows to one member, failing over to a backup member when the active member is disabled. This is the only bonding mode in which interfaces may be plugged into different upstream switches. The following modes require the upstream switch to support 802.3ad with successful LACP negotiation. If LACP negotiation fails and other-config:lacp-fallback-ab is true, then active−backup mode is used: balance−tcp Balances flows among members based on L3 and L4 protocol information such as IP addresses and TCP/UDP ports. These columns
apply only to bonded ports. Their values are otherwise
ignored. The type of bonding used for a bonded port. Defaults to active−backup if unset. other_config : bond-hash-basis: optional string, containing an integer An integer hashed along with flows when choosing output members in load balanced bonds. When changed, all flows will be assigned different hash values possibly causing member selection decisions to change. Does not affect bonding modes which do not employ load balancing such as active−backup. other_config : lb-output-action: optional string, either true or false Enable/disable usage of optimized lb_output action for balancing flows among output members in load balanced bonds in balance−tcp. When enabled, it uses optimized path for balance-tcp mode by using rss hash and avoids recirculation. This knob does not affect other balancing modes. other_config : bond-primary: optional string If a slave interface with this name exists in the bond and is up, it will be made active. Relevant only when other_config:bond_mode is active−backup or if balance−tcp falls back to active−backup (e.g., LACP negotiation fails and other_config:lacp-fallback-ab is true). Link Failure Detection: An important
part of link bonding is detecting that links are down so
that they may be disabled. These settings determine how Open
vSwitch detects link failure. The means used to detect link failures. Defaults to carrier which uses each interface’s carrier to detect failures. When set to miimon, will check for failures by polling each interface’s MII. other_config :
bond-miimon-interval: optional string, containing an
The interval, in milliseconds, between successive attempts to poll each interface’s MII. Relevant only when other_config:bond-detect-mode is miimon. bond_updelay: integer The number of milliseconds for which the link must stay up on an interface before the interface is considered to be up. Specify 0 to enable the interface immediately. This setting is honored only when at least one bonded interface is already enabled. When no interfaces are enabled, then the first bond interface to come up is enabled immediately. bond_downdelay: integer The number of milliseconds for which the link must stay down on an interface before the interface is considered to be down. Specify 0 to disable the interface immediately. 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
links. These settings control LACP behavior. Configures LACP on this port. LACP allows directly connected switches to negotiate which links may be bonded. LACP may be enabled on non-bonded ports for the benefit of any switches they may be connected to. active ports are allowed to initiate LACP negotiations. passive ports are allowed to participate in LACP negotiations initiated by a remote switch, but not allowed to initiate such negotiations themselves. 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 true. Defaults to off if unset. other_config : lacp-system-id: optional string The LACP system ID of this Port. The system ID of a LACP bond is used to identify itself to its partners. Must be a nonzero MAC address. Defaults to the bridge Ethernet address if unset. other_config :
lacp-system-priority: optional string, containing an
The LACP system priority of this Port. In LACP negotiations, link status decisions are made by the system with the numerically lower priority. other_config : lacp-time: optional string, either fast or slow The LACP timing which should be used on this Port. By default slow is used. When configured to be fast LACP heartbeats are requested at a rate of once per second causing connectivity problems to be detected more quickly. In slow mode, heartbeats are requested at a rate of once every 30 seconds. other_config : lacp-fallback-ab: optional string, either true or false Determines the behavior of openvswitch bond in LACP mode. If the partner switch does not support LACP, setting this option to true allows openvswitch to fallback to active-backup. If the option is set to false, the bond will be disabled. In both the cases, once the partner switch is configured to LACP mode, the bond will use LACP. Rebalancing Configuration: These settings
control behavior when a bond is in balance−slb
or balance−tcp mode. 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 equal. If zero, load balancing is disabled on the bond (link failure still cause flows to move). If less than 1000ms, the rebalance interval will be 1000ms. bond_fake_iface: boolean For a bonded port, whether to create a fake internal interface with the name of the port. Use only for compatibility with legacy software that requires this. Spanning Tree Protocol: The configuration here is only meaningful, and the status is only populated, when 802.1D−1998 Spanning Tree Protocol is enabled on the port’s Bridge with its stp_enable column. 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). If this column’s value is false, STP is disabled on the port. other_config :
stp-port-num: optional string, containing an integer, in
The port number used for the lower 8 bits of the port-id. By default, the numbers will be assigned automatically. If any port’s number is manually configured on a bridge, then they must all be. other_config :
stp-port-priority: optional string, containing an The port’s relative priority value for determining the root port (the upper 8 bits of the port-id). A port with a lower port-id will be chosen as the root port. By default, the priority is 0x80. other_config :
stp-path-cost: optional string, containing an integer,
Spanning tree path cost for the port. A lower number indicates a faster link. By default, the cost is based on the maximum speed of the link. STP Status: status : stp_port_id: optional string The port ID used in spanning tree advertisements for this port, as 4 hex digits. Configuring the port ID is described in the stp−port−num and stp−port−priority keys of the other_config section earlier. status : stp_state:
optional string, one of blocking, disabled,
STP state of the port. status :
stp_sec_in_state: optional string, containing an
integer, at The amount of time this port has been in the current STP state, in seconds. status : stp_role:
optional string, one of alternate, designated,
or STP role of the port. Rapid Spanning Tree Protocol: The configuration here is only meaningful, and the status and statistics are only populated, when 802.1D−1998 Spanning Tree Protocol is enabled on the port’s Bridge with its stp_enable column. 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). If this column’s value is false, RSTP is disabled on the port. other_config :
rstp-port-priority: optional string, containing an The port’s relative priority value for determining the root port, in multiples of 16. By default, the port priority is 0x80 (128). Any value in the lower 4 bits is rounded off. The significant upper 4 bits become the upper 4 bits of the port-id. A port with the lowest port-id is elected as the root. other_config :
rstp-port-num: optional string, containing an integer,
The local RSTP port number, used as the lower 12 bits of the port-id. By default the port numbers are assigned automatically, and typically may not correspond to the OpenFlow port numbers. A port with the lowest port-id is elected as the root. other_config : rstp-path-cost: optional string, containing an integer The port path cost. The Port’s contribution, when it is the Root Port, to the Root Path Cost for the Bridge. By default the cost is automatically calculated from the port’s speed. other_config :
rstp-port-admin-edge: optional string, either
true or The admin edge port parameter for the Port. Default is false. other_config :
rstp-port-auto-edge: optional string, either true
or The auto edge port parameter for the Port. Default is true. other_config : rstp-port-mcheck: optional string, either true or false The mcheck port parameter for the Port. Default is false. 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 BPDUs. Setting mcheck has no effect if the Bridge is operating in STP Compatibility mode. 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 true. RSTP Status: rstp_status : rstp_port_id: optional string The port ID used in spanning tree advertisements for this port, as 4 hex digits. Configuring the port ID is described in the rstp−port−num and rstp−port−priority keys of the other_config section earlier. rstp_status :
rstp_port_role: optional string, one of
Alternate, RSTP role of the port. rstp_status :
rstp_port_state: optional string, one of
Disabled, RSTP state of the port. 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 table. rstp_status : rstp_designated_port_id: optional string The port’s RSTP designated port ID, as 4 hex digits. rstp_status :
rstp_designated_path_cost: optional string, containing
an The port’s RSTP designated path cost. Lower is better. RSTP Statistics: rstp_statistics : rstp_tx_count: optional integer Number of RSTP BPDUs transmitted through this port. rstp_statistics : rstp_rx_count: optional integer Number of valid RSTP BPDUs received by this port. rstp_statistics : rstp_error_count: optional integer Number of invalid RSTP BPDUs received by this port. rstp_statistics : rstp_uptime: optional integer The duration covered by the other RSTP statistics, in seconds. Multicast Snooping: other_config :
mcast-snooping-flood: optional string, either
true or If set to true, multicast packets (except Reports) are unconditionally forwarded to the specific port. other_config :
mcast-snooping-flood-reports: optional string, either
If set to true, multicast Reports are unconditionally forwarded to the specific port. Other Features: qos: optional QoS Quality of Service configuration for this port. mac: optional string The MAC address to use for this port for the purpose of choosing the bridge’s MAC address. This column does not necessarily reflect the port’s actual MAC address, nor will setting it change the port’s actual MAC address. fake_bridge: boolean Does this port represent a sub-bridge for its tagged VLAN within the Bridge? See ovs-vsctl(8) for more information. protected: boolean The protected ports feature allows certain ports to be designated as protected. Traffic between protected ports is blocked. Protected ports can send traffic to unprotected ports. Unprotected ports can send traffic to any port. Default is false. 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−, e.g. fake−bridge−xs−network−uuids. 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 used. bond_active_slave: optional string For a bonded port, record the MAC address of the current active member. Port Statistics: Key-value pairs that report port statistics. The update period is controlled by other_config:stats-update-interval in the Open_vSwitch table. Statistics: STP transmit and receive counters: statistics : stp_tx_count: optional integer Number of STP BPDUs sent on this port by the spanning tree library. statistics : stp_rx_count: optional integer Number of STP BPDUs received on this port and accepted by the spanning tree library. statistics : stp_error_count: optional integer Number of bad STP BPDUs received on this port. Bad BPDUs include runt packets and those with an unexpected protocol ID. Common Columns: The overall
purpose of these columns is described under Common
Columns at the beginning of this document. Interface TABLEAn interface within a Port. Summary:Core Features:
OpenFlow Port Number:
System-Specific Details:
Tunnel Options:
Tunnel Options: lisp only:
Tunnel Options: vxlan only:
Tunnel Options: gre only:
Tunnel Options: gre, ip6gre, geneve, bareudp and vxlan:
Tunnel Options: IPsec:
Tunnel Options: erspan only:
Tunnel Options: Bareudp only:
Patch Options:
PMD (Poll Mode Driver) Options:
other_config : pmd-rxq-affinity optional string
options : vhost-server-path optional string
EMC (Exact Match Cache) Configuration:
MTU:
Interface Status:
status : tunnel_egress_iface optional string status : tunnel_egress_iface_carrier optional string, either down or up dpdk:
status : max_hash_mac_addrs optional string
Statistics: Statistics: Successful transmit and receive counters:
Statistics: Receive errors:
statistics : rx_frame_err optional integer
Statistics: Transmit errors:
Ingress Policing:
ingress_policing_kpkts_rate integer, at least 0
ingress_policing_kpkts_burst integer, at least 0 Bidirectional Forwarding Detection (BFD): BFD Configuration:
BFD Status:
bfd_status : remote_state optional string, one of admin_down, down, init, or up bfd_status : remote_diagnostic optional string
Connectivity Fault Management:
cfm_fault_status : loopback none cfm_fault_status : overflow none cfm_fault_status : override none cfm_fault_status : interval none
other_config : cfm_interval optional string, containing an integer other_config : cfm_extended optional string, either true or false
other_config : cfm_ccm_vlan optional string, containing an integer, in range 1 to 4,095
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-status optional string, either active or inactive
external_ids : xs-network-uuid optional string
Auto Attach Configuration:
Flow control Configuration:
options : flow-ctrl-autoneg optional string, either true or false Link State Change detection mode: options : dpdk-lsc-interrupt optional string, either true or false Common Columns:
Details:Core Features: name: immutable string (must be unique within table) Interface name. Should be alphanumeric. For non-bonded port, this should be the same as the port name. It must otherwise be unique among the names of ports, interfaces, and bridges on a host. The maximum length of an interface name depends on the underlying datapath:
Regardless of other restrictions, OpenFlow only supports 15-byte names, which means that ovs−ofctl and OpenFlow controllers will show names truncated to 15 bytes. 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 0. The ifindex is useful for seamless integration with protocols such as SNMP and sFlow. mac_in_use: optional string The MAC address in use by this interface. mac: optional string Ethernet address to set for this interface. If unset then the default MAC address is used:
Some interfaces may not have a software-controllable MAC address. This option only affects internal ports. For other type ports, you can change the MAC address outside Open vSwitch, using ip command. 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 form. Otherwise, Open vSwitch clears this column. OpenFlow Port Number: When a client adds a new interface, Open vSwitch chooses an OpenFlow port number for the new port. If the client that adds the port fills in ofport_request, then Open vSwitch tries to use its value as the OpenFlow port number. 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 number. Regardless of how the port number was obtained, Open vSwitch then reports in ofport the port number actually assigned. Open vSwitch
limits the port numbers that it automatically assigns to the
range 1 through 32,767, inclusive. Controllers therefore
have free use of ports 32,768 and up. OpenFlow port number for this interface. Open vSwitch sets this column’s value, so other clients should treat it as read-only. The OpenFlow ‘‘local’’ port (OFPP_LOCAL) is 65,534. The other valid port numbers are in the range 1 to 65,279, inclusive. Value −1 indicates an error adding the interface. ofport_request: optional integer, in range 1 to 65,279 Requested OpenFlow port number for this interface. A client should ideally set this column’s value in the same database transaction that it uses to create the interface. Open vSwitch version 2.1 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 addition. 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 port. System-Specific Details: type: string The interface type. The types supported by a particular instance of Open vSwitch are listed in the iface_types column in the Open_vSwitch table. The following types are defined:
internal A simulated network device that sends and receives traffic. An internal interface whose name is the same as its bridge’s name is called the ‘‘local interface.’’ It does not make sense to bond an internal interface, so the terms ‘‘port’’ and ‘‘interface’’ are often used imprecisely for internal interfaces.
Open vSwitch checks the interface state before send packets to the device. When it is down, the packets are dropped and the tx_dropped statistic is updated accordingly. Older versions of Open vSwitch did not check the interface state and then the tx_packets was incremented along with tx_dropped.
Open vSwitch uses IANA-assigned UDP destination port 4789. The source port used for VXLAN traffic varies on a per-flow basis and is in the ephemeral port range.
Only IPv4 and IPv6 packets are supported by the protocol, and they are sent and received without an Ethernet header. Traffic to/from LISP ports is expected to be configured explicitly, and the ports are not intended to participate in learning based switching. As such, they are always excluded from packet flooding.
The protocol is documented at http://www.3gpp.org/DynaReport/29281.htm Open vSwitch uses UDP destination port 2152. The source port used for GTP traffic varies on a per-flow basis and is in the ephemeral port range. Bareudp The Bareudp tunnel provides a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP, NSH etc. inside a UDP tunnel. Tunnel Options: These options apply to interfaces with type of geneve, bareudp, gre, ip6gre, vxlan, lisp and stt. Each tunnel must
be uniquely identified by the combination of type,
options:remote_ip, options:local_ip, and
options:in_key. 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 first.
options:in_key is considered more specific than
options:local_ip if a port defines one and another
port defines the other. options:in_key is not
applicable for bareudp tunnels. Hence it is not considered
while identifying a bareudp tunnel. Required. The remote tunnel endpoint, one of:
The remote tunnel endpoint for any packet received from a tunnel is available in the tun_src field for matching in the flow table. options : local_ip: optional string Optional. The tunnel destination IP that received packets must match. Default is to match all addresses. If specified, may be one of:
This option is valid only for tunnels also configured with the remote_ip=flow option. The tunnel destination IP address for any packet received from a tunnel is available in the tun_dst or tun_ipv6_dst field for matching in the flow table. options : in_key: optional string Optional, not applicable for bareudp. The key that received packets must contain, one of:
options : out_key: optional string Optional, not applicable for bareudp. The key to be set on outgoing packets, one of:
options : dst_port: optional string Optional. The tunnel transport layer destination port, for UDP and TCP based tunnel protocols (Geneve, VXLAN, LISP, and STT). options : key: optional string Optional. Shorthand to set in_key and out_key at the same time. options : tos: optional string Optional. The value of the ToS bits to be set on the encapsulating packet. ToS is interpreted as DSCP and ECN bits, ECN part must be zero. 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). The ECN fields are always inherited. Default is 0. options : ttl: optional string Optional. The TTL to be set on the encapsulating packet. 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). Default is the system default TTL. options : df_default: optional string, either true or false Optional. If enabled, the Don’t Fragment bit will be set on tunnel outer headers to allow path MTU discovery. Default is enabled; set to false to disable. options : egress_pkt_mark: optional string Optional. The pkt_mark to be set on the encapsulating packet. This option sets packet mark for the tunnel endpoint for all tunnel packets including tunnel monitoring. Tunnel Options: lisp only: options : packet_type: optional string, either legacy_l3 or ptap A LISP tunnel sends and receives only IPv4 and IPv6 packets. This option controls what how the tunnel represents the packets that it sends and receives:
Tunnel Options: vxlan only: options : exts: optional string Optional. Comma separated list of optional VXLAN extensions to enable. The following extensions are supported:
options : packet_type:
optional string, one of legacy_l2, legacy_l3,
or This option controls what types of packets the tunnel sends and receives and how it represents them:
Tunnel Options: gre only: gre
interfaces support these options. This option controls what types of packets the tunnel sends and receives and how it represents them:
options : seq: optional string, either true or false Optional. A 4-byte sequence number field for GRE tunnel only. Default is disabled, set to true to enable. Sequence number is incremented by one on each outgoing packet. Tunnel Options: gre, ip6gre, geneve, bareudp and vxlan: gre,
ip6gre, geneve, bareudp and
vxlan interfaces support these options. Optional. Compute encapsulation header (either GRE or UDP) checksums on outgoing packets. Default is disabled, set to true to enable. Checksums present on incoming packets will be validated regardless of this setting. When using the upstream Linux kernel module, computation of checksums for geneve and vxlan requires Linux kernel version 4.0 or higher. gre and ip6gre support checksums for all versions of Open vSwitch that support GRE. The out of tree kernel module distributed as part of OVS can compute all tunnel checksums on any kernel version that it is compatible with. Tunnel Options: IPsec: Setting any of
these options enables IPsec support for a given tunnel.
gre, geneve, vxlan and stt
interfaces support these options. See the IPsec
section in the Open_vSwitch table for a description
of each mode. In PSK mode only, the preshared secret to negotiate tunnel. This value must match on both tunnel ends. options : remote_cert: optional string In self-signed certificate mode only, name of a PEM file containing a certificate of the remote switch. The certificate must be x.509 version 3 and with the string in common name (CN) also set in the subject alternative name (SAN). options : remote_name: optional string In CA-signed certificate mode only, common name (CN) of the remote certificate. Tunnel Options: erspan only: Only
erspan interfaces support these options. 20 bit index/port number associated with the ERSPAN traffic’s source port and direction (ingress/egress). This field is platform dependent. options : erspan_ver: optional string ERSPAN version: 1 for version 1 (type II) or 2 for version 2 (type III). options : erspan_dir: optional string Specifies the ERSPAN v2 mirrored traffic’s direction. 1 for egress traffic, and 0 for ingress traffic. options : erspan_hwid: optional string ERSPAN hardware ID is a 6-bit unique identifier of an ERSPAN v2 engine within a system. Tunnel Options: Bareudp only: options : payload_type: optional string Specifies the ethertype of the l3 protocol the bareudp device is tunnelling. For the tunnels which supports multiple ethertypes of a l3 protocol (IP, MPLS) this field specifies the protocol name as a string. Patch Options: These options apply only to patch ports, that is, interfaces whose type column is patch. Patch ports are mainly a way to connect otherwise independent bridges to one another, similar to how one might plug an Ethernet cable (a ‘‘patch cable’’) into two physical switches to connect those switches. The effect of plugging a patch port into two switches is conceptually similar to that of plugging the two ends of a Linux veth device into those switches, but the implementation of patch ports makes them much more efficient. Patch ports may connect two different bridges (the usual case) or the same bridge. In the latter case, take special care to avoid loops, e.g. by programming appropriate flows with OpenFlow. Patch ports do not work if its ends are attached to bridges on different datapaths, e.g. to connect bridges in system and netdev datapaths. The following command creates and connects patch ports p0 and p1 and adds them to bridges br0 and br1, respectively: ovs−vsctl
add−port br0 p0 −− set Interface p0
type=patch options:peer=p1 \ The name of the Interface for the other side of the patch. The named Interface’s own peer option must specify this Interface’s name. That is, the two patch interfaces must have reversed name and peer values. PMD (Poll Mode Driver) Options: Only PMD netdevs
support these options. Specifies the maximum number of rx queues to be created for PMD netdev. If not specified or specified to 0, one rx queue will be created by default. Not supported by DPDK vHost interfaces. options : dpdk-devargs: optional string Specifies the PCI address associated with the port for physical devices, or the virtual driver to be used for the port when a virtual PMD is intended to be used. For the latter, the argument string typically takes the form of eth_driver_namex, where driver_name is a valid virtual DPDK PMD driver name and x is a unique identifier of your choice for the given port. Only supported by the dpdk port type. other_config : pmd-rxq-affinity: optional string Specifies mapping of RX queues of this interface to CPU cores. Value should be set in the following form: other_config:pmd−rxq−affinity=<rxq−affinity−list> where
options : xdp-mode:
optional string, one of best−effort,
generic, Specifies the operational mode of the XDP program. In native−with−zerocopy mode the XDP program is loaded into the device driver with zero-copy RX and TX enabled. This mode requires device driver support and has the best performance because there should be no copying of packets. native is the same as native−with−zerocopy, but without zero-copy capability. This requires at least one copy between kernel and the userspace. This mode also requires support from device driver. In generic case the XDP program in kernel works after skb allocation on early stages of packet processing inside the network stack. This mode doesn’t require driver support, but has much lower performance. best−effort tries to detect and choose the best (fastest) from the available modes for current interface. Note that this option is specific to netdev-afxdp. Defaults to best−effort mode. options : use-need-wakeup: optional string, either true or false Specifies whether to use need_wakeup feature in afxdp netdev. If enabled, OVS explicitly wakes up the kernel RX, using poll() syscall and wakes up TX, using sendto() syscall. For physical devices, this feature improves the performance by avoiding unnecessary sendto syscalls. Defaults to true if supported by libbpf. options : vhost-server-path: optional string The value specifies the path to the socket associated with a vHost User client mode device that has been or will be created by QEMU. Only supported by dpdkvhostuserclient interfaces. options : tx-retries-max:
optional string, containing an integer, in The value specifies the maximum amount of vhost tx retries that can be made while trying to send a batch of packets to an interface. Only supported by dpdkvhostuserclient interfaces. Default value is 8. options : n_rxq_desc:
optional string, containing an integer, in range Specifies the rx queue size (number rx descriptors) for dpdk ports. The value must be a power of 2, less than 4096 and supported by the hardware of the device being configured. If not specified or an incorrect value is specified, 2048 rx descriptors will be used by default. options : n_txq_desc:
optional string, containing an integer, in range Specifies the tx queue size (number tx descriptors) for dpdk ports. The value must be a power of 2, less than 4096 and supported by the hardware of the device being configured. If not specified or an incorrect value is specified, 2048 tx descriptors will be used by default. options : dpdk-vf-mac: optional string Ethernet address to set for this VF interface. If unset then the default MAC address is used:
This option may only be used with dpdk VF representors. other_config : tx-steering: optional string, either hash or thread Specifies the Tx steering mode for the interface. thread enables static (1:1) thread-to-txq mapping when the number of Tx queues is greater than number of PMD threads, and dynamic (N:1) mapping if equal or lower. In this mode a single thread can not use more than 1 transmit queue of a given port. hash enables hash-based Tx steering, which distributes the packets on all the transmit queues based on their 5-tuples hashes. Defaults to thread. EMC (Exact Match Cache) Configuration: These settings
controls behaviour of EMC lookups/insertions for packets
received from the interface. Specifies if Exact Match Cache (EMC) should be used while processing packets received from this interface. If true, other_config:emc-insert-inv-prob will have effect on this interface. Defaults to true. MTU: The MTU (maximum transmission unit) is the largest amount of data that can fit into a single Ethernet frame. The standard Ethernet MTU is 1500 bytes. Some physical media and many kinds of virtual interfaces can be configured with higher MTUs. A client may
change an interface MTU by filling in mtu_request.
Open vSwitch then reports in mtu the currently
configured value. The currently configured MTU for the interface. This column will be empty for an interface that does not have an MTU as, for example, some kinds of tunnels do not. Open vSwitch sets this column’s value, so other clients should treat it as read-only. mtu_request: optional integer, at least 1 Requested MTU (Maximum Transmission Unit) for the interface. A client can fill this column to change the MTU of an interface. RFC 791 requires every internet module to be able to forward a datagram of 68 octets without further fragmentation. The maximum size of an IP packet is 65535 bytes. If this is not set and if the interface has internal type, Open vSwitch will change the MTU to match the minimum of the other interfaces in the bridge. Interface Status: Status
information about interfaces attached to bridges, updated
every 5 seconds. Not all interfaces have all of these
properties; virtual interfaces don’t have a link
speed, for example. Non-applicable columns will have empty
values. The administrative state of the physical network link. link_state: optional string, either down or up The observed state of the physical network link. This is ordinarily the link’s carrier status. If the interface’s Port is a bond configured for miimon monitoring, it is instead the network link’s miimon status. link_resets: optional integer The number of times Open vSwitch has observed the link_state of this Interface change. link_speed: optional integer The negotiated speed of the physical network link. Valid values are positive integers greater than 0. duplex: optional string, either full or half The duplex mode of the physical network link. lacp_current: optional boolean Boolean value indicating LACP status for this interface. If true, this interface has current LACP information about its LACP partner. This information may be used to monitor the health of interfaces in a LACP enabled port. This column will be empty if LACP is not enabled. status: map of string-string pairs Key-value pairs that report port status. Supported status values are type-dependent; some interfaces may not have a valid status:driver_name, for example. status : driver_name: optional string The name of the device driver controlling the network adapter. status : driver_version: optional string The version string of the device driver controlling the network adapter. status : firmware_version: optional string The version string of the network adapter’s firmware, if available. status : source_ip: optional string The source IP address used for an IPv4/IPv6 tunnel end-point, such as gre. status : tunnel_egress_iface: optional string Egress interface for tunnels. 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_ip. This could be an internal interface such as a bridge port. status :
tunnel_egress_iface_carrier: optional string, either
down or Whether carrier is detected on status:tunnel_egress_iface. dpdk: DPDK specific
interface status options. DPDK port ID. status : numa_id: optional string NUMA socket ID to which an Ethernet device is connected. status : min_rx_bufsize: optional string Minimum size of RX buffer. status : max_rx_pktlen: optional string Maximum configurable length of RX pkt. status : max_rx_queues: optional string Maximum number of RX queues. status : max_tx_queues: optional string Maximum number of TX queues. status : max_mac_addrs: optional string Maximum number of MAC addresses. status : max_hash_mac_addrs: optional string Maximum number of hash MAC addresses for MTA and UTA. status : max_vfs: optional string Maximum number of hash MAC addresses for MTA and UTA. Maximum number of VFs. status : max_vmdq_pools: optional string Maximum number of VMDq pools. status : if_type: optional string Interface type ID according to IANA ifTYPE MIB definitions. status : if_descr: optional string Interface description string. status : pci-vendor_id: optional string Vendor ID of PCI device. status : pci-device_id: optional string Device ID of PCI device. status : dpdk-vf-mac: optional string Ethernet address set for this VF interface. Only reported for dpdk VF representors. Statistics: Key-value pairs that report interface statistics. The current implementation updates these counters periodically. The update period is controlled by other_config:stats-update-interval in the Open_vSwitch table. Future implementations may update them when an interface is created, when they are queried (e.g. 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 basis. These are the same statistics reported by OpenFlow in its struct ofp_port_stats structure. If an interface does not support a given statistic, then that pair is omitted. Statistics: Successful transmit and receive counters: statistics : rx_packets: optional integer Number of received packets. statistics : rx_bytes: optional integer Number of received bytes. statistics : tx_packets: optional integer Number of transmitted packets. statistics : tx_bytes: optional integer Number of transmitted bytes. Statistics: Receive errors: statistics : rx_dropped: optional integer Number of packets dropped by RX. statistics : rx_frame_err: optional integer Number of frame alignment errors. statistics : rx_over_err: optional integer Number of packets with RX overrun. statistics : rx_crc_err: optional integer Number of CRC errors. statistics : rx_errors: optional integer Total number of receive errors, greater than or equal to the sum of the above. Statistics: Transmit errors: statistics : tx_dropped: optional integer Number of packets dropped by TX. statistics : collisions: optional integer Number of collisions. statistics : tx_errors: optional integer Total number of transmit errors, greater than or equal to the sum of the above. Ingress Policing: These settings control ingress policing for packets received on this interface. 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 transmit. Policing is a simple form of quality-of-service that simply drops packets received in excess of the configured rate. Due to its simplicity, policing is usually less accurate and less effective than egress QoS (which is configured using the QoS and Queue tables). Policing settings can be set with byte rate or packet rate, and they can be configured together, in which case they take effect together, that means the smaller speed limit of them is in effect. Currently, byte rate policing is implemented on Linux and OVS with DPDK, while packet rate policing is only implemented on Linux. Both Linux and OVS DPDK implementations use a simple ‘‘token bucket’’ approach. Byte rate policing:
Packet rate policing:
Policing
interacts badly with some network protocols, and especially
with fragmented IP packets. Suppose that there is enough
network activity to keep the bucket nearly empty all the
time. Then this token bucket algorithm will forward a single
packet every so often, with the period depending on packet
size and on the configured rate. All of the fragments of an
IP packets are normally transmitted back-to-back, as a
group. In such a situation, therefore, only one of these
fragments will be forwarded and the rest will be dropped. IP
does not provide any way for the intended recipient to ask
for only the remaining fragments. 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). Either way, it is possible that no forward
progress will ever occur. Maximum rate for data received on this interface, in kbps. Data received faster than this rate is dropped. Set to 0 (the default) to disable policing. ingress_policing_kpkts_rate: integer, at least 0 Maximum rate for data received on this interface, in kpps (1 kpps is 1000 pps). Data received faster than this rate is dropped. Set to 0 (the default) to disable policing. ingress_policing_burst: integer, at least 0 Maximum burst size for data received on this interface, in kb. The default burst size if set to 0 is 8000 kbit. This value has no effect if ingress_policing_rate is 0. Specifying a larger burst size lets the algorithm be more forgiving, which is important for protocols like TCP that react severely to dropped packets. The burst size should be at least the size of the interface’s MTU. Specifying a value that is numerically at least as large as 80% of ingress_policing_rate helps TCP come closer to achieving the full rate. ingress_policing_kpkts_burst: integer, at least 0 Maximum burst size for data received on this interface, in kpkts (1 kpkts is 1000 packets). The default burst size if set to 0 is 16 kpkts. This value has no effect if ingress_policing_kpkts_rate is 0. Specifying a larger burst size lets the algorithm be more forgiving, which is important for protocols like TCP that react severely to dropped packets. Specifying a value that is numerically at least as large as 80% of ingress_policing_kpkts_rate helps TCP come closer to achieving the full rate. 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 messages. Open vSwitch implements BFD to serve as a more popular and standards compliant alternative to CFM. BFD operates by regularly transmitting BFD control messages at a rate negotiated independently in each direction. Each endpoint specifies the rate at which it expects to receive control messages, and the rate at which it is willing to transmit them. By default, Open vSwitch uses a detection multiplier of three, meaning that an endpoint signals a connectivity fault if three consecutive BFD control messages fail to arrive. 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 transmits. The Open vSwitch implementation of BFD aims to comply faithfully with RFC 5880 requirements. Open vSwitch does not implement the optional Authentication or ‘‘Echo Mode’’ features. OVS 2.13 and earlier intercepted and processed all BFD packets. OVS 2.14 and later only intercept and process BFD packets destined to a configured BFD instance, and other BFD packets are made available to the OVS flow table for forwarding. BFD Configuration: A controller
sets up key-value pairs in the bfd column to enable
and configure BFD. True to enable BFD on this Interface. If not specified, BFD will not be enabled by default. 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 messages. The remote endpoint may choose to send messages at a slower rate. Defaults to 1000. 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 messages. Messages will actually be transmitted at a slower rate if the remote endpoint is not willing to receive as quickly as specified. Defaults to 100. 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_rx. 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 interface. This feature may be disabled by setting a value of 0. This feature is reset whenever bfd:decay_min_rx or bfd:min_rx changes. 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/O. BFD control packets are still transmitted and received. At least one BFD control packet must be received every 100 * bfd:min_rx amount of time. Otherwise, even if traffic are received, the bfd:forwarding will be false. 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 monitored. The typical underlying reason is ‘‘concatenated path down,’’ that is, that connectivity beyond the local system is down. Defaults to false. 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 zero. By default, BFD accepts control messages with any tunnel key. 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 packets. The default is the mac address of the BFD enabled interface. 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 packets. The default is 00:23:20:00:00:01. 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 packets. Packets with different destination MAC will not be considered as BFD packets. If not specified the destination MAC address of received BFD packets are not checked. bfd : bfd_src_ip: optional string Set to an IPv4 address to set the IP address used as source for transmitted BFD packets. The default is 169.254.1.1. bfd : bfd_dst_ip: optional string Set to an IPv4 address to set the IP address used as destination for transmitted BFD packets. The default is 169.254.1.0. bfd : oam: optional string Some tunnel protocols (such as Geneve) include a bit in the header to indicate that the encapsulated packet is an OAM frame. By setting this to true, BFD packets will be marked as OAM if encapsulated in one of these tunnels. bfd : mult: optional string, containing an integer, in range 1 to 255 The BFD detection multiplier, which defaults to 3. An endpoint signals a connectivity fault if the given number of consecutive BFD control messages fail to arrive. BFD Status: The switch sets
key-value pairs in the bfd_status column to report
the status of BFD on this interface. When BFD is not
enabled, with bfd:enable, the switch clears all
key-value pairs from bfd_status. Reports the state of the BFD session. The BFD session is fully healthy and negotiated if UP. bfd_status : forwarding: optional string, either true or false Reports whether the BFD session believes this Interface may be used to forward traffic. Typically this means the local session is signaling UP, and the remote system isn’t signaling a problem such as concatenated path down. bfd_status : diagnostic: optional string A diagnostic code specifying the local system’s reason for the last change in session state. The error messages are defined in section 4.1 of [RFC 5880]. bfd_status :
remote_state: optional string, one of admin_down,
down, Reports the state of the remote endpoint’s BFD session. bfd_status : remote_diagnostic: optional string A diagnostic code specifying the remote system’s reason for the last change in session state. The error messages are defined in section 4.1 of [RFC 5880]. bfd_status : flap_count:
optional string, containing an integer, at Counts the number of bfd_status:forwarding flaps since start. A flap is considered as a change of the bfd_status:forwarding value. Connectivity Fault Management: 802.1ag Connectivity Fault Management (CFM) allows a group of Maintenance Points (MPs) called a Maintenance Association (MA) to detect connectivity problems with each other. MPs within a MA should have complete and exclusive interconnectivity. This is verified by occasionally broadcasting Continuity Check Messages (CCMs) at a configurable transmission interval. According to the 802.1ag specification, each Maintenance Point should be configured out-of-band with a list of Remote Maintenance Points it should have connectivity to. Open vSwitch differs from the specification in this area. It simply assumes the link is faulted if no Remote Maintenance Points are reachable, and considers it not faulted otherwise. When operating
over tunnels which have no in_key, or an
in_key of flow. CFM will only accept CCMs with
a tunnel key of zero. A Maintenance Point ID (MPID) uniquely identifies each endpoint within a Maintenance Association. The MPID is used to identify this endpoint to other Maintenance Points in the MA. Each end of a link being monitored should have a different MPID. Must be configured to enable CFM on this Interface. According to the 802.1ag specification, MPIDs can only range between [1, 8191]. However, extended mode (see other_config:cfm_extended) supports eight byte MPIDs. cfm_flap_count: optional integer Counts the number of cfm fault flapps since boot. A flap is considered to be a change of the cfm_fault value. cfm_fault: optional boolean Indicates a connectivity fault triggered by an inability to receive heartbeats from any remote endpoint. When a fault is triggered on Interfaces participating in bonds, they will be disabled. Faults can be triggered for several reasons. Most importantly they are triggered when no CCMs are received for a period of 3.5 times the transmission interval. Faults are also triggered when any CCMs indicate that a Remote Maintenance Point is not receiving CCMs but able to send them. Finally, a fault is triggered if a CCM is received which indicates unexpected configuration. Notably, this case arises when a CCM is received which advertises the local MPID. cfm_fault_status : recv: none Indicates a CFM fault was triggered due to a lack of CCMs received on the Interface. cfm_fault_status : rdi: none Indicates a CFM fault was triggered due to the reception of a CCM with the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they are not receiving CCMs themselves. This typically indicates a unidirectional connectivity failure. 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 uses. CFM broadcasts are tagged with an identification number in addition to the MPID called the MAID. Open vSwitch only supports receiving CCM broadcasts tagged with the MAID it uses internally. 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 Interface. This may indicate a loop in the network. 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 of. cfm_fault_status : override: none Indicates a CFM fault was manually triggered by an administrator using an ovs−appctl command. cfm_fault_status : interval: none Indicates a CFM fault was triggered due to the reception of a CCM frame having an invalid interval. 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 down. See other_config:cfm_opstate. 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_intervals. The health of an interface is undefined if it is communicating with more than one cfm_remote_mpids. It reduces if healthy heartbeats are not received at the expected rate, and gradually improves as healthy heartbeats are received at the desired rate. Every 21 other_config:cfm_intervals, the health of the interface is refreshed. As mentioned above, the faults can be triggered for several reasons. The link health will deteriorate even if heartbeats are received but they are reported to be unhealthy. An unhealthy heartbeat in this context is a heartbeat for which either some fault is set or is out of sequence. The interface health can be 100 only on receiving healthy heartbeats at the desired rate. cfm_remote_mpids: set of integers When CFM is properly configured, Open vSwitch will occasionally receive CCM broadcasts. These broadcasts contain the MPID of the sending Maintenance Point. The list of MPIDs from which this Interface is receiving broadcasts from is regularly collected and written to this column. other_config : cfm_interval: optional string, containing an integer The interval, in milliseconds, between transmissions of CFM heartbeats. Three missed heartbeat receptions indicate a connectivity fault. In standard operation only intervals of 3, 10, 100, 1,000, 10,000, 60,000, or 600,000 ms are supported. Other values will be rounded down to the nearest value on the list. Extended mode (see other_config:cfm_extended) supports any interval up to 65,535 ms. In either mode, the default is 1000 ms. We do not recommend using intervals less than 100 ms. other_config : cfm_extended: optional string, either true or false When true, the CFM module operates in extended mode. This causes it to use a nonstandard destination address to avoid conflicting with compliant implementations which may be running concurrently on the network. Furthermore, extended mode increases the accuracy of the cfm_interval configuration parameter by breaking wire compatibility with 802.1ag compliant implementations. And extended mode allows eight byte MPIDs. Defaults to false. 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 mode. When in demand mode, traffic received on the Interface is used to indicate liveness. CCMs are still transmitted and received. At least one CCM must be received every 100 * other_config:cfm_interval amount of time. Otherwise, even if traffic are received, the CFM module will raise the connectivity fault. Demand mode has a couple of caveats:
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 fault. This allows remote maintenance points to choose not to forward traffic to the Interface on which this CFM module is running. Currently, in Open vSwitch, the opdown bit of CCMs affects Interfaces participating in bonds, and the bundle OpenFlow action. This setting is ignored when CFM is not in extended mode. Defaults to up. other_config :
cfm_ccm_vlan: optional string, containing an integer, in
When set, the CFM module will apply a VLAN tag to all CCMs it generates with the given value. May be the string random in which case each CCM will be tagged with a different randomly generated VLAN. other_config :
cfm_ccm_pcp: optional string, containing an integer, in
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_vlan. If other_config:cfm_ccm_vlan is unset, a VLAN ID of zero is used. Bonding Configuration: other_config :
lacp-port-id: optional string, containing an integer, in
The LACP port ID of this Interface. Port IDs are used in LACP negotiations to identify individual ports participating in a bond. other_config :
lacp-port-priority: optional string, containing an The LACP port priority of this Interface. In LACP negotiations Interfaces with numerically lower priorities are preferred for aggregation. other_config :
lacp-aggregation-key: optional string, containing an
The LACP aggregation key of this Interface. Interfaces with different aggregation keys may not be active within a given Port at the same time. Virtual Machine Identifiers: These key-value
pairs specifically apply to an interface that represents a
virtual Ethernet interface connected to a virtual machine.
These key-value pairs should not be present for other types
of interfaces. Keys whose names end in −uuid
have values that uniquely identify the entity in question.
For a Citrix XenServer hypervisor, these values are UUIDs in
RFC 4122 format. Other hypervisors may use other formats.
The MAC address programmed into the ‘‘virtual hardware’’ for this interface, in the form xx:xx:xx:xx:xx:xx. For Citrix XenServer, this is the value of the MAC field in the VIF record for this interface. external_ids : iface-id: optional string A system-unique identifier for the interface. On XenServer, this will commonly be the same as external_ids:xs-vif-uuid. 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 time. 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 time. A hypervisor that behaves this way must mark the currently in use interface active and the others inactive. 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 entirely. During VM migration, a given external_ids:iface-id might transiently be marked active on two different hypervisors. That is, active means that this external_ids:iface-id is the active instance within a single hypervisor, not in a broader scope. There is one exception: some hypervisors support ‘‘migration’’ from a given hypervisor to itself (most often for test purposes). During such a ‘‘migration,’’ two instances of a single external_ids:iface-id might both be briefly marked active on a single hypervisor. external_ids : xs-vif-uuid: optional string The virtual interface associated with this interface. external_ids : xs-network-uuid: optional string The virtual network to which this interface is attached. external_ids : vm-id: optional string The VM to which this interface belongs. On XenServer, this will be the same as external_ids:xs-vm-uuid. external_ids : xs-vm-uuid: optional string The VM to which this interface belongs. Auto Attach Configuration: Auto Attach
configuration for a particular interface. True to enable LLDP on this Interface. If not specified, LLDP will be disabled by default. Flow control Configuration: Ethernet flow
control defined in IEEE 802.1Qbb provides link level flow
control using MAC pause frames. Implemented only for
interfaces with type dpdk. Set to true to enable Rx flow control on physical ports. By default, Rx flow control is disabled. options : tx-flow-ctrl: optional string, either true or false Set to true to enable Tx flow control on physical ports. By default, Tx flow control is disabled. options : flow-ctrl-autoneg: optional string, either true or false Set to true to enable flow control auto negotiation on physical ports. By default, auto-neg is disabled. Link State Change detection mode: options : dpdk-lsc-interrupt: optional string, either true or false Set this value to true to configure interrupt mode for Link State Change (LSC) detection instead of poll mode for the DPDK interface. If this value is not set, poll mode is configured. This parameter has an effect only on netdev dpdk interfaces. Common Columns: The overall
purpose of these columns is described under Common
Columns at the beginning of this document. Flow_Table TABLEConfiguration for a particular OpenFlow table. Summary:
Eviction Policy:
Classifier Optimization:
Common Columns:
Details:name: optional string The table’s name. Set this column to change the name that controllers will receive when they request table statistics, e.g. ovs−ofctl dump−tables. The name does not affect switch behavior. Eviction Policy: Open vSwitch supports limiting the number of flows that may be installed in a flow table, via the flow_limit column. 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:
When a flow must be evicted due to overflow, the flow to evict is chosen through an approximation of the following algorithm. This algorithm is used regardless of how eviction was enabled:
|