X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=vswitchd%2Fvswitch.xml;h=7b7a1ac928666a8399fa1e1d8bb84c872af204af;hb=cb833cf6c345d9b038ff2ab4fd11a2498cc07efb;hp=141c5fe53e56fcf262fdd059e70502786f7ee579;hpb=ce8876775477a359f3ae14b8cae0ef2212f1681b;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 141c5fe5..7b7a1ac9 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -16,11 +16,6 @@
Set of bridges managed by the daemon.
-
- Remote database clients to which the Open vSwitch's database server
- should connect or to which it should listen.
-
-
SSL used globally by the daemon.
@@ -205,6 +200,42 @@
+
+
+
+ These columns primarily configure the Open vSwitch database
+ (ovsdb-server
), not the Open vSwitch switch
+ (ovs-vswitchd
). The OVSDB database also uses the settings.
+
+
+
+ The Open vSwitch switch does read the database configuration to
+ determine remote IP addresses to which in-band control should apply.
+
+
+
+ Database clients to which the Open vSwitch database server should
+ connect or to which it should listen, along with options for how these
+ 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.
+
+
+
@@ -283,7 +314,7 @@
If this value is unset, the default is implementation-specific.
- When more than one controller is configured,
+
When more than one controller is configured,
is considered only when none of the
configured controllers can be contacted.
@@ -312,7 +343,7 @@
defined key-value pairs are:
bridge-id
- - A unique identifier of the bridge. On Citrix XenServer this
+
- A unique identifier of the bridge. On Citrix XenServer this
will commonly be the same as
xs-network-uuids
.
xs-network-uuids
- Semicolon-delimited set of universally unique identifier(s) for
@@ -329,12 +360,23 @@
datapath-id
- Exactly 16 hex
digits to set the OpenFlow datapath ID to a specific
- value.
+ value. May not be all-zero.
+ disable-in-band
+ - If set to
true
, disable in-band control on
+ the bridge regardless of controller and manager settings.
hwaddr
- An Ethernet address in the form
xx:xx:xx:xx:xx:xx
to set the hardware address of the local port and influence the
datapath ID.
+ in-band-queue
+ -
+ A queue ID as a nonnegative integer. This sets the OpenFlow queue
+ ID that will be used by flows set up by in-band control on this
+ bridge. If unset, or if the port used by an in-band control flow
+ does not have QoS configured, or if the port does not have a queue
+ with the specified ID, the default queue is used instead.
+
@@ -415,11 +457,10 @@
A port that has more than one interface is a ``bonded port.''
Bonding allows for load balancing and fail-over. Open vSwitch
supports ``source load balancing'' (SLB) bonding, which
- assigns flows to slaves based on source MAC address, with
- periodic rebalancing as traffic patterns change. This form of
- bonding does not require 802.3ad or other special support from
- the upstream switch to which the slave devices are
- connected.
+ assigns flows to slaves based on source MAC address and output VLAN,
+ with periodic rebalancing as traffic patterns change. This form of
+ bonding does not require 802.3ad or other special support from the
+ upstream switch to which the slave devices are connected.
These columns apply only to bonded ports. Their values are
otherwise ignored.
@@ -450,7 +491,7 @@
Quality of Service configuration for this port.
-
+
The MAC address to use for this port for the purpose of choosing the
bridge's MAC address. This column does not necessarily reflect the
@@ -539,7 +580,7 @@
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 65280, exclusive, or 65534, the
+ (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.
@@ -573,7 +614,7 @@
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 following
+ defines one and another port defines the other. The following
options may be specified in the column:
remote_ip
@@ -655,13 +696,15 @@
header_cache
- Optional. Enable caching of tunnel headers and the output
- path. This can lead to a significant performance increase
- without changing behavior. In general it should not be
- necessary to adjust this setting. However, the caching can
- bypass certain components of the IP stack (such as IP tables)
- 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.
+ path. This can lead to a significant performance increase
+ without changing behavior. In general it should not be
+ necessary to adjust this setting. However, the caching can
+ bypass certain components of the IP stack (such as IP tables)
+ 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. If IPsec is enabled through the
+ parameters, header caching will be
+ automatically disabled.
capwap
@@ -721,13 +764,13 @@
header_cache
- Optional. Enable caching of tunnel headers and the output
- path. This can lead to a significant performance increase
- without changing behavior. In general it should not be
- necessary to adjust this setting. However, the caching can
- bypass certain components of the IP stack (such as IP tables)
- 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.
+ path. This can lead to a significant performance increase
+ without changing behavior. In general it should not be
+ necessary to adjust this setting. However, the caching can
+ bypass certain components of the IP stack (such as IP tables)
+ 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.
patch
@@ -848,6 +891,11 @@
+
+
+ Connectivity monitor configuration for this interface.
+
+
Key-value pairs for use by external frameworks that integrate
with Open vSwitch, rather than by Open vSwitch itself. System
@@ -864,7 +912,7 @@
For Citrix XenServer, this is the value of the MAC
field in the VIF record for this interface.
iface-id
- - A system-unique identifier for the interface. On XenServer,
+
- A system-unique identifier for the interface. On XenServer,
this will commonly be the same as
xs-vif-uuid
.
@@ -903,7 +951,7 @@
set.
ipsec_psk
Required key for GRE-over-IPsec interfaces. Specifies a
- pre-shared key for authentication that must be identical on
+ pre-shared key for authentication that must be identical on
both sides of the tunnel. Additionally, the
ipsec_local_ip
key must also be set.
@@ -992,6 +1040,14 @@
for information on how this classifier works and how to configure it.
+
+ linux-hfsc
+ -
+ Linux "Hierarchical Fair Service Curve" classifier.
+ See
http://linux-ip.net/articles/hfsc.en/
for
+ information on how this classifier works.
+
+
@@ -1006,8 +1062,8 @@
Key-value pairs for configuring QoS features that depend on
.
- The linux-htb
class supports the following key-value
- pairs:
+ The linux-htb
and linux-hfsc
classes support
+ the following key-value pairs:
max-rate
- Maximum rate shared by all queued traffic, in bit/s.
@@ -1040,7 +1096,8 @@
column="type"/> of
min-rate
are:
min-rate
- - Minimum guaranteed bandwidth, in bit/s. Required.
+ - Minimum guaranteed bandwidth, in bit/s. Required. The
+ floor value is 1500 bytes/s (12,000 bit/s).
The key-value pairs defined for of linux-htb
are:
@@ -1065,6 +1122,17 @@
a queue with a larger value receives any. Specific priority
values are unimportant; only relative ordering matters.
+ The key-value pairs defined for of linux-hfsc
are:
+
+ min-rate
+ - Minimum guaranteed bandwidth, in bit/s. Required.
+ 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
+ if excess bandwidth is available. If unspecified, defaults to no
+ limit.
+
@@ -1076,6 +1144,98 @@
+
+
+ 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
@@ -1173,7 +1333,7 @@
Open vSwitch supports two kinds of OpenFlow controllers:
-
+
- Primary controllers
-
@@ -1298,34 +1458,34 @@
restricted to the specified local IP address.
- When multiple controllers are configured for a single bridge, the
- values must be unique. Duplicate
- values yield unspecified results.
+ When multiple controllers are configured for a single bridge, the
+ values must be unique. Duplicate
+ values yield unspecified results.
- 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 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
@@ -1382,7 +1542,7 @@
These values are considered only when
- is discover
.
+ is discover
.
A POSIX
@@ -1404,14 +1564,14 @@
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.)
+ ) 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.
+ 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.
The IP address to configure on the local port,
@@ -1445,6 +1605,145 @@
+
+
+ Configuration for a database connection to an Open vSwitch database
+ (OVSDB) client.
+
+
+
+ This table primarily configures the Open vSwitch database
+ (ovsdb-server
), not the Open vSwitch switch
+ (ovs-vswitchd
). The switch does read the table to determine
+ what connections should be treated as in-band.
+
+
+
+ The Open vSwitch database server can initiate and maintain active
+ connections to remote clients. It can also listen for database
+ connections.
+
+
+
+
+ Connection method for managers.
+
+ The following connection methods are currently supported:
+
+
+ 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.
+
+
+ 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).
+
+ 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 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.
+
+
+ ptcp:
[port][:ip
]
+ -
+ Listens for 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.
+
+
+ When multiple managers are configured, the
+ values must be unique. Duplicate values yield
+ unspecified results.
+
+
+
+
+ If it is specified, this setting must be one of the following strings
+ that describes how Open vSwitch contacts this OVSDB client over the
+ network:
+
+
+
+ in-band
+ -
+ In this mode, this connection's traffic travels over a bridge
+ managed by Open vSwitch. With this setting, Open vSwitch allows
+ traffic to and from the client regardless of the contents of the
+ OpenFlow flow table. (Otherwise, Open vSwitch would never be able
+ to connect to the client, 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, the client's traffic uses a control network separate
+ from that managed by Open vSwitch, that is, Open vSwitch does not
+ use any of its own network devices to communicate with the client.
+ The control network must be configured separately, before or after
+
ovs-vswitchd
is started.
+
+
+
+
+ If not specified, the default is implementation-specific.
+
+
+
+
+
+
+ Maximum number of milliseconds to wait between connection attempts.
+ Default is implementation-specific.
+
+
+
+ Maximum number of milliseconds of idle time on connection to the client
+ before sending an inactivity probe message. If Open vSwitch does not
+ communicate with the client for the specified 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.
+
+
+
+
+
+ Key-value pairs for use by external frameworks that integrate with Open
+ vSwitch, rather than by Open vSwitch itself. System integrators should
+ either use the Open vSwitch development mailing list to coordinate on
+ common key-value definitions, or choose key names that are likely to be
+ unique. No common key-value pairs are currently defined.
+
+
+
+
A NetFlow target. NetFlow is a protocol that exports a number of
details about terminating IP flows, such as the principals involved