X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=vswitchd%2Fvswitch.xml;h=1128db945f7e75c0d49f085d7d02bb1a103c17d9;hb=a65084987b743fbeaf9a5376ea0fe99454912186;hp=fb9aa6d6dd568404e77fa4829af683045c35f895;hpb=e764773ccb007e79f44d948a781fae1313ac28fe;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index fb9aa6d6..1128db94 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -87,14 +87,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 description for defined
- capability categories and the meaning of associated
- records.
-
-
The statistics
column contains key-value pairs that
@@ -241,8 +233,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
.
@@ -467,7 +457,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
@@ -1169,7 +1159,7 @@
ipsec_gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
- IPsec tunnel.
+ IPsec tunnel.
capwap
@@ -1297,7 +1287,7 @@
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
@@ -1563,7 +1553,7 @@
Total number of receive errors, greater than or equal to the sum of
the above.
-
+
Number of packets dropped by TX.
@@ -1699,6 +1689,74 @@
+
+ Indicates a CFM fault was triggered due to a lack of CCMs received on
+ the .
+
+
+
+ Indicates a CFM fault was triggered due to the reception of a CCM with
+ the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
+ are not receiving CCMs themselves. This typically indicates a
+ unidirectional connectivity failure.
+
+
+
+ Indicates a CFM fault was triggered due to the reception of a CCM with
+ a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
+ with an identification number in addition to the MPID called the MAID.
+ Open vSwitch only supports receiving CCM broadcasts tagged with the
+ MAID it uses internally.
+
+
+
+ Indicates a CFM fault was triggered due to the reception of a CCM
+ advertising the same MPID configured in the
+ column of this . This may indicate a loop in
+ the network.
+
+
+
+ Indicates a CFM fault was triggered because the CFM module received
+ CCMs from more remote endpoints than it can keep track of.
+
+
+
+ Indicates a CFM fault was manually triggered by an administrator using
+ an ovs-appctl
command.
+
+
+
+ Indicates a CFM fault was triggered due to the reception of a CCM
+ frame having an invalid interval.
+
+
+
+ Indicates a CFM fault was triggered because the CFM module received
+ a CCM frame with a sequence number that it was not expecting.
+
+
+
+
+ Indicates the health of the interface as a percentage of CCM frames
+ received over 21 s.
+ The health of an interface is undefined if it is communicating with
+ more than one . It reduces if
+ healthy heartbeats are not received at the expected rate, and
+ gradually improves as healthy heartbeats are received at the desired
+ rate. Every 21 s, the
+ health of the interface is refreshed.
+
+
+ As mentioned above, the faults can be triggered for several reasons.
+ The link health will deteriorate even if heartbeats are received but
+ they are reported to be unhealthy. An unhealthy heartbeat in this
+ context is a heartbeat for which either some fault is set or is out
+ of sequence. The interface health can be 100 only on receiving
+ healthy heartbeats at the desired rate.
+
+
+
When CFM is properly configured, Open vSwitch will occasionally
receive CCM broadcasts. These broadcasts contain the MPID of the
@@ -1739,7 +1797,17 @@
When set, the CFM module will apply a VLAN tag to all CCMs it generates
- with the given value.
+ 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 . If
+ is unset, a VLAN ID of
+ zero is used.
@@ -1809,6 +1877,11 @@
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 VM to which this interface belongs.
@@ -1883,6 +1956,12 @@
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.
+
@@ -1993,10 +2072,8 @@
references it.
- The type of QoS to implement. The column in the table
- identifies the types that a switch actually supports. The currently
- defined types are listed below:
+ The type of QoS to implement. The currently defined types are
+ listed below:
linux-htb
-
@@ -2021,8 +2098,19 @@
supported range of queue numbers depend on
. The
queue numbers are the same as the 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 record with empty
+ and columns had been
+ specified.
+ (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
+ this case. With some queuing disciplines, this dropped all packets
+ destined for the default queue.)
+
@@ -2030,7 +2118,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
@@ -2068,7 +2156,7 @@
linux-htb
may use queue_id
s less than 61440.
It has the following key-value pairs defined.
-
+
Minimum guaranteed bandwidth, in bit/s.
@@ -2105,12 +2193,12 @@
linux-hfsc
may use queue_id
s 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
@@ -2443,25 +2531,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 value. The packet
- queue is shared fairly among the ports on a bridge.
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 value limits the number of queued
+ packets. Ports on a bridge share the packet queue fairly.
+
+
+
+ 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.
+
@@ -2561,14 +2674,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
@@ -2577,11 +2690,34 @@
+
+
+ Additional configuration for a connection between the controller
+ and the Open vSwitch.
+
+
+
+ The Differentiated Service Code Point (DSCP) is specified in the IP
+ header. They are 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 the Quality of Service (QoS) on IP
+ networks.
+ The DSCP value passed is used when establishing the connection between
+ the controller and the Open vSwitch. The connection must be reset
+ for the new DSCP values to take effect. If no value is
+ specified, a default value of 192 is chosen for connection
+ establishment. Valid DSCP values must have their lower 2 bits set to 0.
+
+
+
+
The overall purpose of these columns is described under Common
Columns
at the beginning of this document.
+
@@ -2801,11 +2937,33 @@
+
+
+ Additional configuration for a connection between the manager
+ and the Open vSwitch Database.
+
+
+
+ The Differentiated Service Code Point (DSCP) is specified in the IP
+ header. They are 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 the Quality of Service (QoS) on IP
+ networks.
+ The DSCP value passed when establishing the connection between
+ the manager and the Open vSwitch Database. The connection must be
+ reset for the new DSCP values to take effect. If no value is
+ specified, a default value of 192 is chosen for connection
+ establishment. Valid DSCP values must have their lower 2 bits set to 0.
+
+
+
The overall purpose of these columns is described under Common
Columns
at the beginning of this document.
+
@@ -2939,46 +3097,4 @@
-
- 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 record in this table is meaningful only if it is referenced by the
- column in the
- table. The key used to reference it, called
- the record's ``category,'' determines the meanings of the
- column. The following general forms of
- categories are currently defined:
-
-
- qos-type
- - type is supported as the value for
-
in the table.
-
-
-
-
- Key-value pairs that describe capabilities. The meaning of the pairs
- depends on the category key that the column in the table
- uses to reference this record, as described above.
-
- The presence of a record for category qos-type
- indicates that the switch supports type as the value of
- the column in the
- table. The following key-value pairs are defined to further describe
- QoS capabilities:
-
-
- n-queues
- - Number of supported queues, as a positive integer. Keys in the
-
column for
- records whose value
- equals type must range between 0 and this value minus one,
- inclusive.
-
-
-
-