xe host-list.
+
+
+ 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.
+
+ Thus, with this option, the procedure for a hot-upgrade of
+ ovs-vswitchd becomes roughly the following:
+
ovs-vswitchd.
+ true.
+ ovs-vswitchd.
+ ovs-ofctl (or some other program, such as an
+ OpenFlow controller) to restore the OpenFlow flow table
+ to the desired state.
+ false (or remove it entirely from the database).
+
+ The ovs-ctl's ``restart'' and ``force-reload-kmod''
+ functions use the above config option during hot upgrades.
+
+ A number of flows as a nonnegative integer. This sets number of + flows at which eviction from the datapath flow table will be + triggered. If there are a large number of flows then increasing this + value to around the number of flows present can result in reduced CPU + usage and packet loss. +
++ The default is 2500. Values below 100 will be rounded up to 100. +
++ Specifies userspace behaviour for handling flow misses. This takes + precedence over flow-eviction-threshold. +
++
autowith-facetswithout-facets
The statistics column contains key-value pairs that
@@ -241,8 +320,6 @@
1.1.0.
- If Open vSwitch was configured with a build number, then it is
- also included, e.g. 1.1.0+build6579.
If this value is unset, the default is implementation-specific.
+
+ 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 ).
+
When more than one controller is configured, is considered only when none of the configured controllers can be contacted.
@@ -440,6 +530,12 @@ value. May not be all-zero. +switch3 in room 3120.
+ true, disable in-band control on the bridge
@@ -454,6 +550,12 @@
QoS configured, or if the port does not have a queue with the specified
ID, the default queue is used instead.
OpenFlow10 will be used if this column is empty.
+ - A number of flows as a nonnegative integer. This sets number of - flows at which eviction from the kernel flow table will be triggered. - If there are a large number of flows then increasing this value to - around the number of flows present can result in reduced CPU usage - and packet loss. -
-- The default is 1000. Values below 100 will be rounded up to 100. -
-true to enable.
+
+ The following destination MAC addresss will not be forwarded when this
+ option is enabled.
+ 01:80:c2:00:00:0001:80:c2:00:00:0101:80:c2:00:00:0x00:e0:2b:00:00:0000:e0:2b:00:00:04 and 00:e0:2b:00:00:06
+ 01:00:0c:cc:cc:cc01:00:0c:cc:cc:cd01:00:0c:cd:cd:cd01:00:0c:00:00:0001:00:0c:cc:cc:cx+ The maximum number of MAC addresses to learn. The default is + currently 2048. The value, if specified, is forced into a reasonable + range, currently 10 to 1,000,000. +
+A port that has more than one interface is a ``bonded port.'' Bonding - allows for load balancing and fail-over. Some kinds of bonding will - work with any kind of upstream switch:
+ 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-slbactive-backupstableAttempts to always assign a given flow to the same slave
- consistently. In an effort to maintain stability, no load
- balancing is done. Uses a similar hashing strategy to
- balance-tcp, always taking into account L3 and L4
- fields even if LACP negotiations are unsuccessful.
Slave selection decisions are made based on if set. Otherwise,
- OpenFlow port number is used. Decisions are consistent across all
- ovs-vswitchd instances with equivalent
-
- values.
These columns apply only to bonded ports. Their values are
@@ -851,7 +979,7 @@
- The number of milliseconds for which carrier must stay up on an
+ The number of milliseconds for which the link must stay up on an
interface before the interface is considered to be up. Specify
The LACP timing which should be used on this .
- Possible values are
- Users may manually set a heartbeat transmission rate to increase
- the fault detection speed further. When manually set, OVS expects
- the partner switch to be configured with the same transmission
- rate. Manually setting 0 to enable the interface immediately.
0 to disable the interface immediately.
fast, slow and a
- positive number of milliseconds. 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.
- lacp-time to something other
- than fast or slow is not supported by the
- LACP specification.
+ 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.
false.
-
These settings control behavior when a bond is in
- balance-slb mode, regardless of whether the bond was
- intentionally configured in SLB mode or it fell back to SLB mode
- because LACP negotiation failed.
+ balance-slb or balance-tcp mode.
Ethernet address to set for this interface. If unset then the default MAC address is used:
@@ -1131,6 +1244,20 @@ port number for the OpenFlow ``local port''). If the interface cannot be added then Open vSwitch sets this column to -1. +When is not set, Open vSwitch picks + an appropriate value for this column and then tries to keep the value + constant across restarts.
+Requested OpenFlow port number for this interface. The port + number must be between 1 and 65279, inclusive. Some datapaths + cannot satisfy all requests for particular port numbers. When + this column is empty or the request cannot be fulfilled, the + system will choose a free port. The + column reports the assigned OpenFlow port number.
+The port number must be requested in the same transaction + that creates the port.
greipsec_grecapwapgre64ipsec_gre64vxlan
+ An Ethernet tunnel over the experimental, UDP-based VXLAN
+ protocol described at
+ http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03.
+ VXLAN is currently supported only with the Linux kernel datapath
+ with kernel version 2.6.26 or later.
+
+ Open vSwitch uses UDP destination port 4789. The source port used for + VXLAN traffic varies on a per-flow basis and is in the ephemeral port + range. +
+lispnull
These options apply to interfaces with of
- gre, ipsec_gre, and capwap.
+ gre, ipsec_gre, gre64,
+ ipsec_gre64, vxlan, and lisp.
@@ -1211,22 +1367,67 @@
- Required. The tunnel endpoint. Unicast and multicast endpoints are - both supported. -
+Required. The remote tunnel endpoint, one of:
+ +192.168.0.123.
+ Only unicast endpoints are supported.
+ flow. The tunnel accepts packets from any
+ remote tunnel endpoint. To process only packets from a specific
+ remote tunnel endpoint, the flow entries may match on the
+ tun_src field. When sending packets to a
+ remote_ip=flow tunnel, the flow actions must
+ explicitly set the tun_dst field to the IP address of
+ the desired remote tunnel endpoint, e.g. with a
+ set_field action.
+
- When a multicast endpoint is specified, a routing table lookup occurs
- only when the tunnel is created. Following a routing change, delete
- and then re-create the tunnel to force a new routing table lookup.
+ The remote tunnel endpoint for any packet received from a tunnel
+ is available in the tun_src field for matching in the
+ flow table.
+ Optional. The tunnel destination IP that received packets must + match. Default is to match all addresses. If specified, may be one + of: +
+ +192.168.12.3.
+ flow. The tunnel accepts packets sent to any
+ of the local IP addresses of the system running OVS. To process
+ only packets sent to a specific IP address, the flow entries may
+ match on the tun_dst field. When sending packets to a
+ local_ip=flow tunnel, the flow actions may
+ explicitly set the tun_src field to the desired IP
+ address, e.g. with a set_field action. However, while
+ routing the tunneled packet out, the local system may override the
+ specified address with the local IP address configured for the
+ outgoing system interface.
+
+
+ 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 field for matching in
+ the flow table.
+
flow. The tunnel accepts packets with any
@@ -1265,8 +1467,9 @@
key="out_key"/> at all.
flow. Packets sent through the tunnel will
@@ -1285,7 +1488,8 @@
inherit, in which case
+ 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.
@@ -1298,48 +1502,13 @@
system default, typically 64). Default is the system default TTL.
true to
- enable.
- df_inherit option is not set, or if
- the encapsulated packet is not IP. Default is enabled; set to
- false to disable.
+ 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.
false to disable.
-
- Only gre interfaces support these options.
-
iptables) and it may be useful to disable it if these
- features are required or as a debugging measure. Default is enabled,
- set to false to disable.
-
Only gre and ipsec_gre interfaces support
@@ -1499,15 +1668,15 @@
gre or capwap.
+ gre.
+ BFD, defined in RFC 5880 and RFC 5881, allows point to point + detection of connectivity failures by occasional transmission of + BFD control messages. It is implemented in Open vSwitch 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's willing to transmit them. Open vSwitch + uses a detection multiplier of three, meaning that an endpoint + which fails to receive BFD control messages for a period of three + times the expected reception rate, will signal a connectivity + fault. In the case of a unidirectional connectivity issue, the + system not receiving BFD control messages will signal the problem + to its peer in the messages is transmists. +
+ ++ The Open vSwitch implementation of BFD aims to comply faithfully + with the requirements put forth in RFC 5880. Currently, the only + known omission is ``Demand Mode'', which we hope to include in + future. Open vSwitch does not implement the optional + Authentication or ``Echo Mode'' features. +
+ +true BFD is enabled on this
+ , otherwise it's disabled. Defaults to
+ false.
+ 1000.
+ 100.
+ cpath_down to
+ true which may cause the remote BFD session not to
+ forward traffic to this . Defaults to
+ false.
+ UP.
+ UP, and the remote system isn't signaling a
+ problem such as concatenated path down.
+ 802.1ag Connectivity Fault Management (CFM) allows a group of @@ -1673,6 +1934,12 @@ 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.
+
ovs-appctl command.
+ When in extended mode, indicates the operational state of the
+ remote endpoint as either up or down. See
+ .
+
+ Indicates the health of the interface as a percentage of CCM frames + received over 21 s. + The health of an interface is undefined if it is communicating with + more than one . 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 s, 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. +
++ 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 ) 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.
+ When true, and
+ is true, the CFM
+ module operates in demand mode. When in demand mode, traffic
+ received on the is used to indicate
+ liveness. CCMs are still transmitted and received, but if the
+ is receiving traffic, their absence does not
+ cause a connectivity fault.
+
+ Demand mode has a couple of caveats: +
down, the CFM module marks all CCMs it generates as
@@ -1739,13 +2125,14 @@
random in which
+ case each CCM will be tagged with a different randomly generated VLAN.
stable bond mode to make slave
- selection decisions. Allocating values consistently across interfaces
- participating in a bond will guarantee consistent slave selection
- decisions across ovs-vswitchd instances when using
- stable bonding mode.
-
+ Hypervisors may sometimes have more than one interface associated
+ with a given , 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 , 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
+ may mark that interface active or omit entirely.
+
+ During VM migration, a given might transiently be marked active on
+ two different hypervisors. That is, active means that
+ this 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 might both be briefly marked
+ active on a single hypervisor.
+
+ VLAN splinters do not support 802.1p priority tags. Received + priorities will appear to be 0, regardless of their actual values, + and priorities on transmitted packets will also be cleared to 0. +
The eviction process only considers flows that have an idle timeout or a hard timeout. That is, eviction never deletes permanent flows. - (Permanent flows do count against . + (Permanent flows do count against .)
@@ -2002,10 +2421,8 @@ references it.
The type of QoS to implement. The column in the table - identifies the types that a switch actually supports. The currently - defined types are listed below:
+The type of QoS to implement. The currently defined types are + listed below:
linux-htbqueue_id used in
OpenFlow in struct ofp_action_enqueue and other
- structures. Queue 0 is used by OpenFlow output actions that do not
- specify a specific queue.
+ structures.
+
+ + Queue 0 is the ``default queue.'' It is used by OpenFlow output + actions when no specific queue has been set. When no configuration for + queue 0 is present, it is automatically configured as if a record with empty + and columns had been + specified. + (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in + this case. With some queuing disciplines, this dropped all packets + destined for the default queue.) +
- The following destination MAC addresses will not be mirrored to a - VLAN to avoid confusing switches that interpret the protocols that - they represent: + See the documentation for + in the + table for a list of destination MAC + addresses which will not be mirrored to a VLAN to avoid confusing + switches that interpret the protocols that they represent.
-01:80:c2:00:00:0001:80:c2:00:00:0101:80:c2:00:00:0x01:00:0c:cc:cc:cc01:00:0c:cc:cc:cd01:00:0c:cd:cd:cd01:00:0c:00:00:00Please note: Mirroring to a VLAN can disrupt a network that contains unmanaged switches. Consider an unmanaged physical switch with two ports: port 1, connected to an end host, and port 2, @@ -2452,7 +2856,26 @@
+ OpenFlow switches send certain messages to controllers spontanenously, + that is, not in response to any request from the controller. These + messages are called ``asynchronous messages.'' These columns allow + asynchronous messages to be limited or disabled to ensure the best use + of network resources. +
+ +false to change Open vSwitch behavior to disable, by
+ default, all asynchronous messages. The controller can use the
+ NXT_SET_ASYNC_CONFIG Nicira extension to OpenFlow to turn
+ on any messages that it does want to receive, if any.
+ The maximum rate at which the switch will forward packets to the @@ -2592,11 +3015,33 @@
+ Additional configuration for a connection between the controller + and the Open vSwitch. +
+ +Common
Columns at the beginning of this document.
Listens for SSL connections on the specified TCP port - (default: 6632). If ip, which must be expressed as an - IP address (not a DNS name), is specified, then connections are - restricted to the specified local IP address. + (default: 6632). Specify 0 for port to have the + kernel automatically choose an available port. If ip, + which must be expressed as an IP address (not a DNS name), is + specified, then connections are restricted to the specified local + IP address.
The column in the When multiple managers are configured, the
@@ -2814,6 +3262,34 @@
chosen connection.
ptcp:[port][:ip]
ptcp: or
+ pssl:, this is the TCP port on which the OVSDB server is
+ listening. (This is is particularly useful when specifies a port of 0, allowing the kernel to
+ choose any available port.)
+
+ Additional configuration for a connection between the manager + and the Open vSwitch Database. +
+ +