X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=vswitchd%2Fvswitch.xml;h=608225647cf16e4fcc2140d3b8d0affb1366482e;hb=973d7411d62e848a2b9b0175ba7bb6234efdbff3;hp=a16c486cc7f2ac1de4d062ffa999bff814337c20;hpb=cc8d12f9364760456c86e92378d529c0dd9aaa66;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index a16c486c..60822564 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.
+
@@ -536,12 +587,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
- bond-stable-id
if set. Otherwise, OpenFlow port
- number is used. Decisions are consistent across all ovs-vswitchd
- instances with equivalent bond-stable-id
s.
+ 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.
@@ -627,9 +680,6 @@
Key-value pairs for configuring rarely used port features. The
currently defined key-value pairs are:
- hwaddr
- - An Ethernet address in the form
-
xx:xx:xx:xx:xx:xx
.
bond-rebalance-interval
- For an SLB bonded port, the number of milliseconds between
successive attempts to rebalance the bond, that is, to
@@ -754,14 +804,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.
@@ -867,13 +919,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.
@@ -997,10 +1050,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:
@@ -1148,9 +1203,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:
@@ -1178,14 +1233,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
.
@@ -1266,12 +1322,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
@@ -1296,7 +1381,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
@@ -1322,13 +1408,18 @@
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
- bond-stable-id
s consistently across interfaces
- participating in a bond will guarantee consistent slave selection
- decisions across ovs-vswitchd instances when using
- stable
bonding mode.
+ 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
@@ -1534,88 +1625,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 .
@@ -1656,10 +1671,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).
+
@@ -1671,6 +1690,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,
@@ -1696,6 +1746,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.
+
@@ -2175,6 +2229,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.
+
+
+