X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=500a0f967768a27b4b9573ecd72062b2b9cc3a8e;hb=cd11000ba2ce68a6eaeabed7efcb061b39ceaa44;hp=e6ad3872701c17fc98141e0c3d9120e0776aad9e;hpb=a0bc29a541fc7dc6e20137d5558e2094d614e6ab;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index e6ad3872..500a0f96 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -16,7 +16,7 @@
- Default used by bridges. May be
+ Default OpenFlow set used by bridges. May be
overridden on a per-bridge basis by the column in .
@@ -104,10 +104,11 @@
- OpenFlow controller. If unset, defaults to that specified by
- in the
- table. If the default is also unset, then
- no OpenFlow controller will be used.
+ OpenFlow controller set. If unset, defaults to the set of
+ controllers specified by in the
+ table. If the default is also unset, then no OpenFlow
+ controllers will be used.
@@ -127,8 +128,8 @@
The currently defined key-value pairs are:
network-uuids
- - Space-delimited set of universally unique identifier(s) for the
- network with which this bridge is associated. The form of the
+
- Semicolon-delimited set of universally unique identifier(s) for
+ the network with which this bridge is associated. The form of the
identifier(s) depends on the type of the host. On a Citrix
XenServer host, the network identifiers are RFC 4122 UUIDs as
displayed by, e.g.,
xe network-list
.
@@ -278,6 +279,13 @@
hwaddr
- An Ethernet address in the form
xx:xx:xx:xx:xx:xx
.
+ bond-rebalance-interval
+ - For a bonded port, the number of milliseconds between
+ successive attempts to rebalance the bond, that is, to
+ move source MACs and their flows from one interface on
+ the bond to another in an attempt to keep usage of each
+ interface roughly equal. The default is 10000 (10
+ seconds), and the minimum is 1000 (1 second).
@@ -349,7 +357,94 @@
tap
A TUN/TAP device managed by Open vSwitch.
gre
- A GRE tunnel device managed by Open vSwitch.
+ An Ethernet over RFC 1702 Generic Routing Encapsulation over IPv4
+ tunnel. Each tunnel must be uniquely identified by the
+ combination of remote_ip
, local_ip
, and
+ in_key
. Note that if two ports are defined that are
+ the same except one has an optional identifier and the other does
+ not, the more specific one is matched first. in_key
+ is considered more specific than local_ip
if a port
+ defines one and another port defines the other. The arguments
+ are:
+
+ remote_ip
+ - Required. The tunnel endpoint.
+
+
+ local_ip
+ - Optional. The destination IP that received packets must
+ match. Default is to match all addresses.
+
+
+ in_key
+ - Optional. The GRE key that received packets must contain.
+ It may either be a 32-bit number (no key and a key of 0 are
+ treated as equivalent) or the word
flow
. If
+ flow
is specified then any key will be accepted
+ and the key will be placed in the tun_id
field
+ for matching in the flow table. The ovs-ofctl manual page
+ contains additional information about matching fields in
+ OpenFlow flows. Default is no key.
+
+
+ out_key
+ - Optional. The GRE key to be set on outgoing packets. It may
+ either be a 32-bit number or the word
flow
. If
+ flow
is specified then the key may be set using
+ the set_tunnel
Nicira OpenFlow vendor extension (0
+ is used in the absense of an action). The ovs-ofctl manual
+ page contains additional information about the Nicira OpenFlow
+ vendor extensions. Default is no key.
+
+
+ key
+ - Optional. Shorthand to set
in_key
and
+ out_key
at the same time.
+
+
+ tos
+ - Optional. The value of the ToS bits to be set on the
+ encapsulating packet. 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). Note that the ECN fields are always inherited. Default is
+ 0.
+
+
+ ttl
+ - Optional. The TTL to be set on the encapsulating packet.
+ It may also be the word
inherit
, in which case the
+ TTL will be copied from the inner packet if it is IPv4 or IPv6
+ (otherwise it will be the system default, typically 64).
+ Default is the system default TTL.
+
+
+ csum
+ - Optional. Compute GRE checksums for outgoing packets and
+ require checksums for incoming packets. Default is enabled,
+ set to
false
to disable.
+
+
+ pmtud
+ - 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. It
+ also forces the encapsulating packet DF bit to be set (it is
+ always set if the inner packet implies path MTU discovery).
+ 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.
+
+
+ patch
+ A pair of virtual devices that act as a patch cable. A
+ peer
argument is required that indicates the name
+ of the other side of the patch. Since a patch must work in
+ pairs, a second patch interface must be declared with the
+ name
and peer
arguments reversed.
@@ -493,13 +588,20 @@
- An OpenFlow controller.
+ An OpenFlow controller.
+
+ Open vSwitch permits a bridge to have any number of OpenFlow
+ controllers. When multiple controllers are configured, Open vSwitch
+ connects to all of them simultaneously. OpenFlow 1.0 does not specify
+ how multiple controllers coordinate in interacting with a single switch,
+ so more than one controller should be specified only if the controllers
+ are themselves designed to coordinate with each other.
- Connection method for controller.
- The following connection methods are currently
- supported:
+ Connection method for controller.
+ The following connection methods are currently
+ supported:
ssl:ip
[:port
]
-
@@ -516,15 +618,58 @@
the given ip, which must be expressed as an IP address
(not a DNS name).
discover
- - Enables controller discovery.
+ -
+
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.
+
none
- Disables the controller.
+ When multiple controllers are configured for a single bridge, the
+ values must be unique. Duplicate
+ values yield unspecified results.
- Either in-band
or out-of-band
. If not
- specified, the default is implementation-specific.
+ If it is specified, this setting must be one of the following
+ strings that describes how Open vSwitch contacts this OpenFlow
+ controller over the network:
+
+
+ in-band
+ - In this mode, this controller's OpenFlow traffic travels over the
+ bridge associated with the controller. With this setting, Open
+ vSwitch allows traffic to and from the controller regardless of the
+ contents of the OpenFlow flow table. (Otherwise, Open vSwitch
+ would never be able to connect to the controller, because it did
+ not have a flow to enable it.) This is the most common connection
+ mode because it is not necessary to maintain two independent
+ networks.
+ out-of-band
+ - In this mode, OpenFlow traffic uses a control network separate
+ from the bridge associated with this controller, that is, the
+ bridge does not use any of its own network devices to communicate
+ with the controller. The control network must be configured
+ separately, before or after
ovs-vswitchd
is started.
+
+
+
+ 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.
@@ -558,7 +703,7 @@
times the inactivity probe interval
(see ), then Open vSwitch
will take over responsibility for setting up flows. In
- this mode, Open vSwitch causes the datapath to act like an
+ this mode, Open vSwitch causes the bridge to act like an
ordinary MAC-learning switch. Open vSwitch will continue
to retry connecting to the controller in the background
and, when the connection succeeds, it will discontinue its
@@ -569,19 +714,20 @@
connecting to the controller forever.
- If this value is unset, the default is
- implementation-specific.
+ If this value is unset, the default is implementation-specific.
+ When more than one controller is configured,
+ is considered only when none of the
+ configured controllers can be contacted. At that point, the bridge
+ enters secure mode if any of the controllers'
+ is set to secure
. Otherwise,
+ it enters standalone mode if at least one
+ is set to standalone
. If none of the
+ values are set, the default is
+ implementation-defined.
-
- In conjunction with ,
- the maximum number of unused packet credits that the bridge will
- allow to accumulate, in packets. If not specified, the default
- is implementation-specific.
-
-
The maximum rate at which packets in unknown flows will be
forwarded to the OpenFlow controller, in packets per second. This
@@ -601,11 +747,21 @@
actual rate that packets are sent to the controller is up to
twice the specified rate.
+
+
+ In conjunction with ,
+ the maximum number of unused packet credits that the bridge will
+ allow to accumulate, in packets. If not specified, the default
+ is implementation-specific.
+
-
+
+ These values are considered only when
+ is discover
.
+
- If is discover
, a POSIX
+ 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
@@ -614,8 +770,7 @@
- If is discover
,
- whether to update /etc/resolv.conf
when the
+ 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
@@ -623,20 +778,35 @@
-
-
- If is not discover
, the IP
- address of the gateway to configure on the local port.
-
+
+ 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
+ values are set for these columns in different controllers, the effect
+ is unspecified.
- If is not discover
, the IP
- address to configure on the local port.
+ The IP address to configure on the local port,
+ e.g. 192.168.0.123
. If this value is unset, then
+ and are
+ ignored.
- If is not discover
, the IP
- netmask to configure on the local port.
+ The IP netmask to configure on the local port,
+ e.g. 255.255.255.0
. If is set
+ but this value is unset, then the default is chosen based on whether
+ the IP address is class A, B, or C.
+
+
+
+ The IP address of the gateway to configure on the local port, as a
+ string, e.g. 192.168.0.1
. Leave this column unset if
+ this network has no gateway.