X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=602e68713db4e052646122d3aad71020d5bdf93f;hb=70cf679a5a8307f1bae268fcc67741d446990f9c;hp=a467be4e327ccfceedba37c21b037ee38f9f67ce;hpb=52a90c29ab472076fb8f20fba4f847350268e01e;p=openvswitch diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index a467be4e..602e6871 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. @@ -372,8 +362,25 @@ - OpenFlow controller set. If unset, then no OpenFlow controllers - will be used. +

+ OpenFlow controller set. If unset, then no OpenFlow controllers + will be used. +

+ +

+ If there are primary controllers, removing all of them clears the + flow table. If there are no primary controllers, adding one also + clears the flow table. Other changes to the set of controllers, such + as adding or removing a service controller, adding another primary + controller to supplement an existing primary controller, or removing + only one of two primary controllers, have no effect on the flow + table. +

+ + + + Configuration for OpenFlow tables. Each pair maps from an OpenFlow + table ID to configuration for that table. @@ -402,10 +409,23 @@ any defined controllers forever.

-

If this value is unset, the default is implementation-specific.

+

+ The default is standalone if the value is unset, but + future versions of Open vSwitch may change the default. +

+

+ The standalone mode can create forwarding loops on a + bridge that has more than one uplink port unless STP is enabled. To + avoid loops on such a bridge, configure secure mode or + enable STP (see ). +

When more than one controller is configured, is considered only when none of the configured controllers can be contacted.

+

+ Changing when no primary controllers are + configured clears the flow table. +

@@ -446,7 +466,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 @@ -536,6 +556,66 @@ and if Open vSwitch node does not run STP, then this option should be enabled. Default is disabled, set to true to enable. + + The following destination MAC addresss will not be forwarded when this + option is enabled. +
+
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.
+ +
00:e0:2b:00:00:00
+
Extreme Discovery Protocol (EDP).
+ +
+ 00:e0:2b:00:00:04 and 00:e0:2b:00:00:06 +
+
Ethernet Automatic Protection Switching (EAPS).
+ +
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.
+ +
01:00:0c:cc:cc:cx
+
Cisco CFM.
+
+ + + +

+ 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. +

@@ -722,8 +802,13 @@

A port that has more than one interface is a ``bonded port.'' Bonding - allows for load balancing and fail-over. Some kinds of bonding will - work with any kind of upstream switch:

+ allows for load balancing and fail-over.

+ +

+ The following types of bonding will work with any kind of upstream + switch. On the upstream switch, do not configure the interfaces as a + bond: +

balance-slb
@@ -735,14 +820,14 @@
active-backup
Assigns all flows to one slave, failing over to a backup slave when - the active slave is disabled. + the active slave is disabled. This is the only bonding mode in which + interfaces may be plugged into different upstream switches.

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:

@@ -755,6 +840,7 @@
stable
+

Deprecated and slated for removal in February 2013.

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 @@ -774,10 +860,19 @@

The type of bonding used for a bonded port. Defaults to - balance-slb if unset. + active-backup if unset.

+ + An integer hashed along with flows when choosing output slaves in load + balanced bonds. When changed, all flows will be assigned different + hash values possibly causing slave selection decisions to change. Does + not affect bonding modes which do not employ load balancing such as + active-backup. + +

An important part of link bonding is detecting that links are down so @@ -802,7 +897,7 @@

- The number of milliseconds for which carrier must stay up on an + The number of milliseconds for which the link must stay up on an interface before the interface is considered to be up. Specify 0 to enable the interface immediately.

@@ -815,7 +910,7 @@ - The number of milliseconds for which carrier must stay down on an + The number of milliseconds for which the link must stay down on an interface before the interface is considered to be down. Specify 0 to disable the interface immediately. @@ -836,14 +931,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. - +

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. + 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.

- - - Treat LACP like a simple heartbeat protocol for link state - monitoring. Most features of the LACP protocol are disabled - when this mode is in use. The default if not specified is - false. - - - - 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. - - +

These settings control behavior when a bond is in - balance-slb mode, regardless of whether the bond was - intentionally configured in SLB mode or it fell back to SLB mode - because LACP negotiation failed. + balance-slb or balance-tcp mode.

- 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 (link failure still cause flows to move). If + less than 1000ms, the rebalance interval will be 1000ms. @@ -1086,6 +1159,17 @@ cannot be added then Open vSwitch sets this column to -1.

+ + +

Requested OpenFlow port number for this interface. The port + number must be between 1 and 65279, inclusive. Some datapaths + cannot satisfy all requests for particular port numbers. When + this column is empty or the request cannot be fulfilled, the + system will choose a free port. The + column reports the assigned OpenFlow port number.

+

The port number must be requested in the same transaction + that creates the port.

+ @@ -1123,7 +1207,22 @@
ipsec_gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4 - IPsec tunnel. + IPsec tunnel. +
+ +
gre64
+
+ It is same as GRE, but it allows 64 bit key. To store higher 32-bits + of key, it uses GRE protocol sequence number field. This is non + standard use of GRE protocol since OVS does not increment + sequence number for every packet at time of encap as expected by + standard GRE implementation. See + for information on configuring GRE tunnels. +
+ +
ipsec_gre64
+
+ Same as IPSEC_GRE except 64 bit key.
capwap
@@ -1134,6 +1233,9 @@ implemented. UDP ports 58881 and 58882 are used as the source and destination ports respectively. CAPWAP is currently supported only with the Linux kernel datapath with kernel version 2.6.26 or later. + + CAPWAP support is deprecated and will be removed no earlier than + February 2013.
patch
@@ -1142,7 +1244,8 @@
null
-
An ignored interface.
+
An ignored interface. Deprecated and slated for removal in + February 2013.
 @@ -1150,7 +1253,8 @@

These options apply to interfaces with of - gre, ipsec_gre, and capwap. + gre, ipsec_gre, gre64, + ipsec_gre64, and capwap.

@@ -1239,7 +1343,8 @@ Optional. The value of the ToS bits to be set on the encapsulating - packet. It may also be the word inherit, in which case + packet. ToS is interpreted as DSCP and ECN bits, ECN part must be + zero. It may also be the word inherit, in which case the ToS will be copied from the inner packet if it is IPv4 or IPv6 (otherwise it will be 0). The ECN fields are always inherited. Default is 0. @@ -1251,7 +1356,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 @@ -1275,23 +1380,14 @@ 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. + disabled; set to true to enable. This feature is + deprecated and will be removed soon.

Only gre interfaces support these options.

- - - Enable caching of tunnel headers and the output path. This can lead - to a significant performance increase without changing behavior. In - general it should not be necessary to adjust this setting. However, - the caching can bypass certain components of the IP stack (such as - iptables) and it may be useful to disable it if these - features are required or as a debugging measure. Default is enabled, - set to false to disable. - @@ -1517,7 +1613,7 @@ Total number of receive errors, greater than or equal to the sum of the above. - + Number of packets dropped by TX. @@ -1627,6 +1723,12 @@ faulted otherwise.

+

+ When operating over tunnels which have no in_key, or an + in_key of flow. CFM will only accept CCMs + with a tunnel key of zero. +

+ A Maintenance Point ID (MPID) uniquely identifies each endpoint within a Maintenance Association. The MPID is used to identify this endpoint @@ -1653,6 +1755,76 @@

+ + 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. + + + +

When in extended mode, indicates the operational state of the + remote endpoint as either up or down. See + . +

+ + + +

+ 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 @@ -1663,9 +1835,21 @@ - The interval, in milliseconds, between transmissions of CFM heartbeats. - Three missed heartbeat receptions indicate a connectivity fault. - Defaults to 1000. +

+ The interval, in milliseconds, between transmissions of CFM + heartbeats. Three missed heartbeat receptions indicate a + connectivity fault. +

+ +

+ In standard operation only intervals of 3, 10, 100, 1,000, 10,000, + 60,000, or 600,000 ms are supported. Other values will be rounded + down to the nearest value on the list. Extended mode (see ) supports any interval up + to 65,535 ms. In either mode, the default is 1000 ms. +

+ +

We do not recommend using intervals less than 100 ms.

 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. @@ -1755,6 +1949,32 @@ commonly be the same as . + +

+ Hypervisors may sometimes have more than one interface associated + with a given , only one of + which is actually in use at a given time. For example, in some + circumstances XenServer has both a ``tap'' and a ``vif'' interface + for a single , but only + uses one of them at a time. A hypervisor that behaves this way must + mark the currently in use interface active and the + others inactive. A hypervisor that never has more than + one interface for a given + may mark that interface active or omit entirely. +

+ +

+ During VM migration, a given might transiently be marked active on + two different hypervisors. That is, active means that + this is the active + instance within a single hypervisor, not in a broader scope. +

+ + The virtual interface associated with this interface. @@ -1763,6 +1983,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. @@ -1789,6 +2014,11 @@