X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=6565b9582e6ab898b5b914ac9e679d6dcb599f73;hb=bffc058934;hp=4cc29da03b7f975bc86c6cf27f0feadacf6e3a17;hpb=e16a28b5854823e2d67099d49f7690235162b555;p=openvswitch diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml index 4cc29da0..6565b958 100644 --- a/vswitchd/vswitch.xml +++ b/vswitchd/vswitch.xml @@ -197,21 +197,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 +232,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.5.0-24648p on XenServer 5.5.0 build 24648. +

+

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

+ + @@ -507,17 +507,25 @@ -

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. Open vSwitch supports + ``source load balancing'' (SLB) and "active backup" bonding. SLB + bonding assigns flows to slaves based on source MAC address and output + VLAN, with periodic rebalancing as traffic patterns change. Active + backup bonding assigns all flows to one slave, failing over to a backup + slave when the active slave is disabled. Neither form of bonding + 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.

+ +

The type of bonding used for a bonded port. Currently supported + values are balance-slb and active-backup. + Defaults to 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. @@ -583,12 +591,22 @@

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.
@@ -759,15 +777,16 @@
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. - The following options may be specified in the - column: +
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.
@@ -778,9 +797,30 @@ match. Default is to match all addresses.
-
ipsec_psk
-
Required. Specifies a pre-shared key for authentication - that must be identical on both sides of the tunnel.
+
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
@@ -942,18 +982,91 @@ 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; + i.e. whether a carrier is detected by the interface. +

+ + + +

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

+

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.
 @@ -1731,6 +1844,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, BACKOFF, + CONNECTING, ACTIVE, and + IDLE.
+
+
+
time_in_state
+
Seconds since connecting to (if currently connected) or + disconnecting from (if currently disconnected) this + controller.
+
+ +