X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=5b216a556b7732fe7607d484e5e13658b52a27a5;hb=a11f6164a801c093ef67b144167e55fc9e851626;hp=b3f00752a52c9f4e5bf4dc66ced7a15290ee8f8b;hpb=8159b984dced44851670bd48e204b4e854941a24;p=sliver-openvswitch.git
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index b3f00752a..5b216a556 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.
other-config
- instead.)
+ Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
+ (Setting this column has no useful effect. Set instead.)
bridge-id
xs-network-uuids
.xs-network-uuids
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 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.
+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 modes require the upstream switch to support 802.3ad with
+ successful LACP negotiation. If LACP negotiation fails then
+ balance-slb
style flow hashing is used as a fallback:
+
balance-tcp
stable
Attempts to always assign a given flow to the same slave
+ consistently. In an effort to maintain stability, no load
+ balancing is done. Uses a similar hashing strategy to
+ balance-tcp
, always taking into account L3 and L4
+ fields even if LACP negotiations are unsuccessful.
Slave selection decisions are made based on if set. Otherwise,
+ OpenFlow port number is used. Decisions are consistent across all
+ ovs-vswitchd
instances with equivalent
+
+ values.
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. @@ -538,6 +594,18 @@ 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. bond-hash-basis
lacp-system-id
lacp-system-priority
lacp-time
The LACP timing which should be used on this
+ . Possible values are fast
,
+ slow
and a positive number of milliseconds. By
+ default slow
is used. When configured to be
+ fast
LACP heartbeats are requested at a rate of once
+ per second causing connectivity problems to be detected more
+ quickly. In slow
mode, heartbeats are requested at
+ a rate of once every 30 seconds.
Users may manually set a heartbeat transmission rate to increase
+ the fault detection speed further. When manually set, OVS
+ expects the partner switch to be configured with the same
+ transmission rate. Manually setting lacp-time
to
+ something other than fast
or slow
is
+ not supported by the LACP specification.
lacp-heartbeat
gre
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 following
- options may be specified in the column:
+ tunnel. Each tunnel must be uniquely identified by the
+ combination of ,
+ , and
+ . 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. is considered
+ more specific than if a port
+ defines one and another port defines the other. The following
+ options may be specified in the column:
remote_ip
true
to enable.df_inherit
true
to enable.df_default
df_inherit
option
+ is not set, or if the encapsulated packet is not IP. Default
+ is enabled; set to false
to disable.pmtud
false
to disable.false
to disable.
header_cache
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 and
+ . 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
+ or 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.df_inherit
true
to enable.df_default
df_inherit
option
+ is not set, or if the encapsulated packet is not IP. Default
+ is enabled; set to false
to disable.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,
- the more specific one is matched first. CAPWAP support is not
+ destination ports respectively. Each tunnel must be uniquely
+ identified by the combination of
+ and
+ . If two ports are defined
+ that are the same except one includes
+ and the other does not, the
+ more specific one is matched first. CAPWAP support is not
available on all platforms. Currently it is only supported in the
Linux kernel module with kernel versions >= 2.6.25. The following
options may be specified in the column:
@@ -800,19 +1055,31 @@
(otherwise it will be the system default, typically 64).
Default is the system default TTL.
+ df_inherit
true
to enable.df_default
df_inherit
option
+ is not set, or if the encapsulated packet is not IP. Default
+ is enabled; set to false
to disable.pmtud
false
to disable.false
to disable.
header_cache
null
+ 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.
+ Key-value pairs that report port status. Supported status values are
+ -dependent; some interfaces may not have a valid
+ , 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
+ 802.1ag Connectivity Fault Management (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. +
+ +iface-id
xs-vif-uuid
.Additionally the following key-value pairs specifically @@ -990,23 +1376,35 @@
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.cfm_interval
bond-stable-id
stable
bond mode to
+ make slave selection decisions. Allocating
+ values
+ consistently across interfaces participating in a bond will
+ guarantee consistent slave selection decisions across
+ ovs-vswitchd
instances when using stable
+ bonding mode.lacp-port-id
lacp-port-priority
lacp-aggregation-key
linux-htb
are:
min-rate
max-rate
linux-hfsc
are:
min-rate
max-rate