<group title="OpenFlow Configuration">
<column name="controller">
- OpenFlow controller set. If unset, then no OpenFlow controllers
- will be used.
+ <p>
+ OpenFlow controller set. If unset, then no OpenFlow controllers
+ will be used.
+ </p>
+
+ <p>
+ If there are primary controllers, removing all of them clears the
+ flow table. If there are no primary controllers, adding one also
+ clears the flow table. Other changes to the set of controllers, such
+ as adding or removing a service controller, adding another primary
+ controller to supplement an existing primary controller, or removing
+ only one of two primary controllers, have no effect on the flow
+ table.
+ </p>
</column>
<column name="fail_mode">
<p>When more than one controller is configured,
<ref column="fail_mode"/> is considered only when none of the
configured controllers can be contacted.</p>
+ <p>
+ Changing <ref column="fail_mode"/> when no primary controllers are
+ configured clears the flow table.
+ </p>
</column>
<column name="datapath_id">
should be enabled. Default is disabled, set to
<code>true</code> to enable.
</column>
+
+ <column name="other_config" key="mac-aging-time"
+ type='{"type": "integer", "minInteger": 1}'>
+ <p>
+ The maximum number of seconds to retain a MAC learning entry for
+ which no packets have been seen. The default is currently 300
+ seconds (5 minutes). The value, if specified, is forced into a
+ reasonable range, currently 15 to 3600 seconds.
+ </p>
+
+ <p>
+ A short MAC aging time allows a network to more quickly detect that a
+ host is no longer connected to a switch port. However, it also makes
+ it more likely that packets will be flooded unnecessarily, when they
+ are addressed to a connected host that rarely transmits packets. To
+ reduce the incidence of unnecessary flooding, use a MAC aging time
+ longer than the maximum interval at which a host will ordinarily
+ transmit packets.
+ </p>
+ </column>
</group>
<group title="Bridge Status">
</p>
</column>
+ <column name="other_config" key="bond-hash-basis"
+ type='{"type": "integer"}'>
+ An integer hashed along with flows when choosing output slaves in load
+ balanced bonds. When changed, all flows will be assigned different
+ hash values possibly causing slave selection decisions to change. Does
+ not affect bonding modes which do not employ load balancing such as
+ <code>active-backup</code>.
+ </column>
+
<group title="Link Failure Detection">
<p>
An important part of link bonding is detecting that links are down so
when this mode is in use. The default if not specified is
<code>false</code>.
</column>
-
- <column name="other_config" key="bond-hash-basis"
- type='{"type": "integer"}'>
- An integer hashed along with flows when choosing output slaves. When
- changed, all flows will be assigned different hash values possibly
- causing slave selection decisions to change.
- </column>
</group>
<group title="SLB Configuration">
</p>
<ul>
+ <li>
+ The VLAN is the <ref table="Port" column="tag"/> value in any <ref
+ table="Port"/> record.
+ </li>
+
<li>
The VLAN is listed within the <ref table="Port" column="trunks"/>
column of the <ref table="Port"/> record of an interface on which
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>
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. Ordinarily <ref
+ column="queues"/> should include a configuration for queue 0. When no
+ configuration for queue 0 is present, a default configuration is used.
+ (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">
<group title="Configuration for linux-htb QoS">
<p>
- These key-value pairs are defined for <ref table="QoS"/> <ref
- table="QoS" column="type"/> of <code>linux-htb</code>.
+ <ref table="QoS"/> <ref table="QoS" column="type"/>
+ <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"
<group title="Configuration for linux-hfsc QoS">
<p>
- These key-value pairs are defined for <ref table="QoS"/> <ref
- table="QoS" column="type"/> of <code>linux-hfsc</code>.
+ <ref table="QoS"/> <ref table="QoS" column="type"/>
+ <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"
</group>
</table>
- <table name="Mirror" title="Port mirroring (SPAN/RSPAN/ERSPAN).">
+ <table name="Mirror" title="Port mirroring.">
<p>A port mirror within a <ref table="Bridge"/>.</p>
<p>A port mirror configures a bridge to send selected frames to special
``mirrored'' ports, in addition to their normal destinations. Mirroring
- traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
+ traffic may also be referred to as SPAN or RSPAN, depending on how
the mirrored traffic is sent.</p>
<column name="name">
will be discarded.</p>
<p>
The output port may be any kind of port supported by Open vSwitch.
- It may be, for example, a physical port (sometimes called SPAN), or a
- GRE tunnel (sometimes called ERSPAN).
+ It may be, for example, a physical port (sometimes called SPAN) or a
+ GRE tunnel.
</p>
</column>
</column>
</group>
+ <group title="Statistics: Mirror counters">
+ <p>
+ Key-value pairs that report mirror statistics.
+ </p>
+ <column name="statistics" key="tx_packets">
+ Number of packets transmitted through this mirror.
+ </column>
+ <column name="statistics" key="tx_bytes">
+ Number of bytes transmitted through this mirror.
+ </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="agent">
Name of the network device whose IP address should be reported as the
- ``agent address'' to collectors. If not specified, the IP address
+ ``agent address'' to collectors. If not specified, the agent device is
+ figured from the first target address and the routing table. If the
+ routing table does not contain a route to the target, the IP address
defaults to the <ref table="Controller" column="local_ip"/> in the
collector's <ref table="Controller"/>. If an agent IP address cannot be
- determined either way, sFlow is disabled.
+ determined any of these ways, sFlow is disabled.
</column>
<column name="header">