X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=a16ddfbf10d8e6a43eaaf42c58fcd3f3b50ac327;hb=c84933bf9a73e334207b6b309749d9e9c3b04812;hp=2edb35e0d45df0034ef05596af2f86199910cacd;hpb=a339aa8162f4ac29784bc4e35612137f9cb1a025;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 2edb35e0d..a16ddfbf1 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -1,15 +1,20 @@
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.
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 +386,7 @@ defined key-value pairs are:bridge-id
xs-network-uuids
.xs-network-uuids
disable-in-band
true
, disable in-band control on
+ true
, disable in-band control on
the bridge regardless of controller and manager settings.hwaddr
in-band-queue
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.
+A port that has more than one interface is a ``bonded port.'' Bonding + allows for load balancing and fail-over. Some kinds of bonding will + work with any kind of upstream switch:
+ +balance-slb
active-backup
+ The following mode requires the upstream switch to support 802.3ad with
+ successful LACP negotiation. If LACP negotiation fails then
+ balance-slb
mode is used as a fallback:
+
balance-tcp
These columns apply only to bonded ports. Their values are otherwise ignored.
+The type of bonding used for a bonded port. Defaults to
+ balance-slb
if unset.
+
For a bonded port, the number of milliseconds for which carrier must stay up on an interface before the interface is considered to be up. @@ -478,13 +559,25 @@ name of the port. Use only for compatibility with legacy software that requires this.
Configures LACP on this port. LACP allows directly connected
+ switches to negotiate which links may be bonded. LACP may be enabled
+ on non-bonded ports for the benefit of any switches they may be
+ connected to. active
ports are allowed to initiate LACP
+ negotiations. passive
ports are allowed to participate
+ in LACP negotiations initiated by a remote switch, but not allowed to
+ initiate such negotiations themselves. If unset Open vSwitch will
+ choose a reasonable default.
xx:xx:xx:xx:xx:xx
.bond-rebalance-interval
bond-detect-mode
carrier
and miimon
. Defaults
+ to carrier
which uses each interface's carrier to detect
+ failures. When set to miimon
, will check for failures
+ by polling each interface's MII. bond-miimon-interval
miimon
to detect failures. lacp-system-priority
lacp-time
fast
and
+ slow
. By default slow
is used. When
+ configured to be fast
more frequent LACP heartbeats
+ will be requested causing connectivity problems to be detected more
+ quickly.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
false
to disable. If IPsec is enabled through the
- parameters, header caching will be
- automatically disabled.
+ false
to disable.
+ ipsec_gre
gre
) must be uniquely identified by the
+ combination of remote_ip
and
+ local_ip
. 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.
+ An authentication method of peer_cert
or
+ psk
must be defined. The following options may
+ be specified in the column:
+ remote_ip
local_ip
peer_cert
certificate
option.certificate
private_key
certificate
. If certificate
+ contains the private key, this option may be omitted.psk
in_key
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
flow
. If
+ flow
is specified then the key may be set using
+ the set_tunnel
Nicira OpenFlow vendor extension (0
+ is used in the absence of an action). The ovs-ofctl manual
+ page contains additional information about the Nicira OpenFlow
+ vendor extensions. Default is no key.key
in_key
and
+ out_key
at the same time.tos
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
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
true
to enable.pmtud
false
to disable.capwap
remote_ip
and
local_ip
. If two ports are defined that are the same
except one includes local_ip
and the other does not,
@@ -791,18 +1019,97 @@
Configuration options whose interpretation varies based on
.
+
+
+ + Status information about interfaces attached to bridges, updated every + 5 seconds. Not all interfaces have all of these properties; virtual + interfaces don't have a link speed, for example. Non-applicable + columns will have empty values. +
++ The administrative state of the physical network link. +
++ The observed state of the physical network link. This is ordinarily + the link's carrier status. If the interface's is + a bond configured for miimon monitoring, it is instead the network + link's miimon status. +
++ The negotiated speed of the physical network link. + Valid values are positive integers greater than 0. +
++ The duplex mode of the physical network link. +
++ The MTU (maximum transmission unit); i.e. the largest + amount of data that can fit into a single Ethernet frame. + The standard Ethernet MTU is 1500 bytes. Some physical media + and many kinds of virtual interfaces can be configured with + higher MTUs. +
++ This column will be empty for an interface that does not + have an MTU as, for example, some kinds of tunnels do not. +
+
Key-value pairs that report port status. Supported status
- values are type
-dependent.
+ values are type
-dependent; some interfaces may not have
+ a valid driver_name
, for example.
The only currently defined key-value pair is:
+The currently defined key-value pairs are:
+driver_name
driver_version
firmware_version
source_ip
gre
or capwap
. Not
- supported by all implementations.gre
or capwap
.
+ tunnel_egress_iface
remote_ip
.
+ This could be an internal interface such as a bridge port.MAC
field in the VIF record for this interface.
iface-id
xs-vif-uuid
.@@ -925,23 +1237,13 @@
openvswitch-ipsec
package for
- Debian. The currently defined key-value pairs are:
+ Key-value pairs for rarely used interface features.
ipsec_local_ip
gre
and the
- ipsec_psk
key must
- be set. The in_key
, out_key
, and
- key
must not be
- set.ipsec_psk
ipsec_local_ip
key must also be set.lacp-port-priority
linux-htb
are:
min-rate
max-rate
linux-hfsc
are:
min-rate
max-rate