X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=2744325a0079380cfbf26230d8fff6ae39270e48;hb=29089a540cfa30a834e3ee19a8b4c52ff2e331b2;hp=03c8539d0a448e31a5594f6173c00ae6f514b278;hpb=c75b7e39d973cc9f4869c84d48eeb3b66afb2971;p=sliver-openvswitch.git diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index 03c8539d0..2744325a0 100644 --- a/vswitchd/vswitch.xml +++ b/vswitchd/vswitch.xml @@ -340,7 +340,11 @@ - sFlow configuration. + sFlow(R) configuration. + + + + IPFIX configuration. @@ -409,7 +413,16 @@ 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.

@@ -430,6 +443,12 @@ value. May not be all-zero. + + Human readable description of datapath. It it a maximum 256 + byte-long free-form string to describe the datapath for + debugging purposes, e.g. switch3 in room 3120. + + If set to true, disable in-band control on the bridge @@ -444,6 +463,12 @@ QoS configured, or if the port does not have a queue with the specified ID, the default queue is used instead. + + + List of OpenFlow protocols that may be used when negotiating a + connection with a controller. A default value of + OpenFlow10 will be used if this column is empty. + @@ -547,6 +572,46 @@ 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 MAC addresses to learn. The default is + currently 2048. The value, if specified, is forced into a reasonable + range, currently 10 to 1,000,000. +

+ @@ -753,8 +827,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
@@ -766,7 +845,8 @@
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.
@@ -782,21 +862,6 @@ information such as destination MAC address, IP address, and TCP port. - -
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 @@ -841,7 +906,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.

@@ -854,7 +919,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. @@ -894,42 +959,23 @@ numerically lower priority. - +

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

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

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.

@@ -1089,6 +1135,10 @@ on a host. + + The MAC address in use by this interface. + +

Ethernet address to set for this interface. If unset then the default MAC address is used:

@@ -1121,6 +1171,20 @@ port number for the OpenFlow ``local port''). If the interface cannot be added then Open vSwitch sets this column to -1.

+

When is not set, Open vSwitch picks + an appropriate value for this column and then tries to keep the value + constant across restarts.

+ + + +

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.

 @@ -1152,8 +1216,7 @@
gre
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4 - tunnel. See for information on - configuring GRE tunnels. + tunnel.
ipsec_gre
@@ -1162,13 +1225,42 @@ IPsec tunnel. -
capwap
+
gre64
- An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC - 5415). This allows interoperability with certain switches that do - not support GRE. Only the tunneling component of the protocol is - implemented. UDP ports 58881 and 58882 are used as the source and - destination ports respectively. CAPWAP is currently supported only + 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. +
+ +
vxlan
+
+

+ An Ethernet tunnel over the experimental, UDP-based VXLAN + protocol described at + http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03. + VXLAN is currently supported only with the Linux kernel datapath + with kernel version 2.6.26 or later. +

+

+ As an experimental protocol, VXLAN has no officially assigned UDP + port. Open vSwitch currently uses UDP destination port 8472. + The source port used for VXLAN traffic varies on a per-flow basis + and is in the ephemeral port range. +

+
+ +
lisp
+
+ A layer 3 tunnel over the experimental, UDP-based Locator/ID + Separation Protocol (RFC 6830). LISP is currently supported only with the Linux kernel datapath with kernel version 2.6.26 or later.
@@ -1178,7 +1270,8 @@
null
-
An ignored interface.
+
An ignored interface. Deprecated and slated for removal in + February 2013.
 @@ -1186,7 +1279,8 @@

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

@@ -1201,22 +1295,12 @@

-

- Required. The tunnel endpoint. Unicast and multicast endpoints are - both supported. -

- -

- When a multicast endpoint is specified, a routing table lookup occurs - only when the tunnel is created. Following a routing change, delete - and then re-create the tunnel to force a new routing table lookup. -

+ Required. The tunnel endpoint. Only unicast endpoints are supported. Optional. The destination IP that received packets must match. - Default is to match all addresses. Must be omitted when is a multicast address. + Default is to match all addresses. @@ -1229,8 +1313,9 @@ key="in_key"/> at all.
  • - A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The - tunnel receives only packets with the specified key. + A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit + (for GRE64) number. The tunnel receives only packets with the + specified key.
  • The word flow. The tunnel accepts packets with any @@ -1255,8 +1340,9 @@ key="out_key"/> at all.
  • - A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets - sent through the tunnel will have the specified key. + A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit + (for GRE64) number. Packets sent through the tunnel will have the + specified key.
  • The word flow. Packets sent through the tunnel will @@ -1275,7 +1361,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. @@ -1288,48 +1375,13 @@ 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 - (tunnel) headers. Default is disabled; set to true to - enable. - - - 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. - - - - Optional. Enable tunnel path MTU discovery. If enabled ``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. 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. + Optional. If enabled, the Don't Fragment bit will be set on tunnel + outer headers to allow path MTU discovery. Default is enabled; set + to false to disable. - -

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

    Only gre and ipsec_gre interfaces support @@ -1489,15 +1541,15 @@ The source IP address used for an IPv4 tunnel end-point, such as - gre or capwap. + gre. - 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 . This could be an - internal interface such as a bridge port. + Egress interface for tunnels. Currently only relevant for GRE tunnels + On Linux systems, this column will show the name of the interface + which is responsible for routing traffic destined for the configured + . This could be an internal + interface such as a bridge port. +

    + 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 @@ -1726,6 +1784,18 @@ 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 @@ -1757,9 +1827,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 PCP value. The VLAN ID of the tag is governed by the + 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. @@ -1803,16 +1885,6 @@     - - Used 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. - - The LACP port ID of this . Port IDs are @@ -1859,6 +1931,37 @@ 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. + There is one exception: some hypervisors support ``migration'' from a + given hypervisor to itself (most often for test purposes). During + such a ``migration,'' two instances of a single might both be briefly marked + active on a single hypervisor. +

    +     + The virtual interface associated with this interface. @@ -2043,7 +2146,7 @@

    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 . + (Permanent flows do count against .)

    @@ -2274,36 +2377,12 @@ 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: + See the documentation for + in the + table for a list of destination MAC + addresses which 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, @@ -2688,16 +2767,15 @@ - 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 Differentiated Service Code Point (DSCP) is 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 Quality of + Service (QoS) on IP networks. + + The DSCP value specified here is used when establishing the connection + between the controller and the Open vSwitch. If no value is specified, + a default value of 48 is chosen. Valid DSCP values must be in the + range 0 to 63. @@ -2762,9 +2840,11 @@

    Listens for SSL connections on the specified TCP port - (default: 6632). If ip, which must be expressed as an - IP address (not a DNS name), is specified, then connections are - restricted to the specified local IP address. + (default: 6632). Specify 0 for port to have the + kernel automatically choose an available port. If ip, + which must be expressed as an IP address (not a DNS name), is + specified, then connections are restricted to the specified local + IP address.

    The column in the ptcp:[port][:ip]

    Listens for connections on the specified TCP port - (default: 6632). If ip, which must be expressed as an - IP address (not a DNS name), is specified, then connections are - restricted to the specified local IP address. + (default: 6632). Specify 0 for port to have the kernel + automatically choose an available port. If ip, which + must be expressed as an IP address (not a DNS name), is specified, + then connections are restricted to the specified local IP address.

    When multiple managers are configured, the @@ -2925,6 +3006,14 @@ chosen connection.

    + + + When is ptcp: or + pssl:, this is the TCP port on which the OVSDB server is + listening. (This is is particularly useful when specifies a port of 0, allowing the kernel to + choose any available port.) +     @@ -2935,16 +3024,15 @@ - 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 Differentiated Service Code Point (DSCP) is 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 Quality of + Service (QoS) on IP networks. + + The DSCP value specified here is used when establishing the connection + between the manager and the Open vSwitch. If no value is specified, a + default value of 48 is chosen. Valid DSCP values must be in the range + 0 to 63. @@ -3045,8 +3133,8 @@ -

    An sFlow(R) target. sFlow is a protocol for remote monitoring - of switches.

    +

    A set of sFlow(R) targets. sFlow is a protocol for remote + monitoring of switches.

    Name of the network device whose IP address should be reported as the @@ -3087,4 +3175,75 @@
    + +

    A set of IPFIX collectors. IPFIX is a protocol that exports a + number of details about flows.

    + + + IPFIX target collectors in the form + ip:port. + + + + For per-bridge packet sampling, i.e. when this row is referenced + from a , the rate at which packets should + be sampled and sent to each target collector. If not specified, + defaults to 400, which means one out of 400 packets, on average, + will be sent to each target collector. Ignored for per-flow + sampling, i.e. when this row is referenced from a . + + + + For per-bridge packet sampling, i.e. when this row is referenced + from a , the IPFIX Observation Domain ID + sent in each IPFIX packet. If not specified, defaults to 0. + Ignored for per-flow sampling, i.e. when this row is referenced + from a . + + + + For per-bridge packet sampling, i.e. when this row is referenced + from a , the IPFIX Observation Point ID + sent in each IPFIX flow record. If not specified, defaults to + 0. Ignored for per-flow sampling, i.e. when this row is + referenced from a . + + + + The overall purpose of these columns is described under Common + Columns at the beginning of this document. + + + +
    + + +

    A set of IPFIX collectors of packet samples generated by + OpenFlow sample actions.

    + + + The ID of this collector set, unique among the bridge's + collector sets, to be used as the collector_set_id + in OpenFlow sample actions. + + + + The bridge into which OpenFlow sample actions can + be added to send packet samples to this set of IPFIX collectors. + + + + Configuration of the set of IPFIX collectors to send one flow + record per sampled packet to. + + + + The overall purpose of these columns is described under Common + Columns at the beginning of this document. + + + +
    +