71
71
The Citrix XenServer universally unique identifier for the physical
72
72
host as displayed by <code>xe host-list</code>.
75
<column name="other_config" key="flow-restore-wait"
76
type='{"type": "boolean"}'>
78
When <code>ovs-vswitchd</code> starts up, it has an empty flow table
79
and therefore it handles all arriving packets in its default fashion
80
according to its configuration, by dropping them or sending them to
81
an OpenFlow controller or switching them as a standalone switch.
82
This behavior is ordinarily desirable. However, if
83
<code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
84
then this leads to a relatively long period during which packets are
88
This option allows for improvement. When <code>ovs-vswitchd</code>
89
starts with this value set as <code>true</code>, it will neither
90
flush or expire previously set datapath flows nor will it send and
91
receive any packets to or from the datapath. When this value is
92
later set to <code>false</code>, <code>ovs-vswitchd</code> will
93
start receiving packets from the datapath and re-setup the flows.
96
Thus, with this option, the procedure for a hot-upgrade of
97
<code>ovs-vswitchd</code> becomes roughly the following:
101
Stop <code>ovs-vswitchd</code>.
104
Set <ref column="other_config" key="flow-restore-wait"/>
105
to <code>true</code>.
108
Start <code>ovs-vswitchd</code>.
111
Use <code>ovs-ofctl</code> (or some other program, such as an
112
OpenFlow controller) to restore the OpenFlow flow table
113
to the desired state.
116
Set <ref column="other_config" key="flow-restore-wait"/>
117
to <code>false</code> (or remove it entirely from the database).
121
The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
122
functions use the above config option during hot upgrades.
126
<column name="other_config" key="flow-eviction-threshold"
127
type='{"type": "integer", "minInteger": 0}'>
129
A number of flows as a nonnegative integer. This sets number of
130
flows at which eviction from the datapath flow table will be
131
triggered. If there are a large number of flows then increasing this
132
value to around the number of flows present can result in reduced CPU
133
usage and packet loss.
136
The default is 2500. Values below 100 will be rounded up to 100.
140
<column name="other_config" key="force-miss-model">
142
Specifies userspace behaviour for handling flow misses. This takes
143
precedence over flow-eviction-threshold.
147
<dt><code>auto</code></dt>
148
<dd>Handle automatically based on the flow-eviction-threshold and
149
the flow setup governer (default, recommended).</dd>
150
<dt><code>with-facets</code></dt>
151
<dd>Always create facets. Expensive kernel flow creation and
152
statistics tracking is always performed, even on flows with only
153
a small number of packets.</dd>
154
<dt><code>without-facets</code></dt>
155
<dd>Always handle without facets. Forces flow misses to be handled
156
in userspace. May cause an increase in CPU usage and packet loss
157
on high throughput.</dd>
76
163
<group title="Status">
858
935
information such as destination MAC address, IP address, and TCP
862
<dt><code>stable</code></dt>
864
<p>Deprecated and slated for removal in February 2013.</p>
865
<p>Attempts to always assign a given flow to the same slave
866
consistently. In an effort to maintain stability, no load
867
balancing is done. Uses a similar hashing strategy to
868
<code>balance-tcp</code>, always taking into account L3 and L4
869
fields even if LACP negotiations are unsuccessful. </p>
870
<p>Slave selection decisions are made based on <ref table="Interface"
871
column="other_config" key="bond-stable-id"/> if set. Otherwise,
872
OpenFlow port number is used. Decisions are consistent across all
873
<code>ovs-vswitchd</code> instances with equivalent
874
<ref table="Interface" column="other_config" key="bond-stable-id"/>
879
940
<p>These columns apply only to bonded ports. Their values are
1301
1375
<column name="options" key="remote_ip">
1302
Required. The tunnel endpoint. Only unicast endpoints are supported.
1376
<p>Required. The remote tunnel endpoint, one of:</p>
1380
An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1381
Only unicast endpoints are supported.
1384
The word <code>flow</code>. The tunnel accepts packets from any
1385
remote tunnel endpoint. To process only packets from a specific
1386
remote tunnel endpoint, the flow entries may match on the
1387
<code>tun_src</code> field. When sending packets to a
1388
<code>remote_ip=flow</code> tunnel, the flow actions must
1389
explicitly set the <code>tun_dst</code> field to the IP address of
1390
the desired remote tunnel endpoint, e.g. with a
1391
<code>set_field</code> action.
1396
The remote tunnel endpoint for any packet received from a tunnel
1397
is available in the <code>tun_src</code> field for matching in the
1305
1402
<column name="options" key="local_ip">
1306
Optional. The destination IP that received packets must match.
1307
Default is to match all addresses.
1404
Optional. The tunnel destination IP that received packets must
1405
match. Default is to match all addresses. If specified, may be one
1411
An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1414
The word <code>flow</code>. The tunnel accepts packets sent to any
1415
of the local IP addresses of the system running OVS. To process
1416
only packets sent to a specific IP address, the flow entries may
1417
match on the <code>tun_dst</code> field. When sending packets to a
1418
<code>local_ip=flow</code> tunnel, the flow actions may
1419
explicitly set the <code>tun_src</code> field to the desired IP
1420
address, e.g. with a <code>set_field</code> action. However, while
1421
routing the tunneled packet out, the local system may override the
1422
specified address with the local IP address configured for the
1423
outgoing system interface.
1426
This option is valid only for tunnels also configured with the
1427
<code>remote_ip=flow</code> option.
1433
The tunnel destination IP address for any packet received from a
1434
tunnel is available in the <code>tun_dst</code> field for matching in
1310
1439
<column name="options" key="in_key">
1832
<group title="Bidirectional Forwarding Detection (BFD)">
1834
BFD, defined in RFC 5880 and RFC 5881, allows point to point
1835
detection of connectivity failures by occasional transmission of
1836
BFD control messages. It is implemented in Open vSwitch to serve
1837
as a more popular and standards compliant alternative to CFM.
1841
BFD operates by regularly transmitting BFD control messages at a
1842
rate negotiated independently in each direction. Each endpoint
1843
specifies the rate at which it expects to receive control messages,
1844
and the rate at which it's willing to transmit them. Open vSwitch
1845
uses a detection multiplier of three, meaning that an endpoint
1846
which fails to receive BFD control messages for a period of three
1847
times the expected reception rate, will signal a connectivity
1848
fault. In the case of a unidirectional connectivity issue, the
1849
system not receiving BFD control messages will signal the problem
1850
to its peer in the messages it transmits.
1854
The Open vSwitch implementation of BFD aims to comply faithfully
1855
with the requirements put forth in RFC 5880. Currently, the only
1856
known omission is ``Demand Mode'', which we hope to include in
1857
future. Open vSwitch does not implement the optional
1858
Authentication or ``Echo Mode'' features.
1861
<column name="bfd" key="enable">
1862
When <code>true</code> BFD is enabled on this
1863
<ref table="Interface"/>, otherwise it's disabled. Defaults to
1867
<column name="bfd" key="min_rx"
1868
type='{"type": "integer", "minInteger": 1}'>
1869
The fastest rate, in milliseconds, at which this BFD session is
1870
willing to receive BFD control messages. The actual rate may be
1871
slower if the remote endpoint isn't willing to transmit as quickly as
1872
specified. Defaults to <code>1000</code>.
1875
<column name="bfd" key="min_tx"
1876
type='{"type": "integer", "minInteger": 1}'>
1877
The fastest rate, in milliseconds, at which this BFD session is
1878
willing to transmit BFD control messages. The actual rate may be
1879
slower if the remote endpoint isn't willing to receive as quickly as
1880
specified. Defaults to <code>100</code>.
1883
<column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
1884
Concatenated path down may be used when the local system should not
1885
have traffic forwarded to it for some reason other than a connectivty
1886
failure on the interface being monitored. When a controller thinks
1887
this may be the case, it may set <code>cpath_down</code> to
1888
<code>true</code> which may cause the remote BFD session not to
1889
forward traffic to this <ref table="Interface"/>. Defaults to
1893
<column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
1894
When set to true, Check Tunnel Key will make BFD only accept control
1895
messages with an <code>in_key</code> of zero. Defaults to
1899
<column name="bfd" key="bfd_dst_mac">
1900
An Ethernet address in the form
1901
<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
1902
to set the destination mac address of the bfd packet. If this
1903
field is set, it is assumed that all the bfd packets destined to this
1904
interface also has the same destination mac address. If not set, a
1905
default value of <code>00:23:20:00:00:01</code> is used.
1908
<column name="bfd_status" key="state"
1909
type='{"type": "string",
1910
"enum": ["set", ["admin_down", "down", "init", "up"]]}'>
1911
State of the BFD session. The BFD session is fully healthy and
1912
negotiated if <code>UP</code>.
1915
<column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
1916
True if the BFD session believes this <ref table="Interface"/> may be
1917
used to forward traffic. Typically this means the local session is
1918
signaling <code>UP</code>, and the remote system isn't signaling a
1919
problem such as concatenated path down.
1922
<column name="bfd_status" key="diagnostic">
1923
A short message indicating what the BFD session thinks is wrong in
1927
<column name="bfd_status" key="remote_state"
1928
type='{"type": "string",
1929
"enum": ["set", ["admin_down", "down", "init", "up"]]}'>
1930
State of the remote endpoint's BFD session.
1933
<column name="bfd_status" key="remote_diagnostic">
1934
A short message indicating what the remote endpoint's BFD session
1935
thinks is wrong in case of a problem.
1703
1939
<group title="Connectivity Fault Management">
1705
1941
802.1ag Connectivity Fault Management (CFM) allows a group of
1858
2094
compatibility with 802.1ag compliant implementations. Defaults to
1859
2095
<code>false</code>.
2098
<column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2100
When <code>true</code>, and
2101
<ref column="other_config" key="cfm_extended"/> is true, the CFM
2102
module operates in demand mode. When in demand mode, traffic
2103
received on the <ref table="Interface"/> is used to indicate
2104
liveness. CCMs are still transmitted and received, but if the
2105
<ref table="Interface"/> is receiving traffic, their absence does not
2106
cause a connectivity fault.
2110
Demand mode has a couple of caveats:
2113
To ensure that ovs-vswitchd has enough time to pull statistics
2114
from the datapath, the minimum
2115
<ref column="other_config" key="cfm_interval"/> is 500ms.
2119
To avoid ambiguity, demand mode disables itself when there are
2120
multiple remote maintenance points.
2124
If the <ref table="Interface"/> is heavily congested, CCMs
2125
containing the <ref column="other_config" key="cfm_opstate"/>
2126
status may be dropped causing changes in the operational state to
2127
be delayed. Similarly, if CCMs containing the RDI bit are not
2128
received, unidirectional link failures may not be detected.
1861
2134
<column name="other_config" key="cfm_opstate"
1862
2135
type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1863
2136
When <code>down</code>, the CFM module marks all CCMs it generates as
3455
<table name="IPFIX">
3456
<p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3457
number of details about flows.</p>
3459
<column name="targets">
3460
IPFIX target collectors in the form
3461
<code><var>ip</var>:<var>port</var></code>.
3464
<column name="sampling">
3465
For per-bridge packet sampling, i.e. when this row is referenced
3466
from a <ref table="Bridge"/>, the rate at which packets should
3467
be sampled and sent to each target collector. If not specified,
3468
defaults to 400, which means one out of 400 packets, on average,
3469
will be sent to each target collector. Ignored for per-flow
3470
sampling, i.e. when this row is referenced from a <ref
3471
table="Flow_Sample_Collector_Set"/>.
3474
<column name="obs_domain_id">
3475
For per-bridge packet sampling, i.e. when this row is referenced
3476
from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3477
sent in each IPFIX packet. If not specified, defaults to 0.
3478
Ignored for per-flow sampling, i.e. when this row is referenced
3479
from a <ref table="Flow_Sample_Collector_Set"/>.
3482
<column name="obs_point_id">
3483
For per-bridge packet sampling, i.e. when this row is referenced
3484
from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3485
sent in each IPFIX flow record. If not specified, defaults to
3486
0. Ignored for per-flow sampling, i.e. when this row is
3487
referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3490
<group title="Common Columns">
3491
The overall purpose of these columns is described under <code>Common
3492
Columns</code> at the beginning of this document.
3494
<column name="external_ids"/>
3498
<table name="Flow_Sample_Collector_Set">
3499
<p>A set of IPFIX collectors of packet samples generated by
3500
OpenFlow <code>sample</code> actions.</p>
3503
The ID of this collector set, unique among the bridge's
3504
collector sets, to be used as the <code>collector_set_id</code>
3505
in OpenFlow <code>sample</code> actions.
3508
<column name="bridge">
3509
The bridge into which OpenFlow <code>sample</code> actions can
3510
be added to send packet samples to this set of IPFIX collectors.
3513
<column name="ipfix">
3514
Configuration of the set of IPFIX collectors to send one flow
3515
record per sampled packet to.
3518
<group title="Common Columns">
3519
The overall purpose of these columns is described under <code>Common
3520
Columns</code> at the beginning of this document.
3522
<column name="external_ids"/>
added
removed
vswitchd/vswitch.xml
