X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=3e13682393ce85dab220f974f6592d088b724c10;hb=8a07709cb80462edb32fc11d056bfc08ce90f62d;hp=f4515f4fe175f3f5b4b7f80a01eebb561305768a;hpb=f915f1a8ca180828983ef22cf2fd21b8f010b972;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index f4515f4fe..3e1368239 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -1,15 +1,55 @@
A database with this schema holds the configuration for one Open
- vSwitch daemon. The root of the configuration for the daemon is
- the table, which must have exactly one
+
+ A database with this schema holds the configuration for one Open
+ vSwitch daemon. The top-level configuration for the daemon is the
+ table, which must have exactly one
record. Records in other tables are significant only when they
- can be reached directly or indirectly from the
- table.
+ Most tables contain two special columns, named other_config
+ and external_ids
. These columns have the same form and
+ purpose each place that they appear, so we describe them here to save space
+ later.
+
other_config
: map of string-string pairs+ Key-value pairs for configuring rarely used features. Supported keys, + along with the forms taken by their values, are documented individually + for each table. +
+
+ A few tables do not have other_config
columns because no
+ key-value pairs have yet been defined for them.
+
external_ids
: map of string-string pairs+ VLAN IDs of VLANs on which MAC address learning should be disabled, + so that packets are flooded instead of being sent to specific ports + that are believed to contain packets' destination MACs. This should + ordinarily be used to disable MAC learning on VLANs used for + mirroring (RSPAN VLANs). It may also be useful for debugging. +
+
+ SLB bonding (see the column in
+ the table) is incompatible with
+ flood_vlans
. Consider using another bonding mode or
+ a different type of mirror instead.
+
+ OpenFlow controller set. If unset, then no OpenFlow controllers + will be used. +
+ ++ If there are primary controllers, removing all of them clears the + flow table. If there are no primary controllers, adding one also + clears the flow table. Other changes to the set of controllers, such + as adding or removing a service controller, adding another primary + controller to supplement an existing primary controller, or removing + only one of two primary controllers, have no effect on the flow + table. +
+When a controller is configured, it is, ordinarily, responsible - for setting up all flows on the switch. Thus, if the connection to - the controller fails, no new network connections can be set up. - If the connection to the controller stays down long enough, - no packets can pass through the switch at all. This setting - determines the switch's response to such a situation. It may be set - to one of the following: -
standalone
secure
standalone
secure
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.
+ is considered only when none of the + configured controllers can be contacted. ++ Changing when no primary controllers are + configured clears the flow table. +
other-config
- instead.)
+ Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
+ (Setting this column has no useful effect. Set instead.)
+ true
, disable in-band control on the bridge
+ regardless of controller and manager settings.
+ forwarding
, in seconds. By default, the
+ forwarding delay is 15 seconds.
netdev
.
- bridge-id
xs-network-uuids
.xs-network-uuids
xe network-list
.datapath-id
disable-in-band
true
, disable in-band control on
- the bridge regardless of controller and manager settings.hwaddr
in-band-queue
xe network-list
.
+ + 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. +
+true
to enable.
+ + The maximum number of seconds to retain a MAC learning entry for + which no packets have been seen. The default is currently 300 + seconds (5 minutes). The value, if specified, is forced into a + reasonable range, currently 15 to 3600 seconds. +
+ ++ A short MAC aging time allows a network to more quickly detect that a + host is no longer connected to a switch port. However, it also makes + it more likely that packets will be flooded unnecessarily, when they + are addressed to a connected host that rarely transmits packets. To + reduce the incidence of unnecessary flooding, use a MAC aging time + longer than the maximum interval at which a host will ordinarily + transmit packets. +
++ Status information about bridges. +
+
+ The bridge-id (in hex) used in spanning tree advertisements.
+ Configuring the bridge-id is described in the
+ stp-system-id
and stp-priority
keys
+ of the other_config
section earlier.
+
+ The designated root (in hex) for this spanning tree. +
++ The path cost of reaching the designated bridge. A lower + number is better. +
+Common
+ Columns
at the beginning of this document.
+
+ false
otherwise.
Key-value pairs that report manager status.
-last_error
strerror(errno)
. This key
- will exist only if an error has occurred.state
VOID
(connection is disabled),
- BACKOFF
(attempting to reconnect at an increasing
- period), CONNECT_IN_PROGRESS
(attempting to connect),
- ACTIVE
(connected, remote host responsive), and
- IDLE
(remote host unresponsive, disconnecting). These
- values may change in the future. They are provided only for human
- consumption.strerror(errno)
. This key
+ will exist only if an error has occurred.
+ + The state of the connection to the manager: +
time_in_state
state
key changed.VOID
BACKOFF
CONNECTING
ACTIVE
IDLE
+ These values may change in the future. They are provided only for + human consumption. +
+
+ When specifies a connection method that
+ listens for inbound connections (e.g. ptcp:
or
+ pssl:
) and more than one connection is actually active,
+ the value is the number of active connections. Otherwise, this
+ key-value pair is omitted.
+
+ When multiple connections are active, status columns and key-value + pairs (other than this one) report the status of one arbitrarily + chosen connection. +
Common
+ Columns
at the beginning of this document.
+
+