X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=12780d6c1c7370945cc67ec5578535eaa8317d11;hb=7155fa52f0e585eb515ceebf3790d90554bbe18e;hp=239a9e884631c03c9b46713f8675ba37f0ce07e6;hpb=21f7563cef5f3e5ab52c15ade58594c2dfdb7195;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 239a9e884..12780d6c1 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -71,6 +71,93 @@
The Citrix XenServer universally unique identifier for the physical
host as displayed by 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:
+
+
+ -
+ Stop
ovs-vswitchd.
+
+ -
+ Set
true.
+
+ -
+ Start
ovs-vswitchd.
+
+ -
+ Use
ovs-ofctl (or some other program, such as an
+ OpenFlow controller) to restore the OpenFlow flow table
+ to the desired state.
+
+ -
+ Set
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.
+
+
+
+ auto- Handle automatically based on the flow-eviction-threshold and
+ the flow setup governer (default, recommended).
+ with-facets- Always create facets. Expensive kernel flow creation and
+ statistics tracking is always performed, even on flows with only
+ a small number of packets.
+ without-facets- Always handle without facets. Forces flow misses to be handled
+ in userspace. May cause an increase in CPU usage and packet loss
+ on high throughput.
+
+
+
@@ -87,14 +174,6 @@
configuration changes.
-
- Describes functionality supported by the hardware and software platform
- on which this Open vSwitch is based. Clients should not modify this
- column. See the
The statistics column contains key-value pairs that
@@ -241,8 +320,6 @@
The Open vSwitch version number, e.g. 1.1.0.
- If Open vSwitch was configured with a build number, then it is
- also included, e.g. 1.1.0+build6579.
@@ -350,7 +427,11 @@
- sFlow configuration.
+ sFlow(R) configuration.
+
+
+
+ IPFIX configuration.
@@ -372,8 +453,25 @@
- OpenFlow controller set. If unset, then no OpenFlow controllers
- will be used.
+
+ OpenFlow controller set. If unset, then no OpenFlow controllers
+ will be used.
+
+
+
+ If there are primary controllers, removing all of them clears the
+ flow table. If there are no primary controllers, adding one also
+ clears the flow table. Other changes to the set of controllers, such
+ as adding or removing a service controller, adding another primary
+ controller to supplement an existing primary controller, or removing
+ only one of two primary controllers, have no effect on the flow
+ table.
+
+
+
+
+ Configuration for OpenFlow tables. Each pair maps from an OpenFlow
+ table ID to configuration for that table.
@@ -402,10 +500,23 @@
any defined controllers forever.
- 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,
+
+ Changing
@@ -419,6 +530,12 @@
value. May not be all-zero.
+
+ Human readable description of datapath. It it a maximum 256
+ byte-long free-form string to describe the datapath for
+ debugging purposes, e.g. switch3 in room 3120.
+
+
If set to true, disable in-band control on the bridge
@@ -433,6 +550,12 @@
QoS configured, or if the port does not have a queue with the specified
ID, the default queue is used instead.
+
+
+ List of OpenFlow protocols that may be used when negotiating a
+ connection with a controller. A default value of
+ OpenFlow10 will be used if this column is empty.
+
@@ -446,7 +569,7 @@
on bridges. Bond, internal, and mirror ports are not supported
and will not participate in the spanning tree.
-
+
The bridge's STP identifier (the lower 48 bits of the bridge-id)
in the form
@@ -511,20 +634,6 @@
datapath ID.
-
-
- 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.
-
-
-
Option to allow forwarding of BPDU frames when NORMAL action is
@@ -536,6 +645,75 @@
and if Open vSwitch node does not run STP, then this option
should be enabled. Default is disabled, set to
true to enable.
+
+ The following destination MAC addresss will not be forwarded when this
+ option is enabled.
+
+ 01:80:c2:00:00:00- 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.
+
+
+
+
+
+ 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.
+
+
+
+
+
+ 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.
+
@@ -609,8 +787,7 @@
VLAN). A packet that ingresses on a trunk port is in the VLAN
specified in its 802.1Q header, or VLAN 0 if the packet has no
802.1Q header. A packet that egresses through a trunk port will
- have a 802.1Q header if it has a nonzero VLAN ID (or a nonzero
- 802.1Q priority).
+ have an 802.1Q header if it has a nonzero VLAN ID.
@@ -623,14 +800,14 @@
An access port carries packets on exactly one VLAN specified in the
-
- Any packet with an 802.1Q header that ingresses on an access port
- is dropped, regardless of whether the VLAN ID in the header is the
- access port's VLAN ID.
+ 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.
@@ -646,7 +823,7 @@
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 not have an 802.1Q header.
+ the native VLAN will not have an 802.1Q header.
@@ -691,12 +868,45 @@
VLAN.
+
+
+
+ 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
+ true to enable priority-tagged frames on a port.
+
+
+
+ Regardless of this setting, Open vSwitch omits the 802.1Q header on
+ output if both the VLAN ID and priority would be zero.
+
+
+
+ All frames output to native-tagged ports have a nonzero VLAN ID, so
+ this setting is not meaningful on native-tagged ports.
+
+
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-backup-
Assigns all flows to one slave, failing over to a backup slave when
- the active slave is disabled.
+ the active slave 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 then
- balance-slb style flow hashing is used as a fallback:
+ successful LACP negotiation:
@@ -725,21 +935,6 @@
information such as destination MAC address, IP address, and TCP
port.
-
- stable-
-
Attempts 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 ovs-vswitchd instances with equivalent
-
-
These columns apply only to bonded ports. Their values are
@@ -747,10 +942,19 @@
The type of bonding used for a bonded port. Defaults to
- balance-slb if unset.
+ active-backup if unset.
+
+ An integer hashed along with flows when choosing output slaves in load
+ balanced bonds. When changed, all flows will be assigned different
+ hash values possibly causing slave selection decisions to change. Does
+ not affect bonding modes which do not employ load balancing such as
+ active-backup.
+
+
An important part of link bonding is detecting that links are down so
@@ -775,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
0 to enable the interface immediately.
@@ -788,7 +992,7 @@
- The number of milliseconds for which carrier must stay down on an
+ 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.
@@ -809,14 +1013,16 @@
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. Defaults to off
- if unset.
+ initiate such negotiations themselves. If LACP is enabled on a port
+ whose partner switch does not support LACP, the bond will be
+ disabled. Defaults to off if unset.
The LACP system ID of this
The LACP timing which should be used on this 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.
-
-
-
- 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 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.
-
-
- Treat LACP like a simple heartbeat protocol for link state
- monitoring. Most features of the LACP protocol are disabled
- when this mode is in use. The default if not specified is
- false.
-
-
-
- An integer hashed along with flows when choosing output slaves. When
- changed, all flows will be assigned different hash values possibly
- causing slave selection decisions to change.
-
-
+
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.
- For an SLB bonded port, the number of milliseconds between successive
- attempts to rebalance the bond, that is, to move source MACs and
- their flows from one interface on the bond to another in an attempt
- to keep usage of each interface roughly equal.
+ type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
+ 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.
@@ -986,6 +1168,26 @@
+
+
+ Key-value pairs that report port statistics.
+
+
+
+ Number of STP BPDUs sent on this port by the spanning
+ tree library.
+
+
+ Number of STP BPDUs received on this port and accepted by the
+ spanning tree library.
+
+
+ Number of bad STP BPDUs received on this port. Bad BPDUs
+ include runt packets and those with an unexpected protocol ID.
+
+
+
+
The overall purpose of these columns is described under Common
Columns at the beginning of this document.
@@ -1006,6 +1208,10 @@
on a host.
+
+ The MAC address in use by this interface.
+
+
Ethernet address to set for this interface. If unset then the
default MAC address is used:
@@ -1038,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
+
+
+
+ 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
+ The port number must be requested in the same transaction
+ that creates the port.
@@ -1069,23 +1289,50 @@
gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
- tunnel. See ipsec_gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
- IPsec tunnel.
+ IPsec tunnel.
+
+
+ gre64
+
+ It is same as GRE, but it allows 64 bit key. To store higher 32-bits
+ of key, it uses GRE protocol sequence number field. This is non
+ standard use of GRE protocol since OVS does not increment
+ sequence number for every packet at time of encap as expected by
+ standard GRE implementation. See capwap
+ ipsec_gre64
- An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
- 5415). This allows interoperability with certain switches that do
- not support GRE. Only the tunneling component of the protocol is
- implemented. UDP ports 58881 and 58882 are used as the source and
- destination ports respectively. CAPWAP is currently supported only
+ Same as IPSEC_GRE except 64 bit key.
+
+
+ vxlan
+
+
+ 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.
+
+
+
+ lisp
+
+ A layer 3 tunnel over the experimental, UDP-based Locator/ID
+ Separation Protocol (RFC 6830). LISP is currently supported only
with the Linux kernel datapath with kernel version 2.6.26 or later.
@@ -1095,7 +1342,8 @@
null
- An ignored interface.
+ An ignored interface. Deprecated and slated for removal in
+ February 2013.
@@ -1103,7 +1351,8 @@
These options apply to interfaces with gre, ipsec_gre, and capwap.
+ gre, ipsec_gre, gre64,
+ ipsec_gre64, vxlan, and lisp.
@@ -1118,12 +1367,67 @@
- Required. The tunnel endpoint.
+ Required. The remote tunnel endpoint, one of:
+
+
+ -
+ An IPv4 address (not a DNS name), e.g.
192.168.0.123.
+ Only unicast endpoints are supported.
+
+ -
+ The word
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.
+
+
+
+
+ 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 destination IP that received packets must
- match. Default is to match all addresses.
+
+ Optional. The tunnel destination IP that received packets must
+ match. Default is to match all addresses. If specified, may be one
+ of:
+
+
+
+
+
+ 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.
+
@@ -1136,8 +1440,9 @@
key="in_key"/> at all.
- A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
- tunnel receives only packets with the specified key.
+ A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
+ (for GRE64) number. The tunnel receives only packets with the
+ specified key.
The word flow. The tunnel accepts packets with any
@@ -1162,8 +1467,9 @@
key="out_key"/> at all.
- A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
- sent through the tunnel will have the specified key.
+ A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
+ (for GRE64) number. Packets sent through the tunnel will have the
+ specified key.
The word flow. Packets sent through the tunnel will
@@ -1182,7 +1488,8 @@
Optional. The value of the ToS bits to be set on the encapsulating
- packet. It may also be the word 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.
@@ -1194,49 +1501,14 @@
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.
-
-
- Optional. If enabled, the Don't Fragment bit will be copied from the
- inner IP headers (those of the encapsulated traffic) to the outer
- (tunnel) headers. Default is disabled; set to true to
- enable.
-
- Optional. If enabled, the Don't Fragment bit will be set by default on
- tunnel headers if the df_inherit option is not set, or if
- the encapsulated packet is not IP. Default is enabled; set to
- false to disable.
-
-
-
- Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
- Destination Unreachable - Fragmentation Needed'' messages will be
- generated for IPv4 packets with the DF bit set and IPv6 packets above
- the minimum MTU if the packet size exceeds the path MTU minus the size
- of the tunnel headers. Note that this option causes behavior that is
- typically reserved for routers and therefore is not entirely in
- compliance with the IEEE 802.1D specification for bridges. 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.
-
-
- Only gre interfaces support these options.
-
-
-
- Enable caching of tunnel headers and the output path. This can lead
- to a significant performance increase without changing behavior. In
- general it should not be necessary to adjust this setting. However,
- the caching can bypass certain components of the IP stack (such as
- 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
@@ -1396,15 +1668,15 @@
The source IP address used for an IPv4 tunnel end-point, such as
- gre or capwap.
+ gre.
- Egress interface for tunnels. Currently only relevant for GRE and
- CAPWAP tunnels. On Linux systems, this column will show the name of
- the interface which is responsible for routing traffic destined for the
- configured
+
Number of packets dropped by TX.
@@ -1551,6 +1823,98 @@
+
+
+ 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.
+
+
+
+ When true BFD is enabled on this
+ false.
+
+
+
+ The fastest rate, in milliseconds, at which this BFD session is
+ willing to receive BFD control messages. The actual rate may be
+ slower if the remote endpoint isn't willing to transmit as quickly as
+ specified. Defaults to 1000.
+
+
+
+ The fastest rate, in milliseconds, at which this BFD session is
+ willing to transmit BFD control messages. The actual rate may be
+ slower if the remote endpoint isn't willing to receive as quickly as
+ specified. Defaults to 100.
+
+
+
+ Concatenated path down may be used when the local system should not
+ have traffic forwarded to it for some reason other than a connectivty
+ failure on the interface being monitored. When a controller thinks
+ this may be the case, it may set cpath_down to
+ true which may cause the remote BFD session not to
+ forward traffic to this false.
+
+
+
+ State of the BFD session. The BFD session is fully healthy and
+ negotiated if UP.
+
+
+
+ True if the BFD session believes this UP, and the remote system isn't signaling a
+ problem such as concatenated path down.
+
+
+
+ A short message indicating what the BFD session thinks is wrong in
+ case of a problem.
+
+
+
+ State of the remote endpoint's BFD session.
+
+
+
+ A short message indicating what the remote endpoint's BFD session
+ thinks is wrong in case of a problem.
+
+
+
802.1ag Connectivity Fault Management (CFM) allows a group of
@@ -1570,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.
+
+
A Maintenance Point ID (MPID) uniquely identifies each endpoint within
a Maintenance Association. The MPID is used to identify this endpoint
@@ -1596,6 +1966,76 @@
+
+ Indicates a CFM fault was triggered due to a lack of CCMs received on
+ the ovs-appctl command.
+
+
+
+ Indicates a CFM fault was triggered due to the reception of a CCM
+ frame having an invalid interval.
+
+
+
+ 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
+
+ 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.
+
+
+
When CFM is properly configured, Open vSwitch will occasionally
receive CCM broadcasts. These broadcasts contain the MPID of the
@@ -1606,9 +2046,21 @@
- The interval, in milliseconds, between transmissions of CFM heartbeats.
- Three missed heartbeat receptions indicate a connectivity fault.
- Defaults to 1000.
+
+ 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
+
+ We do not recommend using intervals less than 100 ms.
false.
+
+
+
+ When true, and
+
+
+
+ Demand mode has a couple of caveats:
+
+ -
+ To ensure that ovs-vswitchd has enough time to pull statistics
+ from the datapath, the minimum
+
+
+ -
+ To avoid ambiguity, demand mode disables itself when there are
+ multiple remote maintenance points.
+
+
+ -
+ If the
+
+
+
+
When down, the CFM module marks all CCMs it generates as
@@ -1632,19 +2121,26 @@
OpenFlow action. This setting is ignored when CFM is not in extended
mode. Defaults to up.
-
-
-
- Used in stable bond mode to make slave
- selection decisions. Allocating ovs-vswitchd instances when using
- stable bonding mode.
+
+ 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.
+
+ 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
+ Hypervisors may sometimes have more than one interface associated
+ with a given active and the
+ others inactive. A hypervisor that never has more than
+ one interface for a given active or omit
+
+
+ During VM migration, a given active on
+ two different hypervisors. That is, active means that
+ this active on a single hypervisor.
+
+
+
The virtual interface associated with this interface.
@@ -1699,11 +2226,94 @@
The virtual network to which this interface is attached.
+
+ The VM to which this interface belongs. On XenServer, this will be the
+ same as
+ The ``VLAN splinters'' feature increases Open vSwitch compatibility
+ with buggy network drivers in old versions of Linux that do not
+ properly support VLANs when VLAN devices are not used, at some cost
+ in memory and performance.
+
+
+
+ When VLAN splinters are enabled on a particular interface, Open vSwitch
+ creates a VLAN device for each in-use VLAN. For sending traffic tagged
+ with a VLAN on the interface, it substitutes the VLAN device. Traffic
+ received on the VLAN device is treated as if it had been received on
+ the interface on the particular VLAN.
+
+
+
+ VLAN splinters consider a VLAN to be in use if:
+
+
+
+ -
+ The VLAN is the
+
+ -
+ The VLAN is listed within the
+
+ -
+ An OpenFlow flow within any bridge matches the VLAN.
+
+
+
+
+ The same set of in-use VLANs applies to every interface on which VLAN
+ splinters are enabled. That is, the set is not chosen separately for
+ each interface but selected once as the union of all in-use VLANs based
+ on the rules above.
+
+
+
+ It does not make sense to enable VLAN splinters on an interface for an
+ access port, or on an interface that is not a physical port.
+
+
+
+ VLAN splinters are deprecated. When broken device drivers are no
+ longer in widespread use, we will delete this feature.
+
+
+
+
+ Set to true to enable VLAN splinters on this interface.
+ Defaults to false.
+
+
+
+ VLAN splinters increase kernel and userspace memory overhead, so do
+ not use them unless they are needed.
+
+
+
+ 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 overall purpose of these columns is described under Common
Columns at the beginning of this document.
@@ -1713,15 +2323,106 @@
+
+ Configuration for a particular OpenFlow table.
+
+
+ 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.
+
+
+
+ If set, limits the number of flows that may be added to the table. Open
+ vSwitch may limit the number of flows in a table for other reasons,
+ e.g. due to hardware limitations or for resource availability or
+ performance reasons.
+
+
+
+
+ Controls the switch's behavior when an OpenFlow flow table modification
+ request would add flows in excess of
+
+
+ refuse-
+ Refuse to add the flow or flows. This is also the default policy
+ when
+
+ evict-
+ Delete the flow that will expire soonest. See
+
+
+
+
+
+ When evict, this
+ controls how flows are chosen for eviction when the flow table would
+ otherwise exceed field[] or
+ field[start..end],
+ e.g. NXM_OF_IN_PORT[]. Please see
+ nicira-ext.h for a complete list of NXM field names.
+
+
+
+ When a flow must be evicted due to overflow, the flow to evict is
+ chosen through an approximation of the following algorithm:
+
+
+
+ -
+ Divide the flows in the table into groups based on the values of the
+ specified fields or subfields, so that all of the flows in a given
+ group have the same values for those fields. If a flow does not
+ specify a given field, that field's value is treated as 0.
+
+
+ -
+ Consider the flows in the largest group, that is, the group that
+ contains the greatest number of flows. If two or more groups all
+ have the same largest number of flows, consider the flows in all of
+ those groups.
+
+
+ -
+ Among the flows under consideration, choose the flow that expires
+ soonest for eviction.
+
+
+
+
+ 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
+
+
+ Open vSwitch ignores any invalid or unknown field specifications.
+
+
+
+ When evict, this
+ column has no effect.
+
+
+
+
Quality of Service (QoS) configuration for each Port that
references it.
- The type of QoS to implement. The
+ The type of QoS to implement. The currently defined types are
+ listed below:
linux-htb-
@@ -1746,8 +2447,19 @@
supported range of queue numbers depend on
queue_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
@@ -1755,7 +2467,7 @@
The linux-htb and linux-hfsc classes support
the following key-value pair:
-
+
Maximum rate shared by all queued traffic, in bit/s. Optional. If not
specified, for physical interfaces, the default is the link rate. For
@@ -1778,25 +2490,22 @@
Service (QoS) features. May be referenced by
- These key-value pairs are defined for min-rate.
-
-
-
- Minimum guaranteed bandwidth, in bit/s. Required. The floor value is
- 1500 bytes/s (12,000 bit/s).
-
-
+
+ If set, Open vSwitch will mark all traffic egressing this
+
- These key-value pairs are defined for linux-htb.
+ linux-htb may use queue_ids less than 61440.
+ It has the following key-value pairs defined.
-
+
Minimum guaranteed bandwidth, in bit/s.
@@ -1829,15 +2538,16 @@
- These key-value pairs are defined for linux-hfsc.
+ linux-hfsc may use queue_ids less than 61440.
+ It has the following key-value pairs defined.
-
+
Minimum guaranteed bandwidth, in bit/s.
-
+
Maximum allowed bandwidth, in bit/s. Optional. If specified, the
@@ -1856,11 +2566,11 @@
-
+
A port mirror within a
A port mirror configures a bridge to send selected frames to special
``mirrored'' ports, in addition to their normal destinations. Mirroring
- traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
+ traffic may also be referred to as SPAN or RSPAN, depending on how
the mirrored traffic is sent.
@@ -1903,12 +2613,13 @@
Output port for selected packets, if nonempty.
Specifying a port for mirror output reserves that port exclusively
for mirroring. No frames other than those selected for mirroring
+ via this column
will be forwarded to the port, and any frames received on the port
will be discarded.
The output port may be any kind of port supported by Open vSwitch.
- It may be, for example, a physical port (sometimes called SPAN), or a
- GRE tunnel (sometimes called ERSPAN).
+ It may be, for example, a physical port (sometimes called SPAN) or a
+ GRE tunnel.
@@ -1922,36 +2633,12 @@
sent out an implicit VLAN port, the frame will not be tagged. This
type of mirroring is sometimes called RSPAN.
- 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
+
-
- 01:80:c2:00:00:00- 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.
-
- 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.
-
Please 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,
@@ -1984,6 +2671,18 @@
+
+
+ Key-value pairs that report mirror statistics.
+
+
+ Number of packets transmitted through this mirror.
+
+
+ Number of bytes transmitted through this mirror.
+
+
+
The overall purpose of these columns is described under Common
Columns at the beginning of this document.
@@ -2157,25 +2856,50 @@
-
+
+
+ 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.
+
+
+
+ The OpenFlow protocol enables asynchronous messages at time of
+ connection establishment, which means that a controller can receive
+ asynchronous messages, potentially many of them, even if it turns them
+ off immediately after connecting. Set this column to
+ 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 packets in unknown flows will be
- forwarded to the OpenFlow controller, in packets per second. This
- feature prevents a single bridge from overwhelming the controller.
- If not specified, the default is implementation-specific.
- In addition, when a high rate triggers rate-limiting, Open
- vSwitch queues controller packets for each port and transmits
- them to the controller at the configured rate. The number of
- queued packets is limited by
- the
Open
- vSwitch maintains two such packet rate-limiters per bridge.
- One of these applies to packets sent up to the controller
- because they do not correspond to any flow. The other applies
- to packets sent up to the controller by request through flow
- actions. When both rate-limiters are filled with packets, the
- actual rate that packets are sent to the controller is up to
- twice the specified rate.
+
+ The maximum rate at which the switch will forward packets to the
+ OpenFlow controller, in packets per second. This feature prevents a
+ single bridge from overwhelming the controller. If not specified,
+ the default is implementation-specific.
+
+
+
+ In addition, when a high rate triggers rate-limiting, Open vSwitch
+ queues controller packets for each port and transmits them to the
+ controller at the configured rate. The
+
+
+ Open vSwitch maintains two such packet rate-limiters per bridge: one
+ for packets sent up to the controller because they do not correspond
+ to any flow, and the other for packets sent up to the controller by
+ request through flow actions. When both rate-limiters are filled with
+ packets, the actual rate that packets are sent to the controller is
+ up to twice the specified rate.
+
@@ -2275,14 +2999,14 @@
human consumption.
-
+
The amount of time since this controller last successfully connected to
the switch (in seconds). Value is empty if controller has never
successfully connected.
-
+
The amount of time since this controller last disconnected from
@@ -2291,11 +3015,33 @@
+
+
+ Additional configuration for a connection between the controller
+ and the Open vSwitch.
+
+
+
+ The Differentiated Service Code Point (DSCP) is specified using 6 bits
+ in the Type of Service (TOS) field in the IP header. DSCP provides a
+ mechanism to classify the network traffic and provide Quality of
+ Service (QoS) on IP networks.
+
+ The DSCP value specified here is used when establishing the connection
+ between the controller and the Open vSwitch. If no value is specified,
+ a default value of 48 is chosen. Valid DSCP values must be in the
+ range 0 to 63.
+
+
+
+
The overall purpose of these columns is described under Common
Columns at the beginning of this document.
+
@@ -2350,9 +3096,11 @@
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 ptcp:[port][:ip]
Listens for 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.
When multiple managers are configured, the
+
+
+ When ptcp: or
+ pssl:, this is the TCP port on which the OVSDB server is
+ listening. (This is is particularly useful when
+ Additional configuration for a connection between the manager
+ and the Open vSwitch Database.
+
+
+
+ The Differentiated Service Code Point (DSCP) is specified using 6 bits
+ in the Type of Service (TOS) field in the IP header. DSCP provides a
+ mechanism to classify the network traffic and provide Quality of
+ Service (QoS) on IP networks.
+
+ The DSCP value specified here is used when establishing the connection
+ between the manager and the Open vSwitch. If no value is specified, a
+ default value of 48 is chosen. Valid DSCP values must be in the range
+ 0 to 63.
+
@@ -2520,6 +3297,7 @@
Columns at the beginning of this document.
+
@@ -2611,15 +3389,17 @@
- An sFlow(R) target. sFlow is a protocol for remote monitoring
- of switches.
+ A set of sFlow(R) targets. sFlow is a protocol for remote
+ monitoring of switches.
Name of the network device whose IP address should be reported as the
- ``agent address'' to collectors. If not specified, the IP address
+ ``agent address'' to collectors. If not specified, the agent device is
+ figured from the first target address and the routing table. If the
+ routing table does not contain a route to the target, the IP address
defaults to the
-
- Records in this table describe functionality supported by the hardware
- and software platform on which this Open vSwitch is based. Clients
- should not modify this table.
+
+ A set of IPFIX collectors. IPFIX is a protocol that exports a
+ number of details about flows.
- A record in this table is meaningful only if it is referenced by the
-
+
+ IPFIX target collectors in the form
+ ip:port.
+
-
- qos-type- type is supported as the value for
-
-
+
+ For per-bridge packet sampling, i.e. when this row is referenced
+ from a Key-value pairs that describe capabilities. The meaning of the pairs
- depends on the category key that the
+
+ For per-bridge packet sampling, i.e. when this row is referenced
+ from a The presence of a record for category qos-type
- indicates that the switch supports type as the value of
- the
+
+ For per-bridge packet sampling, i.e. when this row is referenced
+ from a
- n-queues- Number of supported queues, as a positive integer. Keys in the
-
-
+
+ The overall purpose of these columns is described under Common
+ Columns at the beginning of this document.
+
+
+
+
+
+
+ A set of IPFIX collectors of packet samples generated by
+ OpenFlow sample actions.
+
+
+ The ID of this collector set, unique among the bridge's
+ collector sets, to be used as the collector_set_id
+ in OpenFlow sample actions.
+
+
+
+ The bridge into which OpenFlow sample actions can
+ be added to send packet samples to this set of IPFIX collectors.
+
+
+
+ Configuration of the set of IPFIX collectors to send one flow
+ record per sampled packet to.
+
+
+ The overall purpose of these columns is described under Common
+ Columns at the beginning of this document.
+
+
+