X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=52924ee71304b71b751ab7a8ac967e3205a4eff8;hb=5ea1eab089607de8f87189fe4463364e26576070;hp=e3ea29182e471d97cfe85c013d991ecb7e7ebdfc;hpb=40358701d5d7c8994b36260ed539a4d9c6d20cfe;p=sliver-openvswitch.git diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index e3ea29182..52924ee71 100644 --- a/vswitchd/vswitch.xml +++ b/vswitchd/vswitch.xml @@ -117,6 +117,62 @@ to false (or remove it entirely from the database). +

+ The ovs-ctl's ``restart'' and ``force-reload-kmod'' + functions use the above config option during hot upgrades. +

+ + + +

+ A number of flows as a nonnegative integer. This sets number of + flows at which eviction from the datapath flow table will be + triggered. If there are a large number of flows then increasing this + value to around the number of flows present can result in reduced CPU + usage and packet loss. +

+

+ The default is 2500. Values below 100 will be rounded up to 100. +

+ + + +

+ Specifies userspace behaviour for handling flow misses. This takes + precedence over flow-eviction-threshold. +

+

+

+
auto
+
Handle automatically based on the flow-eviction-threshold and + the flow setup governer (default, recommended).
+
with-facets
+
Always create facets. Expensive kernel flow creation and + statistics tracking is always performed, even on flows with only + a small number of packets.
+
without-facets
+
Always handle without facets. Forces flow misses to be handled + in userspace. May cause an increase in CPU usage and packet loss + on high throughput.
+
+

+ + + +

+ Specifies the number of threads for software datapaths to use for + handling new flows. The default is two less than the number of + online CPU cores (but at least 1). +

+

+ This configuration is per datapath. If you have more than one + software datapath (e.g. some system bridges and some + netdev bridges), then the total number of threads is + n-handler-threads times the number of software + datapaths. +

@@ -594,20 +650,6 @@ datapath ID. - -

- A number of flows as a nonnegative integer. This sets number of - flows at which eviction from the kernel flow table will be triggered. - If there are a large number of flows then increasing this value to - around the number of flows present can result in reduced CPU usage - and packet loss. -

-

- The default is 1000. Values below 100 will be rounded up to 100. -

- - Option to allow forwarding of BPDU frames when NORMAL action is @@ -1182,6 +1224,12 @@ on a host. + + A positive interface index as defined for SNMP MIB-II in RFCs 1213 and + 2863, if the interface has one, otherwise 0. The ifindex is useful for + seamless integration with protocols such as SNMP and sFlow. + + The MAC address in use by this interface. @@ -1293,8 +1341,6 @@ 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.

Open vSwitch uses UDP destination port 4789. The source port used for @@ -1306,8 +1352,7 @@

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. + Separation Protocol (RFC 6830).
patch
@@ -1798,95 +1843,137 @@ -

- BFD, defined in RFC 5880 and RFC 5881, allows point to point - detection of connectivity failures by occasional transmission of - BFD control messages. It is implemented in Open vSwitch to serve - as a more popular and standards compliant alternative to CFM. -

- -

- BFD operates by regularly transmitting BFD control messages at a - rate negotiated independently in each direction. Each endpoint - specifies the rate at which it expects to receive control messages, - and the rate at which it's willing to transmit them. Open vSwitch - uses a detection multiplier of three, meaning that an endpoint - which fails to receive BFD control messages for a period of three - times the expected reception rate, will signal a connectivity - fault. In the case of a unidirectional connectivity issue, the - system not receiving BFD control messages will signal the problem - to its peer in the messages is transmists. -

- -

- The Open vSwitch implementation of BFD aims to comply faithfully - with the requirements put forth in RFC 5880. Currently, the only - known omission is ``Demand Mode'', which we hope to include in - future. Open vSwitch does not implement the optional - Authentication or ``Echo Mode'' features. -

- - - When true BFD is enabled on this - , otherwise it's disabled. Defaults to - false. - - - - The fastest rate, in milliseconds, at which this BFD session is - willing to receive BFD control messages. The actual rate may be - slower if the remote endpoint isn't willing to transmit as quickly as - specified. Defaults to 1000. - - - - The fastest rate, in milliseconds, at which this BFD session is - willing to transmit BFD control messages. The actual rate may be - slower if the remote endpoint isn't willing to receive as quickly as - specified. Defaults to 100. - - - - Concatenated path down may be used when the local system should not - have traffic forwarded to it for some reason other than a connectivty - failure on the interface being monitored. When a controller thinks - this may be the case, it may set cpath_down to - true which may cause the remote BFD session not to - forward traffic to this . Defaults to - false. - - - - State of the BFD session. The BFD session is fully healthy and - negotiated if UP. - +

+ BFD, defined in RFC 5880 and RFC 5881, allows point-to-point + detection of connectivity failures by occasional transmission of + BFD control messages. Open vSwitch implements BFD to serve + as a more popular and standards compliant alternative to CFM. +

- - True if the BFD session believes this may be - used to forward traffic. Typically this means the local session is - signaling UP, and the remote system isn't signaling a - problem such as concatenated path down. - +

+ BFD operates by regularly transmitting BFD control messages at a rate + negotiated independently in each direction. Each endpoint specifies + the rate at which it expects to receive control messages, and the rate + at which it is willing to transmit them. Open vSwitch uses a detection + multiplier of three, meaning that an endpoint signals a connectivity + fault if three consecutive BFD control messages fail to arrive. In the + case of a unidirectional connectivity issue, the system not receiving + BFD control messages signals the problem to its peer in the messages it + transmits. +

- - A short message indicating what the BFD session thinks is wrong in - case of a problem. - +

+ The Open vSwitch implementation of BFD aims to comply faithfully + with RFC 5880 requirements. Open vSwitch does not implement the + optional Authentication or ``Echo Mode'' features. +

- - State of the remote endpoint's BFD session. - + +

+ A controller sets up key-value pairs in the + column to enable and configure BFD. +

+ + + True to enable BFD on this . + + + + The shortest interval, in milliseconds, at which this BFD session + offers to receive BFD control messages. The remote endpoint may + choose to send messages at a slower rate. Defaults to + 1000. + + + + The shortest interval, in milliseconds, at which this BFD session is + willing to transmit BFD control messages. Messages will actually be + transmitted at a slower rate if the remote endpoint is not willing to + receive as quickly as specified. Defaults to 100. + + + + An alternate receive interval, in milliseconds, that must be greater + than or equal to . The + implementation switches from to when there is no obvious incoming + data traffic at the interface, to reduce the CPU and bandwidth cost + of monitoring an idle interface. This feature may be disabled by + setting a value of 0. This feature is reset whenever or + changes. + + + + True to consider the interface capable of packet I/O as long as it + continues to receive any packets (not just BFD packets). This + prevents link congestion that causes consecutive BFD control packets + to be lost from marking the interface down. + + + + Set to true to notify the remote endpoint that traffic should not be + forwarded to this system for some reason other than a connectivty + failure on the interface being monitored. The typical underlying + reason is ``concatenated path down,'' that is, that connectivity + beyond the local system is down. Defaults to false. + + + + Set to true to make BFD accept only control messages with a tunnel + key of zero. By default, BFD accepts control messages with any + tunnel key. + + + + Set to an Ethernet address in the form + xx:xx:xx:xx:xx:xx + to set the MAC used as destination for transmitted BFD packets and + expected as destination for received BFD packets. The default is + 00:23:20:00:00:01. + + - - A short message indicating what the remote endpoint's BFD session - thinks is wrong in case of a problem. - + +

+ The switch sets key-value pairs in the + column to report the status of BFD on this interface. When BFD is + not enabled, with , the switch clears + all key-value pairs from . +

+ + + Reports the state of the BFD session. The BFD session is fully + healthy and negotiated if UP. + + + + Reports whether the BFD session believes this may be used to forward traffic. Typically this + means the local session is signaling UP, and the remote + system isn't signaling a problem such as concatenated path down. + + + + In case of a problem, set to a short message that reports what the + local BFD session thinks is wrong. + + + + Reports the state of the remote endpoint's BFD session. + + + + In case of a problem, set to a short message that reports what the + remote endpoint's BFD session thinks is wrong. + + @@ -1922,6 +2009,11 @@ CFM on this . + + Counts the number of cfm fault flapps since boot. A flap is + considered to be a change of the value. + +

Indicates a connectivity fault triggered by an inability to receive @@ -2064,8 +2156,9 @@

  • To ensure that ovs-vswitchd has enough time to pull statistics - from the datapath, the minimum - is 500ms. + from the datapath, the fault detection interval is set to + 3.5 * MAX(, 500) + ms.
  • @@ -2737,18 +2830,27 @@
    ssl:ip[:port]
    -

    The specified SSL port (default: 6633) on the host at - the given ip, which must be expressed as an IP address - (not a DNS name). The - column in the table must point to a - valid SSL configuration when this form is used.

    +

    The specified SSL port on the host at the + given ip, which must be expressed as an IP + address (not a DNS name). The column in the + table must point to a valid SSL configuration when this form + is used.

    +

    If port is not specified, it currently + defaults to 6633. In the future, the default will change to + 6653, which is the IANA-defined value.

    SSL support is an optional feature that is not always built as part of Open vSwitch.

    tcp:ip[:port]
    -
    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).
    +
    +

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

    +

    If port is not specified, it currently + defaults to 6633. In the future, the default will change to + 6653, which is the IANA-defined value.

    +

    The following connection methods are currently supported for service @@ -2757,26 +2859,29 @@

    pssl:[port][:ip]
    -

    - Listens for SSL connections on the specified TCP port - (default: 6633). 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 table must point to a valid SSL - configuration when this form is used. -

    +

    Listens for SSL connections on the specified TCP + 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 table must point + to a valid SSL configuration when this form is used.

    +

    If port is not specified, it currently + defaults to 6633. In the future, the default will change to + 6653, which is the IANA-defined value.

    SSL support is an optional feature that is not always built as part of Open vSwitch.

    ptcp:[port][:ip]
    - Listens for connections on the specified TCP port - (default: 6633). 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. +

    Listens for connections on the specified TCP + 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.

    +

    If port is not specified, it currently + defaults to 6633. In the future, the default will change to + 6653, which is the IANA-defined value.

    When multiple controllers are configured for a single bridge, the @@ -3048,39 +3153,55 @@

    ssl:ip[:port]

    - The specified SSL port (default: 6632) on the host at - the given ip, which must be expressed as an IP address - (not a DNS name). The - column in the table must point to a - valid SSL configuration when this form is used. + The specified SSL port on the host at the given + ip, which must be expressed as an IP address + (not a DNS name). The column in the + table must point to a valid SSL configuration when this + form is used.

    - SSL support is an optional feature that is not always built as - part of Open vSwitch. + If port is not specified, it currently defaults + to 6632. In the future, the default will change to 6640, + which is the IANA-defined value. +

    +

    + SSL support is an optional feature that is not always + built as part of Open vSwitch.

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

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

    +

    + If port is not specified, it currently defaults + to 6632. In the future, the default will change to 6640, + which is the IANA-defined value. +

    pssl:[port][:ip]

    - Listens for SSL connections on the specified TCP port - (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 port. 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 table must point to a valid SSL configuration when this form is used.

    +

    + If port is not specified, it currently defaults + to 6632. In the future, the default will change to 6640, + which is the IANA-defined value. +

    SSL support is an optional feature that is not always built as part of Open vSwitch. @@ -3088,11 +3209,19 @@

    ptcp:[port][:ip]
    - Listens for connections on the specified TCP port - (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. +

    + Listens for connections on the specified TCP + port. 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. +

    +

    + If port is not specified, it currently defaults + to 6632. In the future, the default will change to 6640, + which is the IANA-defined value. +

    When multiple managers are configured, the @@ -3440,6 +3569,18 @@ referenced from a . + + The maximum period in seconds for which an IPFIX flow record is + cached and aggregated before being sent. If not specified, + defaults to 0. If 0, caching is disabled. + + + + The maximum number of IPFIX flow records that can be cached at a + time. If not specified, defaults to 0. If 0, caching is + disabled. + + The overall purpose of these columns is described under Common Columns at the beginning of this document.