X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=c12fd8fc31c2bc788a47bfb1d423cbc52b127e19;hb=a5ae88ff8a276e86c842ac102145432662bf711a;hp=4a0225c5cae8b8179215f415d4ac9caa09bf3d70;hpb=629d868ce79cb4e74e63434c9bc2326a9f7f1762;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 4a0225c5c..c12fd8fc3 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
@@ -453,6 +566,12 @@
QoS configured, or if the port does not have a queue with the specified
ID, the default queue is used instead.
OpenFlow10
will be used if this column is empty.
+ - 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. +
+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
@@ -896,7 +995,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.
0
to disable the interface immediately.
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.
Ethernet address to set for this interface. If unset then the default MAC address is used:
@@ -1159,6 +1266,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.
gre
ipsec_gre
capwap
gre64
ipsec_gre64
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
patch
null
These options apply to interfaces with of
- gre
, ipsec_gre
, and capwap
.
+ gre
, ipsec_gre
, gre64
,
+ ipsec_gre64
, vxlan
, and lisp
.
@@ -1239,22 +1386,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
@@ -1293,8 +1486,9 @@
key="out_key"/> at all.
flow
. Packets sent through the tunnel will
@@ -1327,48 +1521,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.
- 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.
-
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
@@ -1528,15 +1687,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. 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 it transmits. +
+ ++ 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. +
+ +true
BFD is enabled on this
+ , otherwise it's disabled. Defaults to
+ false
.
+ 1000
.
+ 100
.
+ decay_min_rx
is used to set the min_rx
,
+ when there is no obvious incoming data traffic at the interface.
+ It cannot be set less than the min_rx
. The decay feature
+ is disabled by setting the decay_min_rx
to 0. And the
+ feature is reset everytime itself or min_rx
is
+ reconfigured.
+ forwarding_if_rx
is true the interface will be
+ considered capable of packet I/O as long as there is packet
+ received at interface. This is important in that when link becomes
+ temporarily conjested, consecutive BFD control packets can be lost.
+ And the forwarding_if_rx
can prevent link failover by
+ detecting non-control packets received at interface.
+ cpath_down
to
+ true
which may cause the remote BFD session not to
+ forward traffic to this . Defaults to
+ false
.
+ in_key
of zero. Defaults to
+ false
.
+ 00:23:20:00:00:01
is used.
+ 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 @@ -1702,6 +1986,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.
+
false
.
+ When 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.
+
+ Demand mode has a couple of caveats: +
down
, the CFM module marks all CCMs it generates as
@@ -1857,7 +2185,7 @@
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 @@ -2513,26 +2845,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 @@ -2804,37 +3139,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. @@ -2842,10 +3195,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 @@ -2989,6 +3351,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.)
+