X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=f56e670ae1bc6fb461fcb9b589de5fc51e9d1947;hb=8402c74b186e28c53ad51fc8813aebe64a12cd7c;hp=a16ddfbf10d8e6a43eaaf42c58fcd3f3b50ac327;hpb=d4da3acc2a788d1c1b78c0bea6399660c7851f4a;p=sliver-openvswitch.git diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index a16ddfbf1..f56e670ae 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
@@ -316,11 +334,19 @@ - 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. +

+ 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 column in + the table) is incompatible with + flood_vlans. Consider using another bonding mode or + a different type of mirror instead. +

@@ -363,10 +389,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 +411,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 @@ -420,6 +446,31 @@ does not have QoS configured, or if the port does not have a queue with the specified ID, the default queue is used instead.
+
flow-eviction-threshold
+
+ 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. +
+
forward-bpdu
+
+ Option to allow forwarding of BPDU frames when NORMAL + action if invoked. Frames with reserved Ethernet addresses + (e.g. STP BPDU) will be forwarded when this option is enabled. + If the Open vSwitch bridge is used to connect different + Ethernet networks, and if Open vSwtich node does not run STP, + then this option should be enabled. + Default is disabled, set to true to enable. +
@@ -516,9 +567,9 @@

- The following mode requires the upstream switch to support 802.3ad with + The following modes require the upstream switch to support 802.3ad with successful LACP negotiation. If LACP negotiation fails then - balance-slb mode is used as a fallback: + balance-slb style flow hashing is used as a fallback:

@@ -530,6 +581,23 @@
+
+
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 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 otherwise ignored.

@@ -632,18 +700,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.
+
+

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.
 @@ -716,14 +807,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.
@@ -787,19 +880,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
@@ -817,13 +922,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.
@@ -913,19 +1019,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
@@ -935,10 +1053,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: @@ -968,19 +1088,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
@@ -1012,6 +1144,8 @@
+
null
+
An ignored interface.
@@ -1072,9 +1206,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:

@@ -1102,14 +1236,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.
 @@ -1190,10 +1325,46 @@ + +

+ 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 . + + + + 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. + + + - - Connectivity monitor configuration for this interface. + + 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. @@ -1213,7 +1384,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 @@ -1239,11 +1411,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.
 @@ -1434,88 +1628,12 @@ - -

- 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 - ``mirrored'' ports, in addition to their normal destinations. Mirroring - traffic may also be referred to as SPAN or RSPAN, depending on the - mechanism used for delivery.

+ ``mirrored'' ports, in addition to their normal destinations. Mirroring + traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how + the mirrored traffic is sent.

Arbitrary identifier for the . @@ -1556,10 +1674,14 @@

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 - will be forwarded to the port, and any frames received on the port - will be discarded.

-

This type of mirroring is sometimes called SPAN.

+ for mirroring. No frames other than those selected for mirroring + 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). +

@@ -1571,6 +1693,37 @@ , replacing any existing tag; when it is 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: +

+
+
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, @@ -1596,6 +1749,10 @@ Open vSwitch is being used as an intermediate switch, learning can be disabled by adding the mirrored VLAN to in the appropriate table or tables.

+

+ Mirroring to a GRE tunnel has fewer caveats than mirroring to a + VLAN and should generally be preferred. +

@@ -1770,7 +1927,8 @@ number of seconds, it will send a probe. If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect. - Default is implementation-specific. + Default is implementation-specific. A value of 0 disables + inactivity probes. @@ -2023,6 +2181,7 @@ will send a probe. If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect. Default is implementation-specific. + A value of 0 disables inactivity probes. @@ -2073,6 +2232,34 @@ database (in seconds). Value is empty if manager has never disconnected. +
+
locks_held
+
locks_waiting
+
locks_lost
+
+ Space-separated lists of the names of OVSDB locks that the + connection holds, is currently waiting to acquire, or has had + stolen by another OVSDB client, respectively. Key-value pairs for + lists that would be empty are omitted. +
+
+
+
n_connections
+
+

+ When specifies a connection method that + listens for inbound connections (e.g. ptcp: or + pssl:) and more than one connection is actually + active, the value is the number of active connections. + Otherwise, this key-value pair is omitted. +

+

+ When multiple connections are active, status columns and + key-value pairs (other than this one) report the status of one + arbitrarily chosen connection. +

+
+