X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=35d59b93f526b39710f42819d42fff6fe9212412;hb=a6363cfddb91620c9325e2812ae5af96a8d7f127;hp=c2786a5c19edb05059429e782e8b156718791b59;hpb=558e2cc58e16f6e3cee44926d69d385d84d42521;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index c2786a5c1..35d59b93f 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -71,6 +71,109 @@
The Citrix XenServer universally unique identifier for the physical
host as displayed by
+ When
+ This option allows for improvement. When
+ Thus, with this option, the procedure for a hot-upgrade of
+
+ The
+ 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.
+
+ xe host-list
.
+
+ ovs-vswitchd
starts up, it has an empty flow table
+ and therefore it handles all arriving packets in its default fashion
+ according to its configuration, by dropping them or sending them to
+ an OpenFlow controller or switching them as a standalone switch.
+ This behavior is ordinarily desirable. However, if
+ ovs-vswitchd
is restarting as part of a ``hot-upgrade,''
+ then this leads to a relatively long period during which packets are
+ mishandled.
+ ovs-vswitchd
+ starts with this value set as true
, it will neither
+ flush or expire previously set datapath flows nor will it send and
+ receive any packets to or from the datapath. When this value is
+ later set to false
, ovs-vswitchd
will
+ start receiving packets from the datapath and re-setup the flows.
+ ovs-vswitchd
becomes roughly the following:
+
+
+ ovs-vswitchd
.
+ true
.
+ ovs-vswitchd
.
+ ovs-ofctl
(or some other program, such as an
+ OpenFlow controller) to restore the OpenFlow flow table
+ to the desired state.
+ false
(or remove it entirely from the database).
+ ovs-ctl
's ``restart'' and ``force-reload-kmod''
+ functions use the above config option during hot upgrades.
+
+
+ auto
with-facets
without-facets
+ 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.
+
switch3 in room 3120
.
+ true
, disable in-band control on the bridge
@@ -537,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. -
-+ 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. +
+
The following modes require the upstream switch to support 802.3ad with
- successful LACP negotiation:
+ successful LACP negotiation. If LACP negotiation fails and
+ other-config:lacp-fallback-ab is true, then active-backup
+ mode is used:
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
- 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
@@ -939,7 +1033,8 @@
in LACP negotiations initiated by a remote switch, but not allowed to
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.
+ disabled, unless other-config:lacp-fallback-ab is set to true.
+ Defaults to off
if unset.
+ Determines the behavior of openvswitch bond in LACP mode. If
+ the partner switch does not support LACP, setting this option
+ to true
allows openvswitch to fallback to
+ active-backup. If the option is set to false
, the
+ bond will be disabled. In both the cases, once the partner switch
+ is configured to LACP mode, the bond will use LACP.
+
Ethernet address to set for this interface. If unset then the default MAC address is used:
@@ -1152,33 +1269,54 @@ address.OpenFlow port number for this interface. Unlike most columns, this - column's value should be set only by Open vSwitch itself. Other - clients should set this column to an empty set (the default) when - creating an .
-Open vSwitch populates this column when the port number becomes - known. If the interface is successfully added, - will be set to a number between 1 and 65535 - (generally either in the range 1 to 65279, inclusive, or 65534, the - 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.
-+ When a client adds a new interface, Open vSwitch chooses an OpenFlow + port number for the new port. If the client that adds the port fills + in , then Open vSwitch tries to use its + value as the OpenFlow port number. Otherwise, or if the requested + port number is already in use or cannot be used for another reason, + Open vSwitch automatically assigns a free port number. Regardless of + how the port number was obtained, Open vSwitch then reports in the port number actually assigned. +
+ ++ Open vSwitch limits the port numbers that it automatically assigns to + the range 1 through 32,767, inclusive. Controllers therefore have + free use of ports 32,768 and up. +
+ ++ OpenFlow port number for this interface. Open vSwitch sets this + column's value, so other clients should treat it as read-only. +
+
+ The OpenFlow ``local'' port (OFPP_LOCAL
) is 65,534.
+ The other valid port numbers are in the range 1 to 65,279,
+ inclusive. Value -1 indicates an error adding the interface.
+
+ Requested OpenFlow port number for this interface. +
+ ++ Open vSwitch currently assigns the OpenFlow port number for an + interface once, when the client first adds the interface. It does + not change the port number later if the client sets or changes or + clears . Therefore, to ensure that + takes effect, the client should set + it in the same database transaction that creates the interface. + (Future versions of Open vSwitch might honor changes to .) +
+gre
ipsec_gre
capwap
vxlan
+ An Ethernet tunnel over the experimental, UDP-based VXLAN
+ protocol described at
+ http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03
.
+
+ Open vSwitch uses UDP destination port 4789. 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). +
++ Only IPv4 and IPv6 packets are supported by the protocol, and + they are sent and received without an Ethernet header. Traffic + to/from LISP ports is expected to be configured explicitly, and + the ports are not intended to participate in learning based + switching. As such, they are always excluded from packet + flooding. +
patch
These options apply to interfaces with of
gre
, ipsec_gre
, gre64
,
- ipsec_gre64
, and capwap
.
+ ipsec_gre64
, vxlan
, and lisp
.
@@ -1278,22 +1432,67 @@
- Required. The tunnel endpoint. Unicast and multicast endpoints are - both supported. -
+Required. The remote tunnel endpoint, one of:
+ +192.168.0.123
.
+ Only unicast endpoints are supported.
+ flow
. The tunnel accepts packets from any
+ remote tunnel endpoint. To process only packets from a specific
+ remote tunnel endpoint, the flow entries may match on the
+ tun_src
field. When sending packets to a
+ remote_ip=flow
tunnel, the flow actions must
+ explicitly set the tun_dst
field to the IP address of
+ the desired remote tunnel endpoint, e.g. with a
+ set_field
action.
+
- 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.
+ The remote tunnel endpoint for any packet received from a tunnel
+ is available in the tun_src
field for matching in the
+ flow table.
+ Optional. The tunnel destination IP that received packets must + match. Default is to match all addresses. If specified, may be one + of: +
+ +192.168.12.3
.
+ flow
. The tunnel accepts packets sent to any
+ of the local IP addresses of the system running OVS. To process
+ only packets sent to a specific IP address, the flow entries may
+ match on the tun_dst
field. When sending packets to a
+ local_ip=flow
tunnel, the flow actions may
+ explicitly set the tun_src
field to the desired IP
+ address, e.g. with a set_field
action. However, while
+ routing the tunneled packet out, the local system may override the
+ specified address with the local IP address configured for the
+ outgoing system interface.
+
+
+ This option is valid only for tunnels also configured with the
+ remote_ip=flow
option.
+
+ The tunnel destination IP address for any packet received from a
+ tunnel is available in the tun_dst
field for matching in
+ the flow table.
+
flow
. The tunnel accepts packets with any
@@ -1332,8 +1532,9 @@
key="out_key"/> at all.
flow
. Packets sent through the tunnel will
@@ -1366,39 +1567,13 @@
system default, typically 64). Default is the system default TTL.
true
to
- enable.
- df_inherit
option is not set, or if
- the encapsulated packet is not IP. 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.
true
to enable. This feature is
- deprecated and will be removed soon.
-
- Only gre
interfaces support these options.
-
Only gre
and ipsec_gre
interfaces support
@@ -1558,15 +1733,15 @@
gre
or capwap
.
+ gre
.
+ 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. +
+ ++ 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. +
+ ++ 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. +
+ ++ A controller sets up key-value pairs in the + column to enable and configure BFD. +
+ +1000
.
+ 100
.
+ 00:23:20:00:00:01
.
+ + 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 . +
+ +UP
.
+ UP
, and the remote
+ system isn't signaling a problem such as concatenated path down.
+
802.1ag Connectivity Fault Management (CFM) allows a group of
@@ -1746,6 +2055,11 @@
CFM on this .
+
Indicates a connectivity fault triggered by an inability to receive
@@ -1871,6 +2185,44 @@
compatibility with 802.1ag compliant implementations. Defaults to
+ When
+ Demand mode has a couple of caveats:
+ false
.
true
, and
+ is true, the CFM
+ module operates in demand mode. When in demand mode, traffic
+ received on the is used to indicate
+ liveness. CCMs are still transmitted and received, but if the
+ is receiving traffic, their absence does not
+ cause a connectivity fault.
+
+
+
down
, the CFM module marks all CCMs it generates as
@@ -1902,16 +2254,6 @@
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.
- 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.
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 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 @@ -2549,26 +2905,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. 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 @@ -2840,37 +3199,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 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). 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. @@ -2878,10 +3255,19 @@
ptcp:
[port][:ip
]+ 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 @@ -3025,6 +3411,14 @@ chosen connection.
+ +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.)
+