X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=b3f00752a52c9f4e5bf4dc66ced7a15290ee8f8b;hb=ddffedda18b6f919cb896265e126574d75fcaf00;hp=7cfba180cb899151599b59b67094ca1cd5a9a5b1;hpb=b1da6250481f6879d0727710eea87d5f61d6a24c;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 7cfba180..b3f00752 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -28,12 +28,6 @@
choose key names that are likely to be unique. The currently
defined common key-value pairs are:
- system-type
- - An identifier for the switch type, such as
-
XenServer
or KVM
.
- system-version
- - The version of the switch software, such as
-
5.6.0
on XenServer.
system-id
- A unique identifier for the Open vSwitch's physical host.
The form of the identifier depends on the type of the host.
@@ -201,6 +195,65 @@
+
+
+ These columns report the types and versions of the hardware and
+ software running Open vSwitch. We recommend in general that software
+ should test whether specific features are supported instead of relying
+ on version number checks. These values are primarily intended for
+ reporting to human administrators.
+
+
+
+ The Open vSwitch version number, e.g. 1.1.0pre2
.
+ If Open vSwitch was configured with a build number, then it is
+ also included, e.g. 1.1.0pre2+build4948
.
+
+
+
+
+ The database schema version number in the form
+ major.minor.tweak
,
+ e.g. 1.2.3
. Whenever the database schema is changed in
+ a non-backward compatible way (e.g. deleting a column or a table),
+ major is incremented. When the database schema is changed
+ in a backward compatible way (e.g. adding a new column),
+ minor is incremented. When the database schema is changed
+ cosmetically (e.g. reindenting its syntax), tweak is
+ incremented.
+
+
+
+ The schema version is part of the database schema, so it can also be
+ retrieved by fetching the schema using the Open vSwitch database
+ protocol.
+
+
+
+
+
+ An identifier for the type of system on top of which Open vSwitch
+ runs, e.g. XenServer
or KVM
.
+
+
+ System integrators are responsible for choosing and setting an
+ appropriate value for this column.
+
+
+
+
+
+ The version of the system identified by ,
+ e.g. 5.5.0-24648p
on XenServer 5.5.0 build 24648.
+
+
+ System integrators are responsible for choosing and setting an
+ appropriate value for this column.
+
+
+
+
+
These columns primarily configure the Open vSwitch database
@@ -314,7 +367,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.
@@ -343,7 +396,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
@@ -362,7 +415,7 @@
digits to set the OpenFlow datapath ID to a specific
value. May not be all-zero.
disable-in-band
- - If set to
true
, disable in-band control on
+ - If set to
true
, disable in-band control on
the bridge regardless of controller and manager settings.
hwaddr
- An Ethernet address in the form
@@ -457,11 +510,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.
@@ -492,7 +544,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
@@ -615,7 +667,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
@@ -892,6 +944,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
@@ -908,7 +965,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
.
@@ -947,7 +1004,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.
@@ -1140,6 +1197,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
@@ -1237,7 +1386,7 @@
Open vSwitch supports two kinds of OpenFlow controllers:
-
+
- Primary controllers
-
@@ -1593,7 +1742,7 @@
that describes how Open vSwitch contacts this OVSDB client over the
network:
-
+
in-band
-