configuration changes.
</column>
- <column name="capabilities">
- Describes functionality supported by the hardware and software platform
- on which this Open vSwitch is based. Clients should not modify this
- column. See the <ref table="Capability"/> description for defined
- capability categories and the meaning of associated
- <ref table="Capability"/> records.
- </column>
-
<group title="Statistics">
<p>
The <code>statistics</code> column contains key-value pairs that
<column name="ovs_version">
The Open vSwitch version number, e.g. <code>1.1.0</code>.
- If Open vSwitch was configured with a build number, then it is
- also included, e.g. <code>1.1.0+build6579</code>.
</column>
<column name="db_version">
on bridges. Bond, internal, and mirror ports are not supported
and will not participate in the spanning tree.
</column>
-
+
<column name="other_config" key="stp-system-id">
The bridge's STP identifier (the lower 48 bits of the bridge-id)
in the form
numerically lower priority.
</column>
- <column name="other_config" key="lacp-time">
+ <column name="other_config" key="lacp-time"
+ type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
<p>
The LACP timing which should be used on this <ref table="Port"/>.
- Possible values are <code>fast</code>, <code>slow</code> and a
- positive number of milliseconds. By default <code>slow</code> is
- used. When configured to be <code>fast</code> LACP heartbeats are
- requested at a rate of once per second causing connectivity
- problems to be detected more quickly. In <code>slow</code> mode,
- heartbeats are requested at a rate of once every 30 seconds.
- </p>
-
- <p>
- 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 <code>lacp-time</code> to something other
- than <code>fast</code> or <code>slow</code> is not supported by the
- LACP specification.
+ By default <code>slow</code> is used. When configured to be
+ <code>fast</code> LACP heartbeats are requested at a rate of once
+ per second causing connectivity problems to be detected more
+ quickly. In <code>slow</code> mode, heartbeats are requested at a
+ rate of once every 30 seconds.
</p>
</column>
-
- <column name="other_config" key="lacp-heartbeat"
- type='{"type": "boolean"}'>
- Treat LACP like a simple heartbeat protocol for link state
- monitoring. Most features of the LACP protocol are disabled
- when this mode is in use. The default if not specified is
- <code>false</code>.
- </column>
</group>
<group title="SLB Configuration">
<dt><code>ipsec_gre</code></dt>
<dd>
An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
- IPsec tunnel.
+ IPsec tunnel.
</dd>
<dt><code>capwap</code></dt>
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.
</column>
-
+
<column name="options" key="df_inherit" type='{"type": "boolean"}'>
Optional. If enabled, the Don't Fragment bit will be copied from the
inner IP headers (those of the encapsulated traffic) to the outer
Total number of receive errors, greater than or equal to the sum of
the above.
</column>
- </group>
+ </group>
<group title="Statistics: Transmit errors">
<column name="statistics" key="tx_dropped">
Number of packets dropped by TX.
</p>
</column>
+ <column name="cfm_fault_status" key="recv">
+ Indicates a CFM fault was triggered due to a lack of CCMs received on
+ the <ref table="Interface"/>.
+ </column>
+
+ <column name="cfm_fault_status" key="rdi">
+ Indicates a CFM fault was triggered due to the reception of a CCM with
+ the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
+ are not receiving CCMs themselves. This typically indicates a
+ unidirectional connectivity failure.
+ </column>
+
+ <column name="cfm_fault_status" key="maid">
+ Indicates a CFM fault was triggered due to the reception of a CCM with
+ a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
+ with an identification number in addition to the MPID called the MAID.
+ Open vSwitch only supports receiving CCM broadcasts tagged with the
+ MAID it uses internally.
+ </column>
+
+ <column name="cfm_fault_status" key="loopback">
+ Indicates a CFM fault was triggered due to the reception of a CCM
+ advertising the same MPID configured in the <ref column="cfm_mpid"/>
+ column of this <ref table="Interface"/>. This may indicate a loop in
+ the network.
+ </column>
+
+ <column name="cfm_fault_status" key="overflow">
+ Indicates a CFM fault was triggered because the CFM module received
+ CCMs from more remote endpoints than it can keep track of.
+ </column>
+
+ <column name="cfm_fault_status" key="override">
+ Indicates a CFM fault was manually triggered by an administrator using
+ an <code>ovs-appctl</code> command.
+ </column>
+
+ <column name="cfm_fault_status" key="interval">
+ Indicates a CFM fault was triggered due to the reception of a CCM
+ frame having an invalid interval.
+ </column>
+
+ <column name="cfm_fault_status" key="sequence">
+ Indicates a CFM fault was triggered because the CFM module received
+ a CCM frame with a sequence number that it was not expecting.
+ </column>
+
+ <column name="cfm_health">
+ <p>
+ Indicates the health of the interface as a percentage of CCM frames
+ received over 21 <ref column="other_config" key="cfm_interval"/>s.
+ The health of an interface is undefined if it is communicating with
+ more than one <ref column="cfm_remote_mpids"/>. It reduces if
+ healthy heartbeats are not received at the expected rate, and
+ gradually improves as healthy heartbeats are received at the desired
+ rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
+ health of the interface is refreshed.
+ </p>
+ <p>
+ As mentioned above, the faults can be triggered for several reasons.
+ The link health will deteriorate even if heartbeats are received but
+ they are reported to be unhealthy. An unhealthy heartbeat in this
+ context is a heartbeat for which either some fault is set or is out
+ of sequence. The interface health can be 100 only on receiving
+ healthy heartbeats at the desired rate.
+ </p>
+ </column>
+
<column name="cfm_remote_mpids">
When CFM is properly configured, Open vSwitch will occasionally
receive CCM broadcasts. These broadcasts contain the MPID of the
<column name="other_config" key="cfm_interval"
type='{"type": "integer"}'>
- The interval, in milliseconds, between transmissions of CFM heartbeats.
- Three missed heartbeat receptions indicate a connectivity fault.
- Defaults to 1000.
+ <p>
+ The interval, in milliseconds, between transmissions of CFM
+ heartbeats. Three missed heartbeat receptions indicate a
+ connectivity fault.
+ </p>
+
+ <p>
+ In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
+ 60,000, or 600,000 ms are supported. Other values will be rounded
+ down to the nearest value on the list. Extended mode (see <ref
+ column="other_config" key="cfm_extended"/>) supports any interval up
+ to 65,535 ms. In either mode, the default is 1000 ms.
+ </p>
+
+ <p>We do not recommend using intervals less than 100 ms.</p>
</column>
<column name="other_config" key="cfm_extended"
<column name="other_config" key="cfm_ccm_vlan"
type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
When set, the CFM module will apply a VLAN tag to all CCMs it generates
- with the given value.
+ with the given value. May be the string <code>random</code> in which
+ case each CCM will be tagged with a different randomly generated VLAN.
+ </column>
+
+ <column name="other_config" key="cfm_ccm_pcp"
+ type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
+ When set, the CFM module will apply a VLAN tag to all CCMs it generates
+ with the given PCP value. The VLAN ID of the tag is governed by the
+ value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
+ <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
+ zero is used.
</column>
</group>
commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
</column>
+ <column name="external_ids" key="iface-status"
+ type='{"type": "string",
+ "enum": ["set", ["active", "inactive"]]}'>
+ <p>
+ Hypervisors may sometimes have more than one interface associated
+ with a given <ref column="external_ids" key="iface-id"/>, only one of
+ which is actually in use at a given time. For example, in some
+ circumstances XenServer has both a ``tap'' and a ``vif'' interface
+ for a single <ref column="external_ids" key="iface-id"/>, but only
+ uses one of them at a time. A hypervisor that behaves this way must
+ mark the currently in use interface <code>active</code> and the
+ others <code>inactive</code>. A hypervisor that never has more than
+ one interface for a given <ref column="external_ids" key="iface-id"/>
+ may mark that interface <code>active</code> or omit <ref
+ column="external_ids" key="iface-status"/> entirely.
+ </p>
+
+ <p>
+ During VM migration, a given <ref column="external_ids"
+ key="iface-id"/> might transiently be marked <code>active</code> on
+ two different hypervisors. That is, <code>active</code> means that
+ this <ref column="external_ids" key="iface-id"/> is the active
+ instance within a single hypervisor, not in a broader scope.
+ </p>
+ </column>
+
<column name="external_ids" key="xs-vif-uuid">
The virtual interface associated with this interface.
</column>
The virtual network to which this interface is attached.
</column>
+ <column name="external_ids" key="vm-id">
+ The VM to which this interface belongs. On XenServer, this will be the
+ same as <ref column="external_ids" key="xs-vm-uuid"/>.
+ </column>
+
<column name="external_ids" key="xs-vm-uuid">
The VM to which this interface belongs.
</column>
VLAN splinters increase kernel and userspace memory overhead, so do
not use them unless they are needed.
</p>
+
+ <p>
+ VLAN splinters do not support 802.1p priority tags. Received
+ priorities will appear to be 0, regardless of their actual values,
+ and priorities on transmitted packets will also be cleared to 0.
+ </p>
</column>
</group>
references it.</p>
<column name="type">
- <p>The type of QoS to implement. The <ref table="Open_vSwitch"
- column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
- identifies the types that a switch actually supports. The currently
- defined types are listed below:</p>
+ <p>The type of QoS to implement. The currently defined types are
+ listed below:</p>
<dl>
<dt><code>linux-htb</code></dt>
<dd>
supported range of queue numbers depend on <ref column="type"/>. The
queue numbers are the same as the <code>queue_id</code> used in
OpenFlow in <code>struct ofp_action_enqueue</code> and other
- structures. Queue 0 is used by OpenFlow output actions that do not
- specify a specific queue.</p>
+ structures.</p>
+
+ <p>
+ Queue 0 is the ``default queue.'' It is used by OpenFlow output
+ actions when no specific queue has been set. When no configuration for
+ queue 0 is present, it is automatically configured as if a <ref
+ table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
+ and <ref table="Queue" column="other_config"/> columns had been
+ specified.
+ (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
+ this case. With some queuing disciplines, this dropped all packets
+ destined for the default queue.)
+ </p>
</column>
<group title="Configuration for linux-htb and linux-hfsc">
The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
the following key-value pair:
</p>
-
+
<column name="other_config" key="max-rate" type='{"type": "integer"}'>
Maximum rate shared by all queued traffic, in bit/s. Optional. If not
specified, for physical interfaces, the default is the link rate. For
<code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
It has the following key-value pairs defined.
</p>
-
+
<column name="other_config" key="min-rate"
type='{"type": "integer", "minInteger": 1}'>
Minimum guaranteed bandwidth, in bit/s.
<code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
It has the following key-value pairs defined.
</p>
-
+
<column name="other_config" key="min-rate"
type='{"type": "integer", "minInteger": 1}'>
Minimum guaranteed bandwidth, in bit/s.
</column>
-
+
<column name="other_config" key="max-rate"
type='{"type": "integer", "minInteger": 1}'>
Maximum allowed bandwidth, in bit/s. Optional. If specified, the
</column>
</group>
- <group title="OpenFlow Rate Limiting">
+ <group title="Asynchronous Message Configuration">
+ <p>
+ OpenFlow switches send certain messages to controllers spontanenously,
+ that is, not in response to any request from the controller. These
+ messages are called ``asynchronous messages.'' These columns allow
+ asynchronous messages to be limited or disabled to ensure the best use
+ of network resources.
+ </p>
+
+ <column name="enable_async_messages">
+ The OpenFlow protocol enables asynchronous messages at time of
+ connection establishment, which means that a controller can receive
+ asynchronous messages, potentially many of them, even if it turns them
+ off immediately after connecting. Set this column to
+ <code>false</code> to change Open vSwitch behavior to disable, by
+ default, all asynchronous messages. The controller can use the
+ <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
+ on any messages that it does want to receive, if any.
+ </column>
+
<column name="controller_rate_limit">
<p>
The maximum rate at which the switch will forward packets to the
human consumption.
</p>
</column>
-
+
<column name="status" key="sec_since_connect"
type='{"type": "integer", "minInteger": 0}'>
The amount of time since this controller last successfully connected to
the switch (in seconds). Value is empty if controller has never
successfully connected.
</column>
-
+
<column name="status" key="sec_since_disconnect"
type='{"type": "integer", "minInteger": 1}'>
The amount of time since this controller last disconnected from
</column>
</group>
+ <group title="Connection Parameters">
+ <p>
+ Additional configuration for a connection between the controller
+ and the Open vSwitch.
+ </p>
+
+ <column name="other_config" key="dscp"
+ type='{"type": "integer"}'>
+ The Differentiated Service Code Point (DSCP) is specified using 6 bits
+ in the Type of Service (TOS) field in the IP header. DSCP provides a
+ mechanism to classify the network traffic and provide Quality of
+ Service (QoS) on IP networks.
+
+ The DSCP value specified here is used when establishing the connection
+ between the controller and the Open vSwitch. The connection must be
+ reset for the new DSCP values to take effect. If no value is
+ specified, a default value of 48 is chosen. Valid DSCP values must be
+ in the range 0 to 63.
+ </column>
+ </group>
+
+
<group title="Common Columns">
The overall purpose of these columns is described under <code>Common
Columns</code> at the beginning of this document.
<column name="external_ids"/>
+ <column name="other_config"/>
</group>
</table>
</column>
</group>
+ <group title="Connection Parameters">
+ <p>
+ Additional configuration for a connection between the manager
+ and the Open vSwitch Database.
+ </p>
+
+ <column name="other_config" key="dscp"
+ type='{"type": "integer"}'>
+ The Differentiated Service Code Point (DSCP) is specified using 6 bits
+ in the Type of Service (TOS) field in the IP header. DSCP provides a
+ mechanism to classify the network traffic and provide Quality of
+ Service (QoS) on IP networks.
+
+ The DSCP value specified here is used when establishing the connection
+ between the manager and the Open vSwitch. The connection must be
+ reset for the new DSCP values to take effect. If no value is
+ specified, a default value of 48 is chosen. Valid DSCP values must be
+ in the range 0 to 63.
+ </column>
+ </group>
+
<group title="Common Columns">
The overall purpose of these columns is described under <code>Common
Columns</code> at the beginning of this document.
<column name="external_ids"/>
+ <column name="other_config"/>
</group>
</table>
</group>
</table>
- <table name="Capability">
- <p>Records in this table describe functionality supported by the hardware
- and software platform on which this Open vSwitch is based. Clients
- should not modify this table.</p>
-
- <p>A record in this table is meaningful only if it is referenced by the
- <ref table="Open_vSwitch" column="capabilities"/> column in the
- <ref table="Open_vSwitch"/> table. The key used to reference it, called
- the record's ``category,'' determines the meanings of the
- <ref column="details"/> column. The following general forms of
- categories are currently defined:</p>
-
- <dl>
- <dt><code>qos-<var>type</var></code></dt>
- <dd><var>type</var> is supported as the value for
- <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
- </dd>
- </dl>
-
- <column name="details">
- <p>Key-value pairs that describe capabilities. The meaning of the pairs
- depends on the category key that the <ref table="Open_vSwitch"
- column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
- uses to reference this record, as described above.</p>
-
- <p>The presence of a record for category <code>qos-<var>type</var></code>
- indicates that the switch supports <var>type</var> as the value of
- the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
- table. The following key-value pairs are defined to further describe
- QoS capabilities:</p>
-
- <dl>
- <dt><code>n-queues</code></dt>
- <dd>Number of supported queues, as a positive integer. Keys in the
- <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
- records whose <ref table="QoS" column="type"/> value
- equals <var>type</var> must range between 0 and this value minus one,
- inclusive.</dd>
- </dl>
- </column>
- </table>
-
</database>
git://git.onelab.eu / sliver-openvswitch.git / blobdiff