X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=4288ee6b37f50715b1449a4d1526165534f975cf;hb=b05072ee5ed4a97d0feb03853b881b3e2e2a5536;hp=bb7afe8861ef13977a0b9b65f55b6830b86938bb;hpb=9f5073d8a8c6c21c4e72660b8478a0e9d78764be;p=sliver-openvswitch.git diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index bb7afe886..4288ee6b3 100644 --- a/vswitchd/vswitch.xml +++ b/vswitchd/vswitch.xml @@ -1,15 +1,20 @@ -

A database with this schema holds the configuration for one Open - vSwitch daemon. The root of the configuration for the daemon is - the table, which must have exactly one +

+ A database with this schema holds the configuration for one Open + vSwitch daemon. The top-level configuration for the daemon is the + table, which must have exactly one record. Records in other tables are significant only when they - can be reached directly or indirectly from the - table.

+ can be reached directly or indirectly from the table. Records that are not reachable from + the table are automatically deleted + from the database, except for records in a few distinguished + ``root set'' tables noted below. +

- Configuration for an Open vSwitch daemon. There must be exactly one record - in the table. + Configuration for an Open vSwitch daemon. There must be exactly + one record in the table. @@ -205,9 +210,9 @@

- The Open vSwitch version number, e.g. 1.1.0pre2. + 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.0pre2+build4948. + also included, e.g. 1.1.0+build6579. @@ -244,7 +249,7 @@

The version of the system identified by , - e.g. 5.5.0-24648p on XenServer 5.5.0 build 24648. + e.g. 5.6.100-39265p on XenServer 5.6.100 build 39265.

System integrators are responsible for choosing and setting an @@ -273,21 +278,6 @@ connection should be configured. See the table for more information. - - -

- Remote database clients to which the Open vSwitch's database server - should connect or to which it should listen. Adding an OVSDB target - to this set is equivalent to adding it to with all of the default options. -

- -

- Use of this column is deprecated and may be removed sometime in the - future. New applications should use and set instead. -

-
@@ -526,9 +516,9 @@

- The following mode requires the upstream switch to support 802.3ad with + The following modes require the upstream switch to support 802.3ad with successful LACP negotiation. If LACP negotiation fails then - balance-slb mode is used as a fallback: + balance-slb style flow hashing is used as a fallback:

@@ -540,6 +530,21 @@
+
+
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 + bond-stable-id if set. Otherwise, OpenFlow port + number is used. Decisions are consistent across all ovs-vswitchd + instances with equivalent bond-stable-ids.

+
+
+

These columns apply only to bonded ports. Their values are otherwise ignored.

@@ -642,11 +647,41 @@
The number of milliseconds between successive attempts to poll each interface's MII. Only relevant on ports which use miimon to detect failures.
+
bond-hash-basis
+
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.
+
lacp-system-id
+
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.
lacp-system-priority
The LACP system priority of this . In LACP negotiations, link status decisions are made by the system with the numerically lower priority. Must be a number between 1 and 65535.
+
lacp-time
+
+

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.

+
+
lacp-heartbeat
+
Treats LACP like a simple heartbeat protocol for link state + monitoring. Most features of the LACP protocol are disabled when + this mode is in use.
@@ -790,19 +825,31 @@ adds value for the GRE and encapsulated Ethernet headers. Default is disabled, set to true to enable. +
+
df_inherit
+
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.
+
+
+
df_default
+
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.
+
pmtud
Optional. Enable tunnel path MTU discovery. If enabled - ``ICMP destination unreachable - fragmentation'' needed + ``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. It - also forces the encapsulating packet DF bit to be set (it is - always set if the inner packet implies path MTU discovery). + 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.
+ Default is enabled; set to false to disable.
header_cache
@@ -916,19 +963,31 @@ adds value for the GRE and encapsulated Ethernet headers. Default is disabled, set to true to enable.
+
+
df_inherit
+
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.
+
+
+
df_default
+
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.
+
pmtud
Optional. Enable tunnel path MTU discovery. If enabled - ``ICMP destination unreachable - fragmentation'' needed + ``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. It - also forces the encapsulating packet DF bit to be set (it is - always set if the inner packet implies path MTU discovery). + 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.
+ Default is enabled; set to false to disable.
capwap
@@ -937,7 +996,7 @@ where GRE is not available. Note that only the tunneling component of the protocol is implemented. Due to the non-standard use of CAPWAP, UDP ports 58881 and 58882 are used as the source and - destinations ports respectivedly. Each tunnel must be uniquely + 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, @@ -971,19 +1030,31 @@ (otherwise it will be the system default, typically 64). Default is the system default TTL. +
+
df_inherit
+
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.
+
+
+
df_default
+
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.
+
pmtud
Optional. Enable tunnel path MTU discovery. If enabled - ``ICMP destination unreachable - fragmentation'' needed + ``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. It - also forces the encapsulating packet DF bit to be set (it is - always set if the inner packet implies path MTU discovery). + 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.
+ Default is enabled; set to false to disable.
header_cache
@@ -1015,6 +1086,8 @@
+
null
+
An ignored interface.
@@ -1039,8 +1112,10 @@

- The observed state of the physical network link; - i.e. whether a carrier is detected by the interface. + The observed state of the physical network link. This is ordinarily + the link's carrier status. If the interface's is + a bond configured for miimon monitoring, it is instead the network + link's miimon status.

@@ -1065,6 +1140,10 @@ and many kinds of virtual interfaces can be configured with higher MTUs.

+

+ This column will be empty for an interface that does not + have an MTU as, for example, some kinds of tunnels do not. +

@@ -1187,10 +1266,46 @@ + +

+ 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 . + + + + 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. + + + - - Connectivity monitor configuration for this interface. + + Boolean value indicating LACP status for this interface. If true, this + interface has current LACP information about its LACP partner. This + information may be used to monitor the health of interfaces in a LACP + enabled port. This column will be empty if LACP is not enabled. @@ -1236,11 +1351,32 @@ 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-ids 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 + participating in a bond. Must be a number between 1 and + 65535.
lacp-port-priority
The LACP port priority of this . In LACP negotiations s with numerically lower priorities are preferred for aggregation. Must be a number between 1 and 65535.
+
lacp-aggregation-key
+
The LACP aggregation key of this . + s with different aggregation keys may not + be active within a given at the same time. Must + be a number between 1 and 65535.
 @@ -1390,7 +1526,7 @@ column="type"/> of linux-htb are:

min-rate
-
Minimum guaranteed bandwidth, in bit/s. Required.
+
Minimum guaranteed bandwidth, in bit/s.
max-rate
Maximum allowed bandwidth, in bit/s. Optional. If specified, the queue's rate will not be allowed to exceed the specified value, even @@ -1413,7 +1549,7 @@ column="type"/> of linux-hfsc are:

min-rate
-
Minimum guaranteed bandwidth, in bit/s. Required.
+
Minimum guaranteed bandwidth, in bit/s.
max-rate
Maximum allowed bandwidth, in bit/s. Optional. If specified, the queue's rate will not be allowed to exceed the specified value, even @@ -1431,98 +1567,6 @@ - -

- 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. - - - - - - A set of MPIDs representing MPs to which this - has detected connectivity that are not in the - set. This should not - have connectivity to any MPs not listed in . - Thus, if this set is non-empty a fault is indicated. - - - - A set of MAIDs representing foreign Maintenance Associations (MAs) - which this has detected connectivity to. A - should not have connectivity to a Maintenance - Association other than its own. Thus, if this set is non-empty a fault - is indicated. - - - - 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 @@ -1535,6 +1579,12 @@ +

+ To be selected for mirroring, a given packet must enter or leave the + bridge through a selected port and it must also be in one of the + selected VLANs. +

+ If true, every packet arriving or departing on any port is selected for mirroring. @@ -1555,9 +1605,13 @@ +

+ These columns are mutually exclusive. Exactly one of them must be + nonempty. +

+ -

Output port for selected packets, if nonempty. Mutually exclusive - with .

+

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 @@ -1566,8 +1620,7 @@ -

Output VLAN for selected packets, if nonempty. Mutually exclusive - with .

+

Output VLAN for selected packets, if nonempty.

The frames will be sent out all ports that trunk , as well as any ports with implicit VLAN . When a mirrored frame is sent out a @@ -1698,23 +1751,6 @@

The specified TCP port (default: 6633) on the host at the given ip, which must be expressed as an IP address (not a DNS name).
-
discover
-
-

Enables controller discovery.

-

In controller discovery mode, Open vSwitch broadcasts a DHCP - request with vendor class identifier OpenFlow across - all of the bridge's network devices. It will accept any valid - DHCP reply that has the same vendor class identifier and includes - a vendor-specific option with code 1 whose contents are a string - specifying the location of the controller in the same format as - .

-

The DHCP reply may also, optionally, include a vendor-specific - option with code 2 whose contents are a string specifying the URI - to the base of the OpenFlow PKI - (e.g. http://192.168.0.1/openflow/pki). This URI is - used only for bootstrapping the OpenFlow PKI at initial switch - setup; ovs-vswitchd does not use it at all.

-

The following connection methods are currently supported for service @@ -1774,10 +1810,7 @@ -

If not specified, the default is implementation-specific. If - is discover, the connection mode - is always treated as in-band regardless of the actual - setting.

+

If not specified, the default is implementation-specific.

 @@ -1794,7 +1827,8 @@ number of seconds, it will send a probe. If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect. - Default is implementation-specific. + Default is implementation-specific. A value of 0 disables + inactivity probes. @@ -1827,33 +1861,9 @@ - -

These values are considered only when - is discover.

- - - A POSIX - extended regular expression against which the discovered controller - location is validated. The regular expression is implicitly - anchored at the beginning of the controller location string, as - if it begins with ^. If not specified, the default - is implementation-specific. - - - - Whether to update /etc/resolv.conf when the - controller is discovered. If not specified, the default - is implementation-specific. Open vSwitch will only modify - /etc/resolv.conf if the DHCP response that it receives - specifies one or more DNS servers. - - -

These values are considered only in in-band control mode (see - ) and only when - is not discover. (For controller discovery, the network - configuration obtained via DHCP is used instead.)

+ ).

When multiple controllers are configured on a single bridge, there should be only one set of unique values in these columns. If different @@ -1903,15 +1913,11 @@

other
Allows the controller access to all OpenFlow features.
-
-
master
Equivalent to other, except that there may be at most one master controller at a time. When a controller configures itself as master, any existing master is demoted to the slaverole.
-
-
slave
Allows the controller read-only access to OpenFlow features. Attempts to modify the flow table will be rejected with an @@ -1928,19 +1934,23 @@
A human-readable description of the last error on the connection to the controller; i.e. strerror(errno). This key will exist only if an error has occurred.
-
-
state
The state of the connection to the controller. Possible values - are: VOID, BACKOFF, - CONNECTING, ACTIVE, and - IDLE.
-
-
-
time_in_state
-
Seconds since connecting to (if currently connected) or - disconnecting from (if currently disconnected) this - controller.
+ are: VOID (connection is disabled), + BACKOFF (attempting to reconnect at an increasing + period), CONNECTING (attempting to connect), + ACTIVE (connected, remote host responsive), and + IDLE (remote host idle, sending keep-alive). These + values may change in the future. They are provided only for human + consumption. +
sec_since_connect
+
The amount of time since this controller last successfully + connected to the switch (in seconds). Value is empty if controller + has never successfully connected.
+
sec_since_disconnect
+
The amount of time since this controller last disconnected from + the switch (in seconds). Value is empty if controller has never + disconnected.
 @@ -2071,6 +2081,7 @@ will send a probe. If a response is not received for the same additional amount of time, Open vSwitch assumes the connection has been broken and attempts to reconnect. Default is implementation-specific. + A value of 0 disables inactivity probes. @@ -2103,15 +2114,23 @@
The state of the connection to the manager. Possible values are: VOID (connection is disabled), BACKOFF (attempting to reconnect at an increasing - period), CONNECT_IN_PROGRESS (attempting to connect), + period), CONNECTING (attempting to connect), ACTIVE (connected, remote host responsive), and - IDLE (remote host unresponsive, disconnecting). These + IDLE (remote host idle, sending keep-alive). These values may change in the future. They are provided only for human consumption.
-
time_in_state
-
Milliseconds since the state key changed.
+
sec_since_connect
+
The amount of time since this manager last successfully connected + to the database (in seconds). Value is empty if manager has never + successfully connected.
+
+
+
sec_since_disconnect
+
The amount of time since this manager last disconnected from the + database (in seconds). Value is empty if manager has never + disconnected.