X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=b74c55c8c7bea197cca76b13d36d82980befb687;hb=43675e260ccc26f8278fd751436af125a18bee38;hp=b3f00752a52c9f4e5bf4dc66ced7a15290ee8f8b;hpb=8159b984dced44851670bd48e204b4e854941a24;p=sliver-openvswitch.git diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index b3f00752a..b74c55c8c 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.

+ can be reached directly or indirectly from the table. Records that are not reachable from + the table are automatically deleted + from the database, except for records in a few distinguished + ``root set'' tables noted below. +

- Configuration for an Open vSwitch daemon. There must be exactly one record - in the table. + Configuration for an Open vSwitch daemon. There must be exactly + one record in the table. @@ -197,21 +202,21 @@

- 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. + 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 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 @@ -232,26 +237,26 @@

- 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. -

+ 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. -

- - + The version of the system identified by , + e.g. 5.6.100-39265p on XenServer 5.6.100 build 39265. +

+

+ System integrators are responsible for choosing and setting an + appropriate value for this column. +

+ + @@ -273,21 +278,6 @@ 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. -

-
@@ -507,17 +497,48 @@ -

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
+
+ Balances flows among slaves based on source MAC address and output + VLAN, with periodic rebalancing as traffic patterns change. +
+ +
active-backup
+
+ Assigns all flows to one slave, failing over to a backup slave when + the active slave is disabled. +
+
+ +

+ 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
+
+ Balances flows among slaves based on L2, L3, and L4 protocol + information such as destination MAC address, IP address, and TCP + port. +
+

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 +559,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.

+ + @@ -583,12 +616,34 @@
An Ethernet address in the form xx:xx:xx:xx:xx:xx.
bond-rebalance-interval
-
For a bonded port, the number of milliseconds between +
For an SLB bonded port, the number of milliseconds between successive attempts to rebalance the bond, that is, to move source MACs and their flows from one interface on the bond to another in an attempt to keep usage of each interface roughly equal. The default is 10000 (10 seconds), and the minimum is 1000 (1 second).
+
bond-detect-mode
+
Sets the method used to detect link failures in a bonded port. + Options are 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
+
The number of milliseconds between successive attempts to + poll each interface's MII. Only relevant on ports which use + miimon to detect failures.
+
lacp-system-priority
+
The LACP system priority of this . In + LACP negotiations, link status decisions are made by the system + with the numerically lower priority. Must be a number between 1 + and 65535.
+
lacp-time
+
The LACP timing which should be used on this + . Possible values are 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.
 @@ -755,9 +810,122 @@ 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. + false to disable. + + +
ipsec_gre
+
An Ethernet over RFC 2890 Generic Routing Encapsulation + over IPv4 IPsec tunnel. Each tunnel (including those of type + 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
+
Required. The tunnel endpoint.
+
+
+
local_ip
+
Optional. The destination IP that received packets must + match. Default is to match all addresses.
+
+
+
peer_cert
+
Required for certificate authentication. A string + containing the peer's certificate in PEM format. + Additionally the host's certificate must be specified + with the certificate option.
+
+
+
certificate
+
Required for certificate authentication. The name of a + PEM file containing a certificate that will be presented + to the peer during authentication.
+
+
+
private_key
+
Optional for certificate authentication. The name of + a PEM file containing the private key associated with + certificate. If certificate + contains the private key, this option may be omitted.
+
+
+
psk
+
Required for pre-shared key authentication. Specifies a + pre-shared key for authentication that must be identical on + both sides of the tunnel.
+
+
+
in_key
+
Optional. The GRE key that received packets must contain. + It may either be a 32-bit number (no key and a key of 0 are + treated as equivalent) or the word 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
+
Optional. The GRE key to be set on outgoing packets. It may + either be a 32-bit number or the word 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
+
Optional. Shorthand to set in_key and + out_key at the same time.
+
+
+
tos
+
Optional. The value of the ToS bits to be set on the + encapsulating packet. It may also be the word + 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
+
Optional. The TTL to be set on the encapsulating packet. + It may also be the word 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
+
Optional. Compute GRE checksums on outgoing packets. + Checksums present on incoming packets will be validated + regardless of this setting. Note that GRE checksums + impose a significant performance penalty as they cover the + entire packet. As the contents of the packet is typically + covered by L3 and L4 checksums, this additional checksum only + adds value for the GRE and encapsulated Ethernet headers. + Default is disabled, set to true to enable.
+
+
+
pmtud
+
Optional. Enable tunnel path MTU discovery. If enabled + ``ICMP destination unreachable - fragmentation'' needed + messages will be generated for IPv4 packets with the DF bit set + and IPv6 packets above the minimum MTU if the packet size + exceeds the path MTU minus the size of the tunnel headers. It + also forces the encapsulating packet DF bit to be set (it is + always set if the inner packet implies path MTU discovery). + Note that this option causes behavior that is typically + reserved for routers and therefore is not entirely in + compliance with the IEEE 802.1D specification for bridges. + Default is enabled, set to false to disable.
capwap
@@ -766,7 +934,7 @@ where GRE is not available. Note that only the tunneling component of the protocol is implemented. Due to the non-standard use of CAPWAP, UDP ports 58881 and 58882 are used as the source and - destinations ports respectivedly. Each tunnel must be uniquely + destination ports respectively. Each tunnel must be uniquely identified by the combination of remote_ip and local_ip. If two ports are defined that are the same except one includes local_ip and the other does not, @@ -851,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
+
The name of the device driver controlling the network + adapter.
+
+
+
driver_version
+
The version string of the device driver controlling the + network adapter.
+
+
+
firmware_version
+
The version string of the network adapter's firmware, if + available.
+
source_ip
The source IP address used for an IPv4 tunnel end-point, - such as gre or capwap. Not - supported by all implementations.
+ such as gre or capwap. +
+
+
tunnel_egress_iface
+
Egress interface for tunnels. Currently only relevant for GRE + and CAPWAP tunnels. On Linux systems, this column will show + the name of the interface which is responsible for routing + traffic destined for the configured remote_ip. + This could be an internal interface such as a bridge port.
+
+
+
tunnel_egress_iface_carrier
+
Whether a carrier is detected on . Valid values are down + and up.
 @@ -990,23 +1237,13 @@ - Key-value pairs for rarely used interface features. Currently, - the only keys are for configuring GRE-over-IPsec, which is only - available through the openvswitch-ipsec package for - Debian. The currently defined key-value pairs are: + Key-value pairs for rarely used interface features.
-
ipsec_local_ip
-
Required key for GRE-over-IPsec interfaces. Additionally, - the must be gre and the - ipsec_psk key must - be set. The in_key, out_key, and - key must not be - set.
-
ipsec_psk
-
Required key for GRE-over-IPsec interfaces. Specifies a - 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.
+
lacp-port-priority
+
The LACP port priority of this . In + LACP negotiations s with numerically lower + priorities are preferred for aggregation. Must be a number between + 1 and 65535.
 @@ -1156,7 +1393,7 @@ column="type"/> of linux-htb are:

min-rate
-
Minimum guaranteed bandwidth, in bit/s. Required.
+
Minimum guaranteed bandwidth, in bit/s.
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 @@ -1179,7 +1416,7 @@ column="type"/> of linux-hfsc are:

min-rate
-
Minimum guaranteed bandwidth, in bit/s. Required.
+
Minimum guaranteed bandwidth, in bit/s.
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 @@ -1245,22 +1482,6 @@ - - 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. @@ -1464,23 +1685,6 @@
The specified TCP port (default: 6633) on the host at the given ip, which must be expressed as an IP address (not a DNS name).
-
discover
-
-

Enables controller discovery.

-

In controller discovery mode, Open vSwitch broadcasts a DHCP - request with vendor class identifier OpenFlow across - all of the bridge's network devices. It will accept any valid - DHCP reply that has the same vendor class identifier and includes - a vendor-specific option with code 1 whose contents are a string - specifying the location of the controller in the same format as - .

-

The DHCP reply may also, optionally, include a vendor-specific - option with code 2 whose contents are a string specifying the URI - to the base of the OpenFlow PKI - (e.g. http://192.168.0.1/openflow/pki). This URI is - used only for bootstrapping the OpenFlow PKI at initial switch - setup; ovs-vswitchd does not use it at all.

-

The following connection methods are currently supported for service @@ -1540,10 +1744,7 @@

-

If not specified, the default is implementation-specific. If - is discover, the connection mode - is always treated as in-band regardless of the actual - setting.

+

If not specified, the default is implementation-specific.

@@ -1593,33 +1794,9 @@ - -

These values are considered only when - is discover.

- - - A POSIX - extended regular expression against which the discovered controller - location is validated. The regular expression is implicitly - anchored at the beginning of the controller location string, as - if it begins with ^. If not specified, the default - is implementation-specific. - - - - Whether to update /etc/resolv.conf when the - controller is discovered. If not specified, the default - is implementation-specific. Open vSwitch will only modify - /etc/resolv.conf if the DHCP response that it receives - specifies one or more DNS servers. - - -

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.)

+ ).

When multiple controllers are configured on a single bridge, there should be only one set of unique values in these columns. If different @@ -1656,6 +1833,60 @@ unique. No common key-value pairs are currently defined. + + + + true if currently connected to this controller, + false otherwise. + + + +

The level of authority this controller has on the associated + bridge. Possible values are:

+
+
other
+
Allows the controller access to all OpenFlow features.
+
master
+
Equivalent to other, except that there may be at + most one master controller at a time. When a controller configures + itself as master, any existing master is demoted to + the slaverole.
+
slave
+
Allows the controller read-only access to OpenFlow features. + Attempts to modify the flow table will be rejected with an + error. Slave controllers do not receive OFPT_PACKET_IN or + OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS + messages.
+
+ + + +

Key-value pairs that report controller status.

+
+
last_error
+
A human-readable description of the last error on the connection + to the controller; i.e. strerror(errno). This key + will exist only if an error has occurred.
+
state
+
The state of the connection to the controller. Possible values + are: VOID (connection is disabled), + BACKOFF (attempting to reconnect at an increasing + period), CONNECTING (attempting to connect), + ACTIVE (connected, remote host responsive), and + IDLE (remote host idle, sending keep-alive). These + values may change in the future. They are provided only for human + consumption.
+
sec_since_connect
+
The amount of time since this controller last successfully + connected to the switch (in seconds). Value is empty if controller + has never successfully connected.
+
sec_since_disconnect
+
The amount of time since this controller last disconnected from + the switch (in seconds). Value is empty if controller has never + disconnected.
+
+ + @@ -1795,6 +2026,46 @@ unique. No common key-value pairs are currently defined. + + + + true if currently connected to this manager, + false otherwise. + + + +

Key-value pairs that report manager status.

+
+
last_error
+
A human-readable description of the last error on the connection + to the manager; i.e. strerror(errno). This key + will exist only if an error has occurred.
+
+
+
state
+
The state of the connection to the manager. Possible values + are: VOID (connection is disabled), + BACKOFF (attempting to reconnect at an increasing + period), CONNECTING (attempting to connect), + ACTIVE (connected, remote host responsive), and + IDLE (remote host idle, sending keep-alive). These + values may change in the future. They are provided only for human + consumption.
+
+
+
sec_since_connect
+
The amount of time since this manager last successfully connected + to the database (in seconds). Value is empty if manager has never + successfully connected.
+
+
+
sec_since_disconnect
+
The amount of time since this manager last disconnected from the + database (in seconds). Value is empty if manager has never + disconnected.
+
+ +