<p>Attempts to always assign a given flow to the same slave
consistently. In an effort to maintain stability, no load
balancing is done. Uses a similar hashing strategy to
- <code>balance-tcp</code>, falling back to <code>balance-slb</code>
- style hashing when LACP negotiations are unsuccessful.</p>
- <p>Slave selection decisions are made based on LACP port ID when LACP
- negotiations are successful, falling back to openflow port number
- when unsuccessful. Thus, decisions are consistent across all
- ovs-vswitchd instances with equivalent port IDs.</p>
+ <code>balance-tcp</code>, always taking into account L3 and L4
+ fields even if LACP negotiations are unsuccessful. </p>
+ <p>Slave selection decisions are made based on
+ <code>bond-stable-id</code> if set. Otherwise, OpenFlow port
+ number is used. Decisions are consistent across all ovs-vswitchd
+ instances with equivalent <code>bond-stable-id</code>s.</p>
</dd>
</dl>
<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>
+ <dt><code>bond-hash-basis</code></dt>
+ <dd> 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.</dd>
+ <dt><code>lacp-system-id</code></dt>
+ <dd> The LACP system ID of this <ref table="Port"/>. The system ID
+ of a LACP bond is used to identify itself to its partners. Must
+ be a nonzero MAC address.</dd>
<dt><code>lacp-system-priority</code></dt>
<dd> The LACP system priority of this <ref table="Port"/>. In
LACP negotiations, link status decisions are made by the system
with the numerically lower priority. Must be a number between 1
and 65535.</dd>
<dt><code>lacp-time</code></dt>
- <dd> The LACP timing which should be used on this
- <ref table="Port"/>. Possible values are <code>fast</code> and
- <code>slow</code>. By default <code>slow</code> is used. When
- configured to be <code>fast</code> more frequent LACP heartbeats
- will be requested causing connectivity problems to be detected more
- quickly.</dd>
+ <dd>
+ <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.</p>
+ </dd>
+ <dt><code>lacp-heartbeat</code></dt>
+ <dd> Treats LACP like a simple heartbeat protocol for link state
+ monitoring. Most features of the LACP protocol are disabled when
+ this mode is in use.</dd>
</dl>
</column>
</group>
adds value for the GRE and encapsulated Ethernet headers.
Default is disabled, set to <code>true</code> to enable.</dd>
</dl>
+ <dl>
+ <dt><code>df_inherit</code></dt>
+ <dd>Optional. If enabled, the Don't Fragment bit will be copied
+ from the inner IP headers (those of the encapsulated traffic)
+ to the outer (tunnel) headers. Default is disabled; set to
+ <code>true</code> to enable.</dd>
+ </dl>
+ <dl>
+ <dt><code>df_default</code></dt>
+ <dd>Optional. If enabled, the Don't Fragment bit will be set by
+ default on tunnel headers if the <code>df_inherit</code> option
+ is not set, or if the encapsulated packet is not IP. Default
+ is enabled; set to <code>false</code> to disable.</dd>
+ </dl>
<dl>
<dt><code>pmtud</code></dt>
<dd>Optional. Enable tunnel path MTU discovery. If enabled
- ``ICMP destination unreachable - fragmentation'' needed
+ ``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).
+ exceeds the path MTU minus the size of the tunnel headers.
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 <code>false</code> to disable.</dd>
+ Default is enabled; set to <code>false</code> to disable.</dd>
</dl>
<dl>
<dt><code>header_cache</code></dt>
adds value for the GRE and encapsulated Ethernet headers.
Default is disabled, set to <code>true</code> to enable.</dd>
</dl>
+ <dl>
+ <dt><code>df_inherit</code></dt>
+ <dd>Optional. If enabled, the Don't Fragment bit will be copied
+ from the inner IP headers (those of the encapsulated traffic)
+ to the outer (tunnel) headers. Default is disabled; set to
+ <code>true</code> to enable.</dd>
+ </dl>
+ <dl>
+ <dt><code>df_default</code></dt>
+ <dd>Optional. If enabled, the Don't Fragment bit will be set by
+ default on tunnel headers if the <code>df_inherit</code> option
+ is not set, or if the encapsulated packet is not IP. Default
+ is enabled; set to <code>false</code> to disable.</dd>
+ </dl>
<dl>
<dt><code>pmtud</code></dt>
<dd>Optional. Enable tunnel path MTU discovery. If enabled
- ``ICMP destination unreachable - fragmentation'' needed
+ ``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).
+ exceeds the path MTU minus the size of the tunnel headers.
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 <code>false</code> to disable.</dd>
+ Default is enabled; set to <code>false</code> to disable.</dd>
</dl>
</dd>
<dt><code>capwap</code></dt>
(otherwise it will be the system default, typically 64).
Default is the system default TTL.</dd>
</dl>
+ <dl>
+ <dt><code>df_inherit</code></dt>
+ <dd>Optional. If enabled, the Don't Fragment bit will be copied
+ from the inner IP headers (those of the encapsulated traffic)
+ to the outer (tunnel) headers. Default is disabled; set to
+ <code>true</code> to enable.</dd>
+ </dl>
+ <dl>
+ <dt><code>df_default</code></dt>
+ <dd>Optional. If enabled, the Don't Fragment bit will be set by
+ default on tunnel headers if the <code>df_inherit</code> option
+ is not set, or if the encapsulated packet is not IP. Default
+ is enabled; set to <code>false</code> to disable.</dd>
+ </dl>
<dl>
<dt><code>pmtud</code></dt>
<dd>Optional. Enable tunnel path MTU discovery. If enabled
- ``ICMP destination unreachable - fragmentation'' needed
+ ``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).
+ exceeds the path MTU minus the size of the tunnel headers.
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 <code>false</code> to disable.</dd>
+ Default is enabled; set to <code>false</code> to disable.</dd>
</dl>
<dl>
<dt><code>header_cache</code></dt>
</dd>
</dl>
</dd>
+ <dt><code>null</code></dt>
+ <dd>An ignored interface.</dd>
</dl>
</column>
</column>
</group>
- <group title="Other Features">
+ <group title="Connectivity Fault Management">
+ <p>
+ 802.1ag Connectivity Fault Management (CFM) allows a group of
+ Maintenance Points (MPs) called a Maintenance Association (MA) to
+ detect connectivity problems with each other. MPs within a MA should
+ have complete and exclusive interconnectivity. This is verified by
+ occasionally broadcasting Continuity Check Messages (CCMs) at a
+ configurable transmission interval.
+ </p>
+
+ <column name="cfm_mpid">
+ A Maintenance Point ID (MPID) uniquely identifies each endpoint within
+ a Maintenance Association. The MPID is used to identify this endpoint
+ to other Maintenance Points in the MA. Each end of a link being
+ monitored should have a different MPID. Must be configured to enable
+ CFM on this <ref table="Interface"/>.
+ </column>
+
+ <column name="cfm_remote_mpid">
+ The MPID of the remote endpoint being monitored. If this
+ <ref table="Interface"/> does not have connectivity to an endpoint
+ advertising the configured MPID, a fault is signalled. Must be
+ configured to enable CFM on this <ref table="Interface"/>
+ </column>
- <column name="monitor">
- Connectivity monitor configuration for this interface.
+ <column name="cfm_fault">
+ Indicates a connectivity fault triggered by an inability to receive
+ heartbeats from the remote endpoint. When a fault is triggered on
+ <ref table="Interface"/>s participating in bonds, they will be
+ disabled.
</column>
+ </group>
+
+ <group title="Other Features">
<column name="lacp_current">
Boolean value indicating LACP status for this interface. If true, this
<column name="other_config">
Key-value pairs for rarely used interface features.
<dl>
+ <dt><code>cfm_interval</code></dt>
+ <dd> The transmission interval of CFM heartbeats in milliseconds.
+ Three missed heartbeat receptions indicate a connectivity fault.
+ Defaults to 1000ms. </dd>
+ <dt><code>bond-stable-id</code></dt>
+ <dd> A positive integer using in <code>stable</code> bond mode to
+ make slave selection decisions. Allocating
+ <code>bond-stable-id</code>s consistently across interfaces
+ participating in a bond will guarantee consistent slave selection
+ decisions across ovs-vswitchd instances when using
+ <code>stable</code> bonding mode.</dd>
+ <dt><code>lacp-port-id</code></dt>
+ <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are
+ used in LACP negotiations to identify individual ports
+ participating in a bond. Must be a number between 1 and
+ 65535.</dd>
<dt><code>lacp-port-priority</code></dt>
<dd> The LACP port priority of this <ref table="Interface"/>. In
LACP negotiations <ref table="Interface"/>s with numerically lower
priorities are preferred for aggregation. Must be a number between
1 and 65535.</dd>
+ <dt><code>lacp-aggregation-key</code></dt>
+ <dd> The LACP aggregation key of this <ref table="Interface"/>.
+ <ref table="Interface"/>s with different aggregation keys may not
+ be active within a given <ref table="Port"/> at the same time. Must
+ be a number between 1 and 65535.</dd>
</dl>
</column>
</column>
</table>
- <table name="Monitor" title="Connectivity Monitor configuration">
- <p>
- A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
- implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
- group of Maintenance Points (MPs) called a Maintenance Association (MA)
- to detect connectivity problems with each other. MPs within a MA should
- have complete and exclusive interconnectivity. This is verified by
- occasionally broadcasting Continuity Check Messages (CCMs) at a
- configurable transmission interval. A <ref table="Monitor"/> is
- responsible for collecting data about other MPs in its MA and
- broadcasting CCMs.
- </p>
-
- <group title="Monitor Configuration">
- <column name="mpid">
- A Maintenance Point ID (MPID) uniquely identifies each endpoint within
- a Maintenance Association (see <ref column="ma_name"/>). The MPID is
- used to identify this <ref table="Monitor"/> to other endpoints in the
- MA.
- </column>
-
- <column name="remote_mps">
- A set of <ref table="Maintenance_Points"/> which this
- <ref table="Monitor"/> should have connectivity to. If this
- <ref table="Monitor"/> does not have connectivity to any MPs in this
- set, or has connectivity to any MPs not in this set, a fault is
- signaled.
- </column>
-
- <column name="ma_name">
- A Maintenance Association (MA) name pairs with a Maintenance Domain
- (MD) name to uniquely identify a MA. A MA is a group of endpoints who
- have complete and exclusive interconnectivity. Defaults to
- <code>ovs</code> if unset.
- </column>
-
- <column name="md_name">
- A Maintenance Domain name pairs with a Maintenance Association name to
- uniquely identify a MA. Defaults to <code>ovs</code> if unset.
- </column>
-
- <column name="interval">
- The transmission interval of CCMs in milliseconds. Three missed CCMs
- indicate a connectivity fault. Defaults to 1000ms.
- </column>
- </group>
-
- <group title="Monitor Status">
- <column name="fault">
- Indicates a Connectivity Fault caused by a configuration error, a down
- remote MP, or unexpected connectivity to a remote MAID or remote MP.
- </column>
- </group>
- </table>
-
- <table name="Maintenance_Point" title="Maintenance Point configuration">
- <p>
- A <ref table="Maintenance_Point"/> represents a MP which a
- <ref table="Monitor"/> has or should have connectivity to.
- </p>
-
- <group title="Maintenance_Point Configuration">
- <column name="mpid">
- A Maintenance Point ID (MPID) uniquely identifies each endpoint within
- a Maintenance Association. All MPs within a MA should have a unique
- MPID.
- </column>
- </group>
-
- <group title="Maintenance_Point Status">
- <column name="fault">
- Indicates a connectivity fault.
- </column>
- </group>
- </table>
-
<table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
<p>A port mirror within a <ref table="Bridge"/>.</p>
<p>A port mirror configures a bridge to send selected frames to special
projects / openvswitch / blobdiff