X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=inline;f=vswitchd%2Fvswitch.xml;h=6199938feb3eaecd1b3a709773b235815bfd3b4d;hb=a9a2fba5098917a7c072a601ecedd8d5bcd83e23;hp=6031b5a0efcafe7c7938afd15abf0f24bb0804b0;hpb=206018136a10d00b275d85386c5744a555584151;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 6031b5a0..6199938f 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -25,6 +25,19 @@
SSL used globally by the daemon.
+
+ Key-value pairs for configuring rarely used Open vSwitch features. The
+ currently defined key-value pairs are:
+
+ enable-statistics
+ -
+ Set to
true
to enable populating the column or false
(the default)
+ disable populating it.
+
+
+
+
Key-value pairs for use by external frameworks that integrate
with Open vSwitch, rather than by Open vSwitch itself. System
@@ -37,7 +50,7 @@
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
- xs-system-uuid
.
+ .
xs-system-uuid
The Citrix XenServer universally unique identifier for the
physical host as displayed by xe host-list
.
@@ -75,6 +88,11 @@
apply to a platform are omitted.
+
+ Statistics are disabled unless is set to true
.
+
+
cpu
-
@@ -363,10 +381,9 @@
- Reports the OpenFlow datapath ID in use. Exactly 16 hex
- digits. (Setting this column will have no useful effect. Set
-
:other-config
- instead.)
+ Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
+ (Setting this column has no useful effect. Set instead.)
@@ -386,8 +403,9 @@
defined key-value pairs are:
bridge-id
- - A unique identifier of the bridge. On Citrix XenServer this
- will commonly be the same as
xs-network-uuids
.
+ - A unique identifier of the bridge. On Citrix XenServer this will
+ commonly be the same as
+
.
xs-network-uuids
- Semicolon-delimited set of universally unique identifier(s) for
the network with which this bridge is associated on a Citrix
@@ -536,12 +554,14 @@
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
, falling back to balance-slb
- style hashing when LACP negotiations are unsuccessful.
- Slave selection decisions are made based on LACP port ID when LACP
- negotiations are successful, falling back to openflow port number
- when unsuccessful. Thus, decisions are consistent across all
- ovs-vswitchd instances with equivalent port IDs.
+ 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.
@@ -577,8 +597,8 @@
Configures LACP on this port. LACP allows directly connected
- switchs to negotiate which links may be bonded. LACP may be enabled
- on non-bonded ports for the benefit of any switchs they may be
+ 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
@@ -647,23 +667,41 @@
- The number of milliseconds between successive attempts to
poll each interface's MII. Only relevant on ports which use
miimon
to detect failures.
+ bond-hash-basis
+ - 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.
+ lacp-system-id
+ - The LACP system ID of this
. The system ID
+ of a LACP bond is used to identify itself to its partners. Must
+ be a nonzero MAC address.
lacp-system-priority
- The LACP system priority of this
. In
LACP negotiations, link status decisions are made by the system
with the numerically lower priority. Must be a number between 1
and 65535.
lacp-time
- - The LACP timing which should be used on this
-
. Possible values are fast
and
- slow
. By default slow
is used. When
- configured to be fast
more frequent LACP heartbeats
- will be requested causing connectivity problems to be detected more
- quickly.
- lacp-strict
- - When
true
, configures this to
- require successful LACP negotiations to enable any slaves.
- Defaults to false
which safely allows LACP to be used
- with switchs that do not support the protocol.
+ -
+
The LACP timing which should be used on this
+ . Possible values are 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.
+
+ lacp-heartbeat
+ - Treats LACP like a simple heartbeat protocol for link state
+ monitoring. Most features of the LACP protocol are disabled when
+ this mode is in use.
@@ -736,14 +774,16 @@
A TUN/TAP device managed by Open vSwitch.
gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
- tunnel. Each tunnel must be uniquely identified by the
- combination of remote_ip
, local_ip
, and
- in_key
. Note that 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. in_key
- is considered more specific than local_ip
if a port
- defines one and another port defines the other. The following
- options may be specified in the column:
+ tunnel. Each tunnel must be uniquely identified by the
+ combination of ,
+ , and
+ . Note that 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. is considered
+ more specific than if a port
+ defines one and another port defines the other. The following
+ options may be specified in the column:
remote_ip
- Required. The tunnel endpoint.
@@ -807,19 +847,31 @@
adds value for the GRE and encapsulated Ethernet headers.
Default is disabled, set to true
to enable.
+
+ df_inherit
+ - 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.
+
+
+ df_default
+ - 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.
+
pmtud
- Optional. Enable tunnel path MTU discovery. If enabled
- ``ICMP destination unreachable - fragmentation'' needed
+ ``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. It
- also forces the encapsulating packet DF bit to be set (it is
- always set if the inner packet implies path MTU discovery).
+ 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.
+ Default is enabled; set to false
to disable.
header_cache
@@ -837,13 +889,14 @@
- An Ethernet over RFC 2890 Generic Routing Encapsulation
over IPv4 IPsec tunnel. Each tunnel (including those of type
gre
) must be uniquely identified by the
- combination of remote_ip
and
- local_ip
. Note that if two ports are defined
- that are the same except one has an optional identifier and
+ combination of and
+ . Note that 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.
- An authentication method of peer_cert
or
- psk
must be defined. The following options may
- be specified in the column:
+ An authentication method of
+ or must be defined. The
+ following options may be specified in the
+ column:
remote_ip
- Required. The tunnel endpoint.
@@ -933,19 +986,31 @@
adds value for the GRE and encapsulated Ethernet headers.
Default is disabled, set to true
to enable.
+
+ df_inherit
+ - 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.
+
+
+ df_default
+ - 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.
+
pmtud
- Optional. Enable tunnel path MTU discovery. If enabled
- ``ICMP destination unreachable - fragmentation'' needed
+ ``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. It
- also forces the encapsulating packet DF bit to be set (it is
- always set if the inner packet implies path MTU discovery).
+ 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.
+ Default is enabled; set to false
to disable.
capwap
@@ -955,10 +1020,12 @@
of the protocol is implemented. Due to the non-standard use of
CAPWAP, UDP ports 58881 and 58882 are used as the source and
destination ports respectively. Each tunnel must be uniquely
- identified by the combination of remote_ip
and
- local_ip
. If two ports are defined that are the same
- except one includes local_ip
and the other does not,
- the more specific one is matched first. CAPWAP support is not
+ identified by the combination of
+ and
+ . If two ports are defined
+ that are the same except one includes
+ and the other does not, the
+ more specific one is matched first. CAPWAP support is not
available on all platforms. Currently it is only supported in the
Linux kernel module with kernel versions >= 2.6.25. The following
options may be specified in the column:
@@ -988,19 +1055,31 @@
(otherwise it will be the system default, typically 64).
Default is the system default TTL.
+
+ df_inherit
+ - 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.
+
+
+ df_default
+ - 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.
+
pmtud
- Optional. Enable tunnel path MTU discovery. If enabled
- ``ICMP destination unreachable - fragmentation'' needed
+ ``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. It
- also forces the encapsulating packet DF bit to be set (it is
- always set if the inner packet implies path MTU discovery).
+ 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.
+ Default is enabled; set to false
to disable.
header_cache
@@ -1032,6 +1111,8 @@
+ null
+ An ignored interface.
@@ -1092,9 +1173,9 @@
- Key-value pairs that report port status. Supported status
- values are type
-dependent; some interfaces may not have
- a valid driver_name
, for example.
+ Key-value pairs that report port status. Supported status values are
+ -dependent; some interfaces may not have a valid
+ , for example.
The currently defined key-value pairs are:
@@ -1122,14 +1203,15 @@
- 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
remote_ip
.
- This could be an internal interface such as a bridge port.
+ traffic destined for the configured
+ . This could be an
+ internal interface such as a bridge port.
tunnel_egress_iface_carrier
- - Whether a carrier is detected on
. Valid values are down
- and up
.
+ - Whether a carrier is detected on
+
. Valid values
+ are down
and up
.
@@ -1210,12 +1292,41 @@
-
+
+
+ 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.
+
+
+
+ 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 .
+
-
- Connectivity monitor configuration for this interface.
+
+ The MPID of the remote endpoint being monitored. If this
+ does not have connectivity to an endpoint
+ advertising the configured MPID, a fault is signalled. Must be
+ configured to enable CFM on this
+
+ Indicates a connectivity fault triggered by an inability to receive
+ heartbeats from the remote endpoint. When a fault is triggered on
+ s participating in bonds, they will be
+ disabled.
+
+
+
+
+
Boolean value indicating LACP status for this interface. If true, this
interface has current LACP information about its LACP partner. This
@@ -1240,7 +1351,8 @@
field in the VIF record for this interface.
iface-id
A system-unique identifier for the interface. On XenServer,
- this will commonly be the same as xs-vif-uuid
.
+ this will commonly be the same as
+ .
Additionally the following key-value pairs specifically
@@ -1266,11 +1378,33 @@
Key-value pairs for rarely used interface features.
+ cfm_interval
+ - The transmission interval of CFM heartbeats in milliseconds.
+ Three missed heartbeat receptions indicate a connectivity fault.
+ Defaults to 1000ms.
+ bond-stable-id
+ - A positive integer using in
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.
+ lacp-port-id
+ - The LACP port ID of this
. Port IDs are
+ used in LACP negotiations to identify individual ports
+ participating in a bond. Must be a number between 1 and
+ 65535.
lacp-port-priority
- The LACP port priority of this
. In
LACP negotiations s with numerically lower
priorities are preferred for aggregation. Must be a number between
1 and 65535.
+ lacp-aggregation-key
+ - The LACP aggregation key of this
.
+ s with different aggregation keys may not
+ be active within a given at the same time. Must
+ be a number between 1 and 65535.
@@ -1461,82 +1595,6 @@
-
-
- A attaches to an to
- implement 802.1ag Connectivity Fault Management (CFM). 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. A is
- responsible for collecting data about other MPs in its MA and
- broadcasting CCMs.
-
-
-
-
- A Maintenance Point ID (MPID) uniquely identifies each endpoint within
- a Maintenance Association (see ). The MPID is
- used to identify this to other endpoints in the
- MA.
-
-
-
- A set of which this
- should have connectivity to. If this
- does not have connectivity to any MPs in this
- set, or has connectivity to any MPs not in this set, a fault is
- signaled.
-
-
-
- A Maintenance Association (MA) name pairs with a Maintenance Domain
- (MD) name to uniquely identify a MA. A MA is a group of endpoints who
- have complete and exclusive interconnectivity. Defaults to
- ovs
if unset.
-
-
-
- A Maintenance Domain name pairs with a Maintenance Association name to
- uniquely identify a MA. Defaults to ovs
if unset.
-
-
-
- The transmission interval of CCMs in milliseconds. Three missed CCMs
- indicate a connectivity fault. Defaults to 1000ms.
-
-
-
-
-
- Indicates a Connectivity Fault caused by a configuration error, a down
- remote MP, or unexpected connectivity to a remote MAID or remote MP.
-
-
-
-
-
-
- A represents a MP which a
- has or should have connectivity to.
-
-
-
-
- A Maintenance Point ID (MPID) uniquely identifies each endpoint within
- a Maintenance Association. All MPs within a MA should have a unique
- MPID.
-
-
-
-
-
- Indicates a connectivity fault.
-
-
-
-
A port mirror within a .
A port mirror configures a bridge to send selected frames to special