</group>
<group title="Bonding Configuration">
- <p>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.</p>
+ <p>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.</p>
<p>These columns apply only to bonded ports. Their values are
otherwise ignored.</p>
+ <column name="bond_mode">
+ <p>The type of bonding used for a bonded port. Currently supported
+ values are <code>balance-slb</code> and <code>active-backup</code>.
+ Defaults to SLB if unset.</p>
+ </column>
+
<column name="bond_updelay">
<p>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.
<dd>An Ethernet address in the form
<code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
<dt><code>bond-rebalance-interval</code></dt>
- <dd>For a bonded port, the number of milliseconds between
+ <dd>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).</dd>
+ <dt><code>bond-detect-mode</code></dt>
+ <dd> Sets the method used to detect link failures in a bonded port.
+ Options are <code>carrier</code> and <code>miimon</code>. Defaults
+ to <code>carrier</code> which uses each interface's carrier to detect
+ failures. When set to <code>miimon</code>, will check for failures
+ by polling each interface's MII. </dd>
+ <dt><code>bond-miimon-interval</code></dt>
+ <dd> The number of milliseconds between successive attempts to
+ poll each interface's MII. Only relevant on ports which use
+ <code>miimon</code> to detect failures. </dd>
</dl>
</column>
</group>
Configuration options whose interpretation varies based on
<ref column="type"/>.
</column>
+ </group>
+
+ <group title="Interface Status">
+ <p>
+ 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.
+ </p>
+ <column name="admin_state">
+ <p>
+ The administrative state of the physical network link.
+ </p>
+ </column>
+
+ <column name="link_state">
+ <p>
+ The observed state of the physical network link;
+ i.e. whether a carrier is detected by the interface.
+ </p>
+ </column>
+
+ <column name="link_speed">
+ <p>
+ The negotiated speed of the physical network link.
+ Valid values are positive integers greater than 0.
+ </p>
+ </column>
+
+ <column name="duplex">
+ <p>
+ The duplex mode of the physical network link.
+ </p>
+ </column>
+
+ <column name="mtu">
+ <p>
+ 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.
+ </p>
+ </column>
<column name="status">
<p>
Key-value pairs that report port status. Supported status
- values are <code>type</code>-dependent.
+ values are <code>type</code>-dependent; some interfaces may not have
+ a valid <code>driver_name</code>, for example.
</p>
- <p>The only currently defined key-value pair is:</p>
+ <p>The currently defined key-value pairs are:</p>
+ <dl>
+ <dt><code>driver_name</code></dt>
+ <dd>The name of the device driver controlling the network
+ adapter.</dd>
+ </dl>
+ <dl>
+ <dt><code>driver_version</code></dt>
+ <dd>The version string of the device driver controlling the
+ network adapter.</dd>
+ </dl>
+ <dl>
+ <dt><code>firmware_version</code></dt>
+ <dd>The version string of the network adapter's firmware, if
+ available.</dd>
+ </dl>
<dl>
<dt><code>source_ip</code></dt>
<dd>The source IP address used for an IPv4 tunnel end-point,
- such as <code>gre</code> or <code>capwap</code>. Not
- supported by all implementations.</dd>
+ such as <code>gre</code> or <code>capwap</code>.</dd>
+ </dl>
+ <dl>
+ <dt><code>tunnel_egress_iface</code></dt>
+ <dd>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 <code>remote_ip</code>.
+ This could be an internal interface such as a bridge port.</dd>
+ </dl>
+ <dl>
+ <dt><code>tunnel_egress_iface_carrier</code></dt>
+ <dd>Whether a carrier is detected on <ref
+ column="tunnel_egress_iface"/>. Valid values are <code>down</code>
+ and <code>up</code>.</dd>
</dl>
</column>
</group>
</dl>
</column>
- <column name="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 <code>remote_ip</code>. This could be an internal interface
- such as a bridge port.
- </column>
-
<column name="other_config">
Key-value pairs for rarely used interface features. Currently,
there are none defined.
unique. No common key-value pairs are currently defined.
</column>
</group>
+
+ <group title="Controller Status">
+ <column name="is_connected">
+ <code>true</code> if currently connected to this controller,
+ <code>false</code> otherwise.
+ </column>
+
+ <column name="role">
+ <p>The level of authority this controller has on the associated
+ bridge. Possible values are:</p>
+ <dl>
+ <dt><code>other</code></dt>
+ <dd>Allows the controller access to all OpenFlow features.</dd>
+ </dl>
+ <dl>
+ <dt><code>master</code></dt>
+ <dd>Equivalent to <code>other</code>, except that there may be at
+ most one master controller at a time. When a controller configures
+ itself as <code>master</code>, any existing master is demoted to
+ the <code>slave</code>role.</dd>
+ </dl>
+ <dl>
+ <dt><code>slave</code></dt>
+ <dd>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.</dd>
+ </dl>
+ </column>
+
+ <column name="status">
+ <p>Key-value pairs that report controller status.</p>
+ <dl>
+ <dt><code>last_error</code></dt>
+ <dd>A human-readable description of the last error on the connection
+ to the controller; i.e. <code>strerror(errno)</code>. This key
+ will exist only if an error has occurred.</dd>
+ </dl>
+ <dl>
+ <dt><code>state</code></dt>
+ <dd>The state of the connection to the controller. Possible values
+ are: <code>VOID</code>, <code>BACKOFF</code>,
+ <code>CONNECTING</code>, <code>ACTIVE</code>, and
+ <code>IDLE</code>.</dd>
+ </dl>
+ <dl>
+ <dt><code>time_in_state</code></dt>
+ <dd>Seconds since connecting to (if currently connected) or
+ disconnecting from (if currently disconnected) this
+ controller.</dd>
+ </dl>
+ </column>
+ </group>
</table>
<table name="Manager" title="OVSDB management connection.">
git://git.onelab.eu / sliver-openvswitch.git / blobdiff