X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=3e13682393ce85dab220f974f6592d088b724c10;hb=8a07709cb80462edb32fc11d056bfc08ce90f62d;hp=2f9a534d434d1642b3cc7768023f93a32b00dfe5;hpb=88f69f88b877e14ae3fb842ae74c1316dc6dee0a;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 2f9a534d4..3e1368239 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
.
@@ -388,6 +378,11 @@
+
+ Configuration for OpenFlow tables. Each pair maps from an OpenFlow
+ table ID to configuration for that table.
+
+
When a controller is configured, it is, ordinarily, responsible
for setting up all flows on the switch. Thus, if the connection to
@@ -462,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
@@ -553,6 +548,26 @@
should be enabled. Default is disabled, set to
true
to enable.
+
+
+
+ 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.
+
+
@@ -757,8 +772,7 @@
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:
@@ -790,7 +804,7 @@
The type of bonding used for a bonded port. Defaults to
- balance-slb
if unset.
+ active-backup
if unset.
@@ -861,14 +875,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 system ID of a
LACP bond is used to identify itself to its partners. Must be a
- nonzero MAC address.
+ nonzero MAC address. Defaults to the bridge Ethernet address if
+ unset.
- 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 (carrier status changes still cause flows to move). If
+ less than 1000ms, the rebalance interval will be 1000ms.
@@ -1141,7 +1159,7 @@
ipsec_gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
- IPsec tunnel.
+ IPsec tunnel.
capwap
@@ -1269,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
@@ -1535,7 +1553,7 @@
Total number of receive errors, greater than or equal to the sum of
the above.
-
+
Number of packets dropped by TX.
@@ -1671,6 +1689,43 @@
+
+ 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.
+
+
When CFM is properly configured, Open vSwitch will occasionally
receive CCM broadcasts. These broadcasts contain the MPID of the
@@ -1714,6 +1769,15 @@
with the given value.
+
+ 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.
+
+
@@ -1781,6 +1845,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.
@@ -1807,6 +1876,11 @@
+ -
+ The VLAN is the
value in any record.
+
+
-
The VLAN is listed within the
column of the record of an interface on which
@@ -1850,6 +1924,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.
+
@@ -1862,15 +1942,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 . The
+ supported values are:
+
+
+
+ refuse
+ -
+ Refuse to add the flow or flows. This is also the default policy
+ when
is unset.
+
+
+ evict
+ -
+ Delete the flow that will expire soonest. See
+ for details.
+
+
+
+
+
+
+ When is evict
, this
+ controls how flows are chosen for eviction when the flow table would
+ otherwise exceed flows. Its value is a set
+ of NXM fields or sub-fields, each of which takes one of the forms
+ 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 is not evict
, this
+ column has no effect.
+
+
+
+
Quality of Service (QoS) configuration for each Port that
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
-
@@ -1895,8 +2066,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.)
+
@@ -1904,7 +2086,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
@@ -1936,25 +2118,13 @@
unchanged.
-
-
- These key-value pairs are defined for of min-rate
.
-
-
-
- Minimum guaranteed bandwidth, in bit/s. Required. The floor value is
- 1500 bytes/s (12,000 bit/s).
-
-
-
- These key-value pairs are defined for of linux-htb
.
+
+ linux-htb
may use queue_id
s less than 61440.
+ It has the following key-value pairs defined.
-
+
Minimum guaranteed bandwidth, in bit/s.
@@ -1987,15 +2157,16 @@
- These key-value pairs are defined for of linux-hfsc
.
+
+ 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
@@ -2328,25 +2499,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.
+
@@ -2446,14 +2642,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
@@ -2824,46 +3020,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.
-
-
-
-