1 <?xml version=
"1.0" encoding=
"utf-8"?>
2 <database name=
"ovs-vswitchd.conf.db" title=
"Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table=
"Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the
<ref
9 table=
"Open_vSwitch"/> table. Records that are not reachable from
10 the
<ref table=
"Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns
</h2>
18 Most tables contain two special columns, named
<code>other_config
</code>
19 and
<code>external_ids
</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config
</code>: map of string-string pairs
</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have
<code>other_config
</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids
</code>: map of string-string pairs
</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name=
"Open_vSwitch" title=
"Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the
<ref table=
"Open_vSwitch"/> table.
54 <group title=
"Configuration">
55 <column name=
"bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name=
"external_ids" key=
"system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column=
"external_ids" key=
"xs-system-uuid"/>.
70 <column name=
"external_ids" key=
"xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by
<code>xe host-list
</code>.
75 <column name=
"external_ids" key=
"hostname">
76 The hostname for the host running Open vSwitch. This is a fully
77 qualified domain name since version
2.6.2.
80 <column name=
"external_ids" key=
"rundir">
81 In Open vSwitch
2.8 and later, the run directory of the running Open
82 vSwitch daemon. This directory is used for runtime state such as
83 control and management sockets. The value of
<ref
84 column=
"other_config" key=
"vhost-sock-dir"/> is relative to this
88 <column name=
"other_config" key=
"stats-update-interval"
89 type='{
"type":
"integer",
"minInteger":
5000}'
>
91 Interval for updating statistics to the database, in milliseconds.
92 This option will affect the update of the
<code>statistics
</code>
93 column in the following tables:
<code>Port
</code>,
<code>Interface
94 </code>,
<code>Mirror
</code>.
97 Default value is
5000 ms.
100 Getting statistics more frequently can be achieved via OpenFlow.
104 <column name=
"other_config" key=
"flow-restore-wait"
105 type='{
"type":
"boolean"}'
>
107 When
<code>ovs-vswitchd
</code> starts up, it has an empty flow table
108 and therefore it handles all arriving packets in its default fashion
109 according to its configuration, by dropping them or sending them to
110 an OpenFlow controller or switching them as a standalone switch.
111 This behavior is ordinarily desirable. However, if
112 <code>ovs-vswitchd
</code> is restarting as part of a ``hot-upgrade,''
113 then this leads to a relatively long period during which packets are
117 This option allows for improvement. When
<code>ovs-vswitchd
</code>
118 starts with this value set as
<code>true
</code>, it will neither
119 flush or expire previously set datapath flows nor will it send and
120 receive any packets to or from the datapath. When this value is
121 later set to
<code>false
</code>,
<code>ovs-vswitchd
</code> will
122 start receiving packets from the datapath and re-setup the flows.
125 Thus, with this option, the procedure for a hot-upgrade of
126 <code>ovs-vswitchd
</code> becomes roughly the following:
130 Stop
<code>ovs-vswitchd
</code>.
133 Set
<ref column=
"other_config" key=
"flow-restore-wait"/>
134 to
<code>true
</code>.
137 Start
<code>ovs-vswitchd
</code>.
140 Use
<code>ovs-ofctl
</code> (or some other program, such as an
141 OpenFlow controller) to restore the OpenFlow flow table
142 to the desired state.
145 Set
<ref column=
"other_config" key=
"flow-restore-wait"/>
146 to
<code>false
</code> (or remove it entirely from the database).
150 The
<code>ovs-ctl
</code>'s ``restart'' and ``force-reload-kmod''
151 functions use the above config option during hot upgrades.
155 <column name=
"other_config" key=
"flow-limit"
156 type='{
"type":
"integer",
"minInteger":
0}'
>
159 number of flows allowed in the datapath flow table. Internally OVS
160 will choose a flow limit which will likely be lower than this number,
161 based on real time network conditions. Tweaking this value is
162 discouraged unless you know exactly what you're doing.
165 The default is
200000.
169 <column name=
"other_config" key=
"max-idle"
170 type='{
"type":
"integer",
"minInteger":
500}'
>
172 The maximum time (in ms) that idle flows will remain cached in the
173 datapath. Internally OVS will check the validity and activity for
174 datapath flows regularly and may expire flows quicker than this
175 number, based on real time network conditions. Tweaking this
176 value is discouraged unless you know exactly what you're doing.
179 The default is
10000.
183 <column name=
"other_config" key=
"hw-offload"
184 type='{
"type":
"boolean"}'
>
186 Set this value to
<code>true
</code> to enable netdev flow offload.
189 The default value is
<code>false
</code>. Changing this value requires
190 restarting the daemon
193 Currently Open vSwitch supports hardware offloading on
194 Linux systems. On other systems, this value is ignored.
195 This functionality is considered 'experimental'. Depending
196 on which OpenFlow matches and actions are configured,
197 which kernel version is used, and what hardware is
198 available, Open vSwitch may not be able to offload
199 functionality to hardware.
203 <column name=
"other_config" key=
"tc-policy"
204 type='{
"type":
"string"}'
>
206 Specified the policy used with HW offloading.
208 <code>none
</code> - Add software rule and offload rule to HW.
209 <code>skip_sw
</code> - Offload rule to HW only.
210 <code>skip_hw
</code> - Add software rule without offloading rule to HW.
213 This is only relevant if HW offloading is enabled (hw-offload).
216 The default value is
<code>none
</code>.
220 <column name=
"other_config" key=
"dpdk-init"
221 type='{
"type":
"boolean"}'
>
223 Set this value to
<code>true
</code> to enable runtime support for
224 DPDK ports. The vswitch must have compile-time support for DPDK as
228 The default value is
<code>false
</code>. Changing this value requires
229 restarting the daemon
232 If this value is
<code>false
</code> at startup, any dpdk ports which
233 are configured in the bridge will fail due to memory errors.
237 <column name=
"other_config" key=
"dpdk-lcore-mask"
238 type='{
"type":
"integer",
"minInteger":
1}'
>
240 Specifies the CPU cores where dpdk lcore threads should be spawned.
241 The DPDK lcore threads are used for DPDK library tasks, such as
242 library internal message processing, logging, etc. Value should be in
243 the form of a hex string (so '
0x123') similar to the 'taskset' mask
247 The lowest order bit corresponds to the first CPU core. A set bit
248 means the corresponding core is available and an lcore thread will be
249 created and pinned to it. If the input does not cover all cores,
250 those uncovered cores are considered not set.
253 For performance reasons, it is best to set this to a single core on
254 the system, rather than allow lcore threads to float.
257 If not specified, the value will be determined by choosing the lowest
258 CPU core from initial cpu affinity list. Otherwise, the value will be
259 passed directly to the DPDK library.
263 <column name=
"other_config" key=
"pmd-cpu-mask">
265 Specifies CPU mask for setting the cpu affinity of PMD (Poll
266 Mode Driver) threads. Value should be in the form of hex string,
267 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
271 The lowest order bit corresponds to the first CPU core. A set bit
272 means the corresponding core is available and a pmd thread will be
273 created and pinned to it. If the input does not cover all cores,
274 those uncovered cores are considered not set.
277 If not specified, one pmd thread will be created for each numa node
278 and pinned to any available core on the numa node by default.
282 <column name=
"other_config" key=
"dpdk-alloc-mem"
283 type='{
"type":
"integer",
"minInteger":
0}'
>
285 Specifies the amount of memory to preallocate from the hugepage pool,
286 regardless of socket. It is recommended that dpdk-socket-mem is used
291 <column name=
"other_config" key=
"dpdk-socket-mem"
292 type='{
"type":
"string"}'
>
294 Specifies the amount of memory to preallocate from the hugepage pool,
295 on a per-socket basis.
298 The specifier is a comma-separated string, in ascending order of CPU
299 socket. E.g. On a four socket system
1024,
0,
2048 would set socket
0
300 to preallocate
1024MB, socket
1 to preallocate
0MB, socket
2 to
301 preallocate
2048MB and socket
3 (no value given) to preallocate
0MB.
304 If dpdk-socket-mem and dpdk-alloc-mem are not specified, dpdk-socket-mem
305 will be used and the default value is
1024,
0. If dpdk-socket-mem and
306 dpdk-alloc-mem are specified at same time, dpdk-socket-mem will be
307 used as default. Changing this value requires restarting the daemon.
311 <column name=
"other_config" key=
"dpdk-hugepage-dir"
312 type='{
"type":
"string"}'
>
314 Specifies the path to the hugetlbfs mount point.
317 If not specified, this will be guessed by the DPDK library (default
318 is /dev/hugepages). Changing this value requires restarting the
323 <column name=
"other_config" key=
"dpdk-extra"
324 type='{
"type":
"string"}'
>
326 Specifies additional eal command line arguments for DPDK.
329 The default is empty. Changing this value requires restarting the
334 <column name=
"other_config" key=
"vhost-sock-dir"
335 type='{
"type":
"string"}'
>
337 Specifies a relative path from
<ref column=
"external_ids"
338 key=
"rundir"/> to the vhost-user unix domain socket files. If this
339 value is unset, the sockets are put directly in
<ref
340 column=
"external_ids" key=
"rundir"/>.
343 Changing this value requires restarting the daemon.
347 <column name=
"other_config" key=
"n-handler-threads"
348 type='{
"type":
"integer",
"minInteger":
1}'
>
350 Specifies the number of threads for software datapaths to use for
351 handling new flows. The default the number of online CPU cores minus
352 the number of revalidators.
355 This configuration is per datapath. If you have more than one
356 software datapath (e.g. some
<code>system
</code> bridges and some
357 <code>netdev
</code> bridges), then the total number of threads is
358 <code>n-handler-threads
</code> times the number of software
363 <column name=
"other_config" key=
"n-revalidator-threads"
364 type='{
"type":
"integer",
"minInteger":
1}'
>
366 Specifies the number of threads for software datapaths to use for
367 revalidating flows in the datapath. Typically, there is a direct
368 correlation between the number of revalidator threads, and the number
369 of flows allowed in the datapath. The default is the number of cpu
370 cores divided by four plus one. If
<code>n-handler-threads
</code> is
371 set, the default changes to the number of cpu cores minus the number
375 This configuration is per datapath. If you have more than one
376 software datapath (e.g. some
<code>system
</code> bridges and some
377 <code>netdev
</code> bridges), then the total number of threads is
378 <code>n-handler-threads
</code> times the number of software
383 <column name=
"other_config" key=
"emc-insert-inv-prob"
384 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
386 Specifies the inverse probability (
1/emc-insert-inv-prob) of a flow
387 being inserted into the Exact Match Cache (EMC). On average one in
388 every
<code>emc-insert-inv-prob
</code> packets that generate a unique
389 flow will cause an insertion into the EMC.
391 A value of
1 will result in an insertion for every flow (
1/
1 =
100%)
392 whereas a value of zero will result in no insertions and essentially
396 Defaults to
100 ie. there is (
1/
100 =)
1% chance of EMC insertion.
400 <column name=
"other_config" key=
"vlan-limit"
401 type='{
"type":
"integer",
"minInteger":
0}'
>
403 Limits the number of VLAN headers that can be matched to the
404 specified number. Further VLAN headers will be treated as payload,
405 e.g. a packet with more
802.1q headers will match Ethernet type
409 Value
<code>0</code> means unlimited. The actual number of supported
410 VLAN headers is the smallest of
<code>vlan-limit
</code>, the number
411 of VLANs supported by Open vSwitch userspace (currently
2), and the
412 number supported by the datapath.
416 If this value is absent, the default is currently
1. This maintains
417 backward compatibility with controllers that were designed for use
418 with Open vSwitch versions earlier than
2.8, which only supported one
424 <group title=
"Status">
425 <column name=
"next_cfg">
426 Sequence number for client to increment. When a client modifies
427 any part of the database configuration and wishes to wait for
428 Open vSwitch to finish applying the changes, it may increment
429 this sequence number.
432 <column name=
"cur_cfg">
433 Sequence number that Open vSwitch sets to the current value of
434 <ref column=
"next_cfg"/> after it finishes applying a set of
435 configuration changes.
438 <group title=
"Statistics">
440 The
<code>statistics
</code> column contains key-value pairs that
441 report statistics about a system running an Open vSwitch. These are
442 updated periodically (currently, every
5 seconds). Key-value pairs
443 that cannot be determined or that do not apply to a platform are
447 <column name=
"other_config" key=
"enable-statistics"
448 type='{
"type":
"boolean"}'
>
449 Statistics are disabled by default to avoid overhead in the common
450 case when statistics gathering is not useful. Set this value to
451 <code>true
</code> to enable populating the
<ref column=
"statistics"/>
452 column or to
<code>false
</code> to explicitly disable it.
455 <column name=
"statistics" key=
"cpu"
456 type='{
"type":
"integer",
"minInteger":
1}'
>
458 Number of CPU processors, threads, or cores currently online and
459 available to the operating system on which Open vSwitch is running,
460 as an integer. This may be less than the number installed, if some
461 are not online or if they are not available to the operating
465 Open vSwitch userspace processes are not multithreaded, but the
466 Linux kernel-based datapath is.
470 <column name=
"statistics" key=
"load_average">
471 A comma-separated list of three floating-point numbers,
472 representing the system load average over the last
1,
5, and
15
473 minutes, respectively.
476 <column name=
"statistics" key=
"memory">
478 A comma-separated list of integers, each of which represents a
479 quantity of memory in kilobytes that describes the operating
480 system on which Open vSwitch is running. In respective order,
485 <li>Total amount of RAM allocated to the OS.
</li>
486 <li>RAM allocated to the OS that is in use.
</li>
487 <li>RAM that can be flushed out to disk or otherwise discarded
488 if that space is needed for another purpose. This number is
489 necessarily less than or equal to the previous value.
</li>
490 <li>Total disk space allocated for swap.
</li>
491 <li>Swap space currently in use.
</li>
495 On Linux, all five values can be determined and are included. On
496 other operating systems, only the first two values can be
497 determined, so the list will only have two values.
501 <column name=
"statistics" key=
"process_NAME">
503 One such key-value pair, with
<code>NAME
</code> replaced by
504 a process name, will exist for each running Open vSwitch
505 daemon process, with
<var>name
</var> replaced by the
506 daemon's name (e.g.
<code>process_ovs-vswitchd
</code>). The
507 value is a comma-separated list of integers. The integers
508 represent the following, with memory measured in kilobytes
509 and durations in milliseconds:
513 <li>The process's virtual memory size.
</li>
514 <li>The process's resident set size.
</li>
515 <li>The amount of user and system CPU time consumed by the
517 <li>The number of times that the process has crashed and been
518 automatically restarted by the monitor.
</li>
519 <li>The duration since the process was started.
</li>
520 <li>The duration for which the process has been running.
</li>
524 The interpretation of some of these values depends on whether the
525 process was started with the
<option>--monitor
</option>. If it
526 was not, then the crash count will always be
0 and the two
527 durations will always be the same. If
<option>--monitor
</option>
528 was given, then the crash count may be positive; if it is, the
529 latter duration is the amount of time since the most recent crash
534 There will be one key-value pair for each file in Open vSwitch's
535 ``run directory'' (usually
<code>/var/run/openvswitch
</code>)
536 whose name ends in
<code>.pid
</code>, whose contents are a
537 process ID, and which is locked by a running process. The
538 <var>name
</var> is taken from the pidfile's name.
542 Currently Open vSwitch is only able to obtain all of the above
543 detail on Linux systems. On other systems, the same key-value
544 pairs will be present but the values will always be the empty
549 <column name=
"statistics" key=
"file_systems">
551 A space-separated list of information on local, writable file
552 systems. Each item in the list describes one file system and
553 consists in turn of a comma-separated list of the following:
557 <li>Mount point, e.g.
<code>/
</code> or
<code>/var/log
</code>.
558 Any spaces or commas in the mount point are replaced by
560 <li>Total size, in kilobytes, as an integer.
</li>
561 <li>Amount of storage in use, in kilobytes, as an integer.
</li>
565 This key-value pair is omitted if there are no local, writable
566 file systems or if Open vSwitch cannot obtain the needed
573 <group title=
"Version Reporting">
575 These columns report the types and versions of the hardware and
576 software running Open vSwitch. We recommend in general that software
577 should test whether specific features are supported instead of relying
578 on version number checks. These values are primarily intended for
579 reporting to human administrators.
582 <column name=
"ovs_version">
583 The Open vSwitch version number, e.g.
<code>1.1.0</code>.
586 <column name=
"db_version">
588 The database schema version number, e.g.
<code>1.2.3</code>. See
589 ovsdb-tool(
1) for an explanation of the numbering scheme.
593 The schema version is part of the database schema, so it can also be
594 retrieved by fetching the schema using the Open vSwitch database
599 <column name=
"system_type">
601 An identifier for the type of system on top of which Open vSwitch
602 runs, e.g.
<code>XenServer
</code> or
<code>KVM
</code>.
605 System integrators are responsible for choosing and setting an
606 appropriate value for this column.
610 <column name=
"system_version">
612 The version of the system identified by
<ref column=
"system_type"/>,
613 e.g.
<code>5.6.100-
39265p
</code> on XenServer
5.6.100 build
39265.
616 System integrators are responsible for choosing and setting an
617 appropriate value for this column.
623 <group title=
"Capabilities">
625 These columns report capabilities of the Open vSwitch instance.
627 <column name=
"datapath_types">
629 This column reports the different dpifs registered with the system.
630 These are the values that this instance supports in the
<ref
631 column=
"datapath_type" table=
"Bridge"/> column of the
<ref
632 table=
"Bridge"/> table.
635 <column name=
"iface_types">
637 This column reports the different netdevs registered with the system.
638 These are the values that this instance supports in the
<ref
639 column=
"type" table=
"Interface"/> column of the
<ref
640 table=
"Interface"/> table.
645 <group title=
"Database Configuration">
647 These columns primarily configure the Open vSwitch database
648 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
649 (
<code>ovs-vswitchd
</code>). The OVSDB database also uses the
<ref
650 column=
"ssl"/> settings.
654 The Open vSwitch switch does read the database configuration to
655 determine remote IP addresses to which in-band control should apply.
658 <column name=
"manager_options">
659 Database clients to which the Open vSwitch database server should
660 connect or to which it should listen, along with options for how these
661 connection should be configured. See the
<ref table=
"Manager"/> table
662 for more information.
666 <group title=
"Common Columns">
667 The overall purpose of these columns is described under
<code>Common
668 Columns
</code> at the beginning of this document.
670 <column name=
"other_config"/>
671 <column name=
"external_ids"/>
675 <table name=
"Bridge">
677 Configuration for a bridge within an
678 <ref table=
"Open_vSwitch"/>.
681 A
<ref table=
"Bridge"/> record represents an Ethernet switch with one or
682 more ``ports,'' which are the
<ref table=
"Port"/> records pointed to by
683 the
<ref table=
"Bridge"/>'s
<ref column=
"ports"/> column.
686 <group title=
"Core Features">
689 Bridge identifier. Must be unique among the names of ports,
690 interfaces, and bridges on a host.
694 The name must be alphanumeric and must not contain forward or
695 backward slashes. The name of a bridge is also the name of an
<ref
696 table=
"Interface"/> (and a
<ref table=
"Port"/>) within the bridge, so
697 the restrictions on the
<ref table=
"Interface" column=
"name"/> column
698 in the
<ref table=
"Interface"/> table, particularly on length, also
699 apply to bridge names. Refer to the documentation for
<ref
700 table=
"Interface"/> names for details.
704 <column name=
"ports">
705 Ports included in the bridge.
708 <column name=
"mirrors">
709 Port mirroring configuration.
712 <column name=
"netflow">
713 NetFlow configuration.
716 <column name=
"sflow">
717 sFlow(R) configuration.
720 <column name=
"ipfix">
724 <column name=
"flood_vlans">
726 VLAN IDs of VLANs on which MAC address learning should be disabled,
727 so that packets are flooded instead of being sent to specific ports
728 that are believed to contain packets' destination MACs. This should
729 ordinarily be used to disable MAC learning on VLANs used for
730 mirroring (RSPAN VLANs). It may also be useful for debugging.
733 SLB bonding (see the
<ref table=
"Port" column=
"bond_mode"/> column in
734 the
<ref table=
"Port"/> table) is incompatible with
735 <code>flood_vlans
</code>. Consider using another bonding mode or
736 a different type of mirror instead.
740 <column name=
"auto_attach">
741 Auto Attach configuration.
745 <group title=
"OpenFlow Configuration">
746 <column name=
"controller">
748 OpenFlow controller set. If unset, then no OpenFlow controllers
753 If there are primary controllers, removing all of them clears the
754 flow table. If there are no primary controllers, adding one also
755 clears the flow table. Other changes to the set of controllers, such
756 as adding or removing a service controller, adding another primary
757 controller to supplement an existing primary controller, or removing
758 only one of two primary controllers, have no effect on the flow
763 <column name=
"flow_tables">
764 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
765 table ID to configuration for that table.
768 <column name=
"fail_mode">
769 <p>When a controller is configured, it is, ordinarily, responsible
770 for setting up all flows on the switch. Thus, if the connection to
771 the controller fails, no new network connections can be set up.
772 If the connection to the controller stays down long enough,
773 no packets can pass through the switch at all. This setting
774 determines the switch's response to such a situation. It may be set
775 to one of the following:
777 <dt><code>standalone
</code></dt>
778 <dd>If no message is received from the controller for three
779 times the inactivity probe interval
780 (see
<ref column=
"inactivity_probe"/>), then Open vSwitch
781 will take over responsibility for setting up flows. In
782 this mode, Open vSwitch causes the bridge to act like an
783 ordinary MAC-learning switch. Open vSwitch will continue
784 to retry connecting to the controller in the background
785 and, when the connection succeeds, it will discontinue its
786 standalone behavior.
</dd>
787 <dt><code>secure
</code></dt>
788 <dd>Open vSwitch will not set up flows on its own when the
789 controller connection fails or when no controllers are
790 defined. The bridge will continue to retry connecting to
791 any defined controllers forever.
</dd>
795 The default is
<code>standalone
</code> if the value is unset, but
796 future versions of Open vSwitch may change the default.
799 The
<code>standalone
</code> mode can create forwarding loops on a
800 bridge that has more than one uplink port unless STP is enabled. To
801 avoid loops on such a bridge, configure
<code>secure
</code> mode or
802 enable STP (see
<ref column=
"stp_enable"/>).
804 <p>When more than one controller is configured,
805 <ref column=
"fail_mode"/> is considered only when none of the
806 configured controllers can be contacted.
</p>
808 Changing
<ref column=
"fail_mode"/> when no primary controllers are
809 configured clears the flow table.
813 <column name=
"datapath_id">
814 Reports the OpenFlow datapath ID in use. Exactly
16 hex digits.
815 (Setting this column has no useful effect. Set
<ref
816 column=
"other-config" key=
"datapath-id"/> instead.)
819 <column name=
"datapath_version">
821 Reports the version number of the Open vSwitch datapath in use.
822 This allows management software to detect and report discrepancies
823 between Open vSwitch userspace and datapath versions. (The
<ref
824 column=
"ovs_version" table=
"Open_vSwitch"/> column in the
<ref
825 table=
"Open_vSwitch"/> reports the Open vSwitch userspace version.)
826 The version reported depends on the datapath in use:
831 When the kernel module included in the Open vSwitch source tree is
832 used, this column reports the Open vSwitch version from which the
837 When the kernel module that is part of the upstream Linux kernel is
838 used, this column reports
<code><unknown
></code>.
842 When the datapath is built into the
<code>ovs-vswitchd
</code>
843 binary, this column reports
<code><built-in
></code>. A
844 built-in datapath is by definition the same version as the rest of
845 the Open VSwitch userspace.
849 Other datapaths (such as the Hyper-V kernel datapath) currently
850 report
<code><unknown
></code>.
855 A version discrepancy between
<code>ovs-vswitchd
</code> and the
856 datapath in use is not normally cause for alarm. The Open vSwitch
857 kernel datapaths for Linux and Hyper-V, in particular, are designed
858 for maximum inter-version compatibility: any userspace version works
859 with with any kernel version. Some reasons do exist to insist on
860 particular user/kernel pairings. First, newer kernel versions add
861 new features, that can only be used by new-enough userspace, e.g.
862 VXLAN tunneling requires certain minimal userspace and kernel
863 versions. Second, as an extension to the first reason, some newer
864 kernel versions add new features for enhancing performance that only
865 new-enough userspace versions can take advantage of.
869 <column name=
"other_config" key=
"datapath-id">
870 Exactly
16 hex digits to set the OpenFlow datapath ID to a specific
871 value. May not be all-zero.
874 <column name=
"other_config" key=
"dp-desc">
875 Human readable description of datapath. It it a maximum
256
876 byte-long free-form string to describe the datapath for
877 debugging purposes, e.g.
<code>switch3 in room
3120</code>.
880 <column name=
"other_config" key=
"disable-in-band"
881 type='{
"type":
"boolean"}'
>
882 If set to
<code>true
</code>, disable in-band control on the bridge
883 regardless of controller and manager settings.
886 <column name=
"other_config" key=
"in-band-queue"
887 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
888 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
889 that will be used by flows set up by in-band control on this bridge.
890 If unset, or if the port used by an in-band control flow does not have
891 QoS configured, or if the port does not have a queue with the specified
892 ID, the default queue is used instead.
895 <column name=
"protocols">
897 List of OpenFlow protocols that may be used when negotiating
898 a connection with a controller. OpenFlow
1.0,
1.1,
1.2,
1.3, and
899 1.4 are enabled by default if this column is empty.
903 OpenFlow
1.5 and
1.6 are not enabled by default because their
904 implementations are missing features. In addition, the OpenFlow
1.6
905 specification is still under development and thus subject to change.
910 <group title=
"Spanning Tree Configuration">
912 The IEEE
802.1D Spanning Tree Protocol (STP) is a network protocol
913 that ensures loop-free topologies. It allows redundant links to
914 be included in the network to provide automatic backup paths if
915 the active links fails.
919 These settings configure the slower-to-converge but still widely
920 supported version of Spanning Tree Protocol, sometimes known as
921 802.1D-
1998. Open vSwitch also supports the newer Rapid Spanning Tree
922 Protocol (RSTP), documented later in the section titled
<code>Rapid
923 Spanning Tree Configuration
</code>.
926 <group title=
"STP Configuration">
927 <column name=
"stp_enable" type='{
"type":
"boolean"}'
>
929 Enable spanning tree on the bridge. By default, STP is disabled
930 on bridges. Bond, internal, and mirror ports are not supported
931 and will not participate in the spanning tree.
935 STP and RSTP are mutually exclusive. If both are enabled, RSTP
940 <column name=
"other_config" key=
"stp-system-id">
941 The bridge's STP identifier (the lower
48 bits of the bridge-id)
943 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
944 By default, the identifier is the MAC address of the bridge.
947 <column name=
"other_config" key=
"stp-priority"
948 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
949 The bridge's relative priority value for determining the root
950 bridge (the upper
16 bits of the bridge-id). A bridge with the
951 lowest bridge-id is elected the root. By default, the priority
955 <column name=
"other_config" key=
"stp-hello-time"
956 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
957 The interval between transmissions of hello messages by
958 designated ports, in seconds. By default the hello interval is
962 <column name=
"other_config" key=
"stp-max-age"
963 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
964 The maximum age of the information transmitted by the bridge
965 when it is the root bridge, in seconds. By default, the maximum
969 <column name=
"other_config" key=
"stp-forward-delay"
970 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
971 The delay to wait between transitioning root and designated
972 ports to
<code>forwarding
</code>, in seconds. By default, the
973 forwarding delay is
15 seconds.
976 <column name=
"other_config" key=
"mcast-snooping-aging-time"
977 type='{
"type":
"integer",
"minInteger":
1}'
>
979 The maximum number of seconds to retain a multicast snooping entry for
980 which no packets have been seen. The default is currently
300
981 seconds (
5 minutes). The value, if specified, is forced into a
982 reasonable range, currently
15 to
3600 seconds.
986 <column name=
"other_config" key=
"mcast-snooping-table-size"
987 type='{
"type":
"integer",
"minInteger":
1}'
>
989 The maximum number of multicast snooping addresses to learn. The
990 default is currently
2048. The value, if specified, is forced into
991 a reasonable range, currently
10 to
1,
000,
000.
994 <column name=
"other_config" key=
"mcast-snooping-disable-flood-unregistered"
995 type='{
"type":
"boolean"}'
>
997 If set to
<code>false
</code>, unregistered multicast packets are forwarded
999 If set to
<code>true
</code>, unregistered multicast packets are forwarded
1000 to ports connected to multicast routers.
1005 <group title=
"STP Status">
1007 These key-value pairs report the status of
802.1D-
1998. They are
1008 present only if STP is enabled (via the
<ref column=
"stp_enable"/>
1011 <column name=
"status" key=
"stp_bridge_id">
1012 The bridge ID used in spanning tree advertisements, in the form
1013 <var>xxxx
</var>.
<var>yyyyyyyyyyyy
</var> where the
<var>x
</var>s are
1014 the STP priority, the
<var>y
</var>s are the STP system ID, and each
1015 <var>x
</var> and
<var>y
</var> is a hex digit.
1017 <column name=
"status" key=
"stp_designated_root">
1018 The designated root for this spanning tree, in the same form as
<ref
1019 column=
"status" key=
"stp_bridge_id"/>. If this bridge is the root,
1020 this will have the same value as
<ref column=
"status"
1021 key=
"stp_bridge_id"/>, otherwise it will differ.
1023 <column name=
"status" key=
"stp_root_path_cost">
1024 The path cost of reaching the designated bridge. A lower number is
1025 better. The value is
0 if this bridge is the root, otherwise it is
1031 <group title=
"Rapid Spanning Tree">
1033 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
1034 that ensures loop-free topologies. RSTP superseded STP with the
1035 publication of
802.1D-
2004. Compared to STP, RSTP converges more
1036 quickly and recovers more quickly from failures.
1039 <group title=
"RSTP Configuration">
1040 <column name=
"rstp_enable" type='{
"type":
"boolean"}'
>
1042 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
1043 on bridges. Bond, internal, and mirror ports are not supported
1044 and will not participate in the spanning tree.
1048 STP and RSTP are mutually exclusive. If both are enabled, RSTP
1053 <column name=
"other_config" key=
"rstp-address">
1054 The bridge's RSTP address (the lower
48 bits of the bridge-id)
1056 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
1057 By default, the address is the MAC address of the bridge.
1060 <column name=
"other_config" key=
"rstp-priority"
1061 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
61440}'
>
1062 The bridge's relative priority value for determining the root
1063 bridge (the upper
16 bits of the bridge-id). A bridge with the
1064 lowest bridge-id is elected the root. By default, the priority
1065 is
0x8000 (
32768). This value needs to be a multiple of
4096,
1066 otherwise it's rounded to the nearest inferior one.
1069 <column name=
"other_config" key=
"rstp-ageing-time"
1070 type='{
"type":
"integer",
"minInteger":
10,
"maxInteger":
1000000}'
>
1071 The Ageing Time parameter for the Bridge. The default value
1075 <column name=
"other_config" key=
"rstp-force-protocol-version"
1076 type='{
"type":
"integer"}'
>
1077 The Force Protocol Version parameter for the Bridge. This
1078 can take the value
0 (STP Compatibility mode) or
2
1079 (the default, normal operation).
1082 <column name=
"other_config" key=
"rstp-max-age"
1083 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
1084 The maximum age of the information transmitted by the Bridge
1085 when it is the Root Bridge. The default value is
20.
1088 <column name=
"other_config" key=
"rstp-forward-delay"
1089 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
1090 The delay used by STP Bridges to transition Root and Designated
1091 Ports to Forwarding. The default value is
15.
1094 <column name=
"other_config" key=
"rstp-transmit-hold-count"
1095 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
1096 The Transmit Hold Count used by the Port Transmit state machine
1097 to limit transmission rate. The default value is
6.
1101 <group title=
"RSTP Status">
1103 These key-value pairs report the status of
802.1D-
2004. They are
1104 present only if RSTP is enabled (via the
<ref column=
"rstp_enable"/>
1107 <column name=
"rstp_status" key=
"rstp_bridge_id">
1108 The bridge ID used in rapid spanning tree advertisements, in the form
1109 <var>x
</var>.
<var>yyy
</var>.
<var>zzzzzzzzzzzz
</var> where
1110 <var>x
</var> is the RSTP priority, the
<var>y
</var>s are a locally
1111 assigned system ID extension, the
<var>z
</var>s are the STP system
1112 ID, and each
<var>x
</var>,
<var>y
</var>, or
<var>z
</var> is a hex
1115 <column name=
"rstp_status" key=
"rstp_root_id">
1116 The root of this spanning tree, in the same form as
<ref
1117 column=
"rstp_status" key=
"rstp_bridge_id"/>. If this bridge is the
1118 root, this will have the same value as
<ref column=
"rstp_status"
1119 key=
"rstp_bridge_id"/>, otherwise it will differ.
1121 <column name=
"rstp_status" key=
"rstp_root_path_cost"
1122 type='{
"type":
"integer",
"minInteger":
0}'
>
1123 The path cost of reaching the root. A lower number is better. The
1124 value is
0 if this bridge is the root, otherwise it is higher.
1126 <column name=
"rstp_status" key=
"rstp_designated_id">
1127 The RSTP designated ID, in the same form as
<ref column=
"rstp_status"
1128 key=
"rstp_bridge_id"/>.
1130 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1131 The RSTP designated port ID, as a
4-digit hex number.
1133 <column name=
"rstp_status" key=
"rstp_bridge_port_id">
1134 The RSTP bridge port ID, as a
4-digit hex number.
1139 <group title=
"Multicast Snooping Configuration">
1140 Multicast snooping (RFC
4541) monitors the Internet Group Management
1141 Protocol (IGMP) and Multicast Listener Discovery traffic between hosts
1142 and multicast routers. The switch uses what IGMP and MLD snooping
1143 learns to forward multicast traffic only to interfaces that are connected
1144 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
1145 MLDv1 and MLDv2 protocols.
1147 <column name=
"mcast_snooping_enable">
1148 Enable multicast snooping on the bridge. For now, the default
1153 <group title=
"Other Features">
1154 <column name=
"datapath_type">
1155 Name of datapath provider. The kernel datapath has type
1156 <code>system
</code>. The userspace datapath has type
1157 <code>netdev
</code>. A manager may refer to the
<ref
1158 table=
"Open_vSwitch" column=
"datapath_types"/> column of the
<ref
1159 table=
"Open_vSwitch"/> table for a list of the types accepted by this
1160 Open vSwitch instance.
1163 <column name=
"external_ids" key=
"bridge-id">
1164 A unique identifier of the bridge. On Citrix XenServer this will
1165 commonly be the same as
1166 <ref column=
"external_ids" key=
"xs-network-uuids"/>.
1169 <column name=
"external_ids" key=
"xs-network-uuids">
1170 Semicolon-delimited set of universally unique identifier(s) for the
1171 network with which this bridge is associated on a Citrix XenServer
1172 host. The network identifiers are RFC
4122 UUIDs as displayed by,
1173 e.g.,
<code>xe network-list
</code>.
1176 <column name=
"other_config" key=
"hwaddr">
1177 An Ethernet address in the form
1178 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
1179 to set the hardware address of the local port and influence the
1183 <column name=
"other_config" key=
"forward-bpdu"
1184 type='{
"type":
"boolean"}'
>
1187 Controls forwarding of BPDUs and other network control frames when
1188 NORMAL action is invoked. When this option is
<code>false
</code> or
1189 unset, frames with reserved Ethernet addresses (see table below) will
1190 not be forwarded. When this option is
<code>true
</code>, such frames
1191 will not be treated specially.
1195 The above general rule has the following exceptions:
1200 If STP is enabled on the bridge (see the
<ref column=
"stp_enable"
1201 table=
"Bridge"/> column in the
<ref table=
"Bridge"/> table), the
1202 bridge processes all received STP packets and never passes them to
1203 OpenFlow or forwards them. This is true even if STP is disabled on
1208 If LLDP is enabled on an interface (see the
<ref column=
"lldp"
1209 table=
"Interface"/> column in the
<ref table=
"Interface"/> table),
1210 the interface processes received LLDP packets and never passes them
1211 to OpenFlow or forwards them.
1216 Set this option to
<code>true
</code> if the Open vSwitch bridge
1217 connects different Ethernet networks and is not configured to
1222 This option affects packets with the following destination MAC
1227 <dt><code>01:
80:c2:
00:
00:
00</code></dt>
1228 <dd>IEEE
802.1D Spanning Tree Protocol (STP).
</dd>
1230 <dt><code>01:
80:c2:
00:
00:
01</code></dt>
1231 <dd>IEEE Pause frame.
</dd>
1233 <dt><code>01:
80:c2:
00:
00:
0<var>x
</var></code></dt>
1234 <dd>Other reserved protocols.
</dd>
1236 <dt><code>00:e0:
2b:
00:
00:
00</code></dt>
1237 <dd>Extreme Discovery Protocol (EDP).
</dd>
1240 <code>00:e0:
2b:
00:
00:
04</code> and
<code>00:e0:
2b:
00:
00:
06</code>
1242 <dd>Ethernet Automatic Protection Switching (EAPS).
</dd>
1244 <dt><code>01:
00:
0c:cc:cc:cc
</code></dt>
1246 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1247 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1251 <dt><code>01:
00:
0c:cc:cc:cd
</code></dt>
1252 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.
</dd>
1254 <dt><code>01:
00:
0c:cd:cd:cd
</code></dt>
1255 <dd>Cisco STP Uplink Fast.
</dd>
1257 <dt><code>01:
00:
0c:
00:
00:
00</code></dt>
1258 <dd>Cisco Inter Switch Link.
</dd>
1260 <dt><code>01:
00:
0c:cc:cc:c
<var>x
</var></code></dt>
1265 <column name=
"other_config" key=
"mac-aging-time"
1266 type='{
"type":
"integer",
"minInteger":
1}'
>
1268 The maximum number of seconds to retain a MAC learning entry for
1269 which no packets have been seen. The default is currently
300
1270 seconds (
5 minutes). The value, if specified, is forced into a
1271 reasonable range, currently
15 to
3600 seconds.
1275 A short MAC aging time allows a network to more quickly detect that a
1276 host is no longer connected to a switch port. However, it also makes
1277 it more likely that packets will be flooded unnecessarily, when they
1278 are addressed to a connected host that rarely transmits packets. To
1279 reduce the incidence of unnecessary flooding, use a MAC aging time
1280 longer than the maximum interval at which a host will ordinarily
1285 <column name=
"other_config" key=
"mac-table-size"
1286 type='{
"type":
"integer",
"minInteger":
1}'
>
1288 The maximum number of MAC addresses to learn. The default is
1289 currently
2048. The value, if specified, is forced into a reasonable
1290 range, currently
10 to
1,
000,
000.
1295 <group title=
"Common Columns">
1296 The overall purpose of these columns is described under
<code>Common
1297 Columns
</code> at the beginning of this document.
1299 <column name=
"other_config"/>
1300 <column name=
"external_ids"/>
1304 <table name=
"Port" table=
"Port or bond configuration.">
1305 <p>A port within a
<ref table=
"Bridge"/>.
</p>
1306 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1307 <ref column=
"interfaces"/> column. Such a port logically
1308 corresponds to a port on a physical Ethernet switch. A port
1309 with more than one interface is a ``bonded port'' (see
1310 <ref group=
"Bonding Configuration"/>).
</p>
1311 <p>Some properties that one might think as belonging to a port are actually
1312 part of the port's
<ref table=
"Interface"/> members.
</p>
1314 <column name=
"name">
1315 Port name. For a non-bonded port, this should be the same as its
1316 interface's name. Port names must otherwise be unique among the names of
1317 ports, interfaces, and bridges on a host. Because port and interfaces
1318 names are usually the same, the restrictions on the
<ref
1319 table=
"Interface" column=
"name"/> column in the
<ref table=
"Interface"/>
1320 table, particularly on length, also apply to port names. Refer to the
1321 documentation for
<ref table=
"Interface"/> names for details.
1324 <column name=
"interfaces">
1325 The port's interfaces. If there is more than one, this is a
1329 <group title=
"VLAN Configuration">
1331 In short, a VLAN (short for ``virtual LAN'') is a way to partition a
1332 single switch into multiple switches. VLANs can be confusing, so for
1333 an introduction, please refer to the question ``What's a VLAN?'' in the
1338 A VLAN is sometimes encoded into a packet using a
802.1Q or
802.1ad
1339 VLAN header, but every packet is part of some VLAN whether or not it is
1340 encoded in the packet. (A packet that appears to have no VLAN is part
1341 of VLAN
0, by default.) As a result, it's useful to think of a VLAN as
1342 a metadata property of a packet, separate from how the VLAN is encoded.
1343 For a given port, this column determines how the encoding of a packet
1344 that ingresses or egresses the port maps to the packet's VLAN. When a
1345 packet enters the switch, its VLAN is determined based on its setting
1346 in this column and its VLAN headers, if any, and then, conceptually,
1347 the VLAN headers are then stripped off. Conversely, when a packet
1348 exits the switch, its VLAN and the settings in this column determine
1349 what VLAN headers, if any, are pushed onto the packet before it
1354 The VLAN configuration in this column affects Open vSwitch only when it
1355 is doing ``normal switching.'' It does not affect flows set up by an
1356 OpenFlow controller, outside of the OpenFlow ``normal action.''
1360 Bridge ports support the following types of VLAN configuration:
1367 A trunk port carries packets on one or more specified VLANs
1368 specified in the
<ref column=
"trunks"/> column (often, on every
1369 VLAN). A packet that ingresses on a trunk port is in the VLAN
1370 specified in its
802.1Q header, or VLAN
0 if the packet has no
1371 802.1Q header. A packet that egresses through a trunk port will
1372 have an
802.1Q header if it has a nonzero VLAN ID.
1376 Any packet that ingresses on a trunk port tagged with a VLAN that
1377 the port does not trunk is dropped.
1384 An access port carries packets on exactly one VLAN specified in the
1385 <ref column=
"tag"/> column. Packets egressing on an access port
1386 have no
802.1Q header.
1390 Any packet with an
802.1Q header with a nonzero VLAN ID that
1391 ingresses on an access port is dropped, regardless of whether the
1392 VLAN ID in the header is the access port's VLAN ID.
1396 <dt>native-tagged
</dt>
1398 A native-tagged port resembles a trunk port, with the exception that
1399 a packet without an
802.1Q header that ingresses on a native-tagged
1400 port is in the ``native VLAN'' (specified in the
<ref column=
"tag"/>
1404 <dt>native-untagged
</dt>
1406 A native-untagged port resembles a native-tagged port, with the
1407 exception that a packet that egresses on a native-untagged port in
1408 the native VLAN will not have an
802.1Q header.
1411 <dt>dot1q-tunnel
</dt>
1414 A dot1q-tunnel port is somewhat like an access port. Like an
1415 access port, it carries packets on the single VLAN specified in the
1416 <ref column=
"tag"/> column and this VLAN, called the service VLAN,
1417 does not appear in an
802.1Q header for packets that ingress or
1418 egress on the port. The main difference lies in the behavior when
1419 packets that include a
802.1Q header ingress on the port. Whereas
1420 an access port drops such packets, a dot1q-tunnel port treats these
1421 as double-tagged with the outer service VLAN
<ref column=
"tag"/>
1422 and the inner customer VLAN taken from the
802.1Q header.
1423 Correspondingly, to egress on the port, a packet outer VLAN (or
1424 only VLAN) must be
<ref column=
"tag"/>, which is removed before
1425 egress, which exposes the inner (customer) VLAN if one is present.
1429 If
<ref column=
"cvlans"/> is set, only allows packets in the
1430 specified customer VLANs.
1435 A packet will only egress through bridge ports that carry the VLAN of
1436 the packet, as described by the rules above.
1439 <column name=
"vlan_mode">
1441 The VLAN mode of the port, as described above. When this column is
1442 empty, a default mode is selected as follows:
1446 If
<ref column=
"tag"/> contains a value, the port is an access
1447 port. The
<ref column=
"trunks"/> column should be empty.
1450 Otherwise, the port is a trunk port. The
<ref column=
"trunks"/>
1451 column value is honored if it is present.
1458 For an access port, the port's implicitly tagged VLAN. For a
1459 native-tagged or native-untagged port, the port's native VLAN. Must
1460 be empty if this is a trunk port.
1464 <column name=
"trunks">
1466 For a trunk, native-tagged, or native-untagged port, the
802.1Q VLAN
1467 or VLANs that this port trunks; if it is empty, then the port trunks
1468 all VLANs. Must be empty if this is an access port.
1471 A native-tagged or native-untagged port always trunks its native
1472 VLAN, regardless of whether
<ref column=
"trunks"/> includes that
1477 <column name=
"cvlans">
1479 For a dot1q-tunnel port, the customer VLANs that this port includes.
1480 If this is empty, the port includes all customer VLANs.
1483 For other kinds of ports, this setting is ignored.
1487 <column name=
"other_config" key=
"qinq-ethtype"
1488 type='{
"type":
"string",
"enum": [
"set", [
"802.1ad",
"802.1q"]]}'
>
1490 For a dot1q-tunnel port, this is the TPID for the service tag, that
1491 is, for the
802.1Q header that contains the service VLAN ID. Because
1492 packets that actually ingress and egress a dot1q-tunnel port do not
1493 include an
802.1Q header for the service VLAN, this does not affect
1494 packets on the dot1q-tunnel port itself. Rather, it determines the
1495 service VLAN for a packet that ingresses on a dot1q-tunnel port and
1496 egresses on a trunk port.
1499 The value
<code>802.1ad
</code> specifies TPID
0x88a8, which is also
1500 the default if the setting is omitted. The value
<code>802.1q
</code>
1501 specifies TPID
0x8100.
1504 For other kinds of ports, this setting is ignored.
1508 <column name=
"other_config" key=
"priority-tags"
1509 type='{
"type":
"boolean"}'
>
1511 An
802.1Q header contains two important pieces of information: a VLAN
1512 ID and a priority. A frame with a zero VLAN ID, called a
1513 ``priority-tagged'' frame, is supposed to be treated the same way as
1514 a frame without an
802.1Q header at all (except for the priority).
1518 However, some network elements ignore any frame that has
802.1Q
1519 header at all, even when the VLAN ID is zero. Therefore, by default
1520 Open vSwitch does not output priority-tagged frames, instead omitting
1521 the
802.1Q header entirely if the VLAN ID is zero. Set this key to
1522 <code>true
</code> to enable priority-tagged frames on a port.
1526 Regardless of this setting, Open vSwitch omits the
802.1Q header on
1527 output if both the VLAN ID and priority would be zero.
1531 All frames output to native-tagged ports have a nonzero VLAN ID, so
1532 this setting is not meaningful on native-tagged ports.
1537 <group title=
"Bonding Configuration">
1538 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1539 allows for load balancing and fail-over.
</p>
1542 The following types of bonding will work with any kind of upstream
1543 switch. On the upstream switch, do not configure the interfaces as a
1548 <dt><code>balance-slb
</code></dt>
1550 Balances flows among slaves based on source MAC address and output
1551 VLAN, with periodic rebalancing as traffic patterns change.
1554 <dt><code>active-backup
</code></dt>
1556 Assigns all flows to one slave, failing over to a backup slave when
1557 the active slave is disabled. This is the only bonding mode in which
1558 interfaces may be plugged into different upstream switches.
1563 The following modes require the upstream switch to support
802.3ad with
1564 successful LACP negotiation. If LACP negotiation fails and
1565 other-config:lacp-fallback-ab is true, then
<code>active-backup
</code>
1570 <dt><code>balance-tcp
</code></dt>
1572 Balances flows among slaves based on L3 and L4 protocol information
1573 such as IP addresses and TCP/UDP ports.
1577 <p>These columns apply only to bonded ports. Their values are
1578 otherwise ignored.
</p>
1580 <column name=
"bond_mode">
1581 <p>The type of bonding used for a bonded port. Defaults to
1582 <code>active-backup
</code> if unset.
1586 <column name=
"other_config" key=
"bond-hash-basis"
1587 type='{
"type":
"integer"}'
>
1588 An integer hashed along with flows when choosing output slaves in load
1589 balanced bonds. When changed, all flows will be assigned different
1590 hash values possibly causing slave selection decisions to change. Does
1591 not affect bonding modes which do not employ load balancing such as
1592 <code>active-backup
</code>.
1595 <group title=
"Link Failure Detection">
1597 An important part of link bonding is detecting that links are down so
1598 that they may be disabled. These settings determine how Open vSwitch
1599 detects link failure.
1602 <column name=
"other_config" key=
"bond-detect-mode"
1603 type='{
"type":
"string",
"enum": [
"set", [
"carrier",
"miimon"]]}'
>
1604 The means used to detect link failures. Defaults to
1605 <code>carrier
</code> which uses each interface's carrier to detect
1606 failures. When set to
<code>miimon
</code>, will check for failures
1607 by polling each interface's MII.
1610 <column name=
"other_config" key=
"bond-miimon-interval"
1611 type='{
"type":
"integer"}'
>
1612 The interval, in milliseconds, between successive attempts to poll
1613 each interface's MII. Relevant only when
<ref column=
"other_config"
1614 key=
"bond-detect-mode"/> is
<code>miimon
</code>.
1617 <column name=
"bond_updelay">
1619 The number of milliseconds for which the link must stay up on an
1620 interface before the interface is considered to be up. Specify
1621 <code>0</code> to enable the interface immediately.
1625 This setting is honored only when at least one bonded interface is
1626 already enabled. When no interfaces are enabled, then the first
1627 bond interface to come up is enabled immediately.
1631 <column name=
"bond_downdelay">
1632 The number of milliseconds for which the link must stay down on an
1633 interface before the interface is considered to be down. Specify
1634 <code>0</code> to disable the interface immediately.
1638 <group title=
"LACP Configuration">
1640 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1641 allows switches to automatically detect that they are connected by
1642 multiple links and aggregate across those links. These settings
1643 control LACP behavior.
1646 <column name=
"lacp">
1647 Configures LACP on this port. LACP allows directly connected
1648 switches to negotiate which links may be bonded. LACP may be enabled
1649 on non-bonded ports for the benefit of any switches they may be
1650 connected to.
<code>active
</code> ports are allowed to initiate LACP
1651 negotiations.
<code>passive
</code> ports are allowed to participate
1652 in LACP negotiations initiated by a remote switch, but not allowed to
1653 initiate such negotiations themselves. If LACP is enabled on a port
1654 whose partner switch does not support LACP, the bond will be
1655 disabled, unless other-config:lacp-fallback-ab is set to true.
1656 Defaults to
<code>off
</code> if unset.
1659 <column name=
"other_config" key=
"lacp-system-id">
1660 The LACP system ID of this
<ref table=
"Port"/>. The system ID of a
1661 LACP bond is used to identify itself to its partners. Must be a
1662 nonzero MAC address. Defaults to the bridge Ethernet address if
1666 <column name=
"other_config" key=
"lacp-system-priority"
1667 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
1668 The LACP system priority of this
<ref table=
"Port"/>. In LACP
1669 negotiations, link status decisions are made by the system with the
1670 numerically lower priority.
1673 <column name=
"other_config" key=
"lacp-time"
1674 type='{
"type":
"string",
"enum": [
"set", [
"fast",
"slow"]]}'
>
1676 The LACP timing which should be used on this
<ref table=
"Port"/>.
1677 By default
<code>slow
</code> is used. When configured to be
1678 <code>fast
</code> LACP heartbeats are requested at a rate of once
1679 per second causing connectivity problems to be detected more
1680 quickly. In
<code>slow
</code> mode, heartbeats are requested at a
1681 rate of once every
30 seconds.
1685 <column name=
"other_config" key=
"lacp-fallback-ab"
1686 type='{
"type":
"boolean"}'
>
1688 Determines the behavior of openvswitch bond in LACP mode. If
1689 the partner switch does not support LACP, setting this option
1690 to
<code>true
</code> allows openvswitch to fallback to
1691 active-backup. If the option is set to
<code>false
</code>, the
1692 bond will be disabled. In both the cases, once the partner switch
1693 is configured to LACP mode, the bond will use LACP.
1698 <group title=
"Rebalancing Configuration">
1700 These settings control behavior when a bond is in
1701 <code>balance-slb
</code> or
<code>balance-tcp
</code> mode.
1704 <column name=
"other_config" key=
"bond-rebalance-interval"
1705 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
10000}'
>
1706 For a load balanced bonded port, the number of milliseconds between
1707 successive attempts to rebalance the bond, that is, to move flows
1708 from one interface on the bond to another in an attempt to keep usage
1709 of each interface roughly equal. If zero, load balancing is disabled
1710 on the bond (link failure still cause flows to move). If
1711 less than
1000ms, the rebalance interval will be
1000ms.
1715 <column name=
"bond_fake_iface">
1716 For a bonded port, whether to create a fake internal interface with the
1717 name of the port. Use only for compatibility with legacy software that
1722 <group title=
"Spanning Tree Protocol">
1724 The configuration here is only meaningful, and the status is only
1725 populated, when
802.1D-
1998 Spanning Tree Protocol is enabled on the
1726 port's
<ref column=
"Bridge"/> with its
<ref column=
"stp_enable"/>
1730 <group title=
"STP Configuration">
1731 <column name=
"other_config" key=
"stp-enable"
1732 type='{
"type":
"boolean"}'
>
1733 When STP is enabled on a bridge, it is enabled by default on all of
1734 the bridge's ports except bond, internal, and mirror ports (which do
1735 not work with STP). If this column's value is
<code>false
</code>,
1736 STP is disabled on the port.
1739 <column name=
"other_config" key=
"stp-port-num"
1740 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
255}'
>
1741 The port number used for the lower
8 bits of the port-id. By
1742 default, the numbers will be assigned automatically. If any
1743 port's number is manually configured on a bridge, then they
1747 <column name=
"other_config" key=
"stp-port-priority"
1748 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
255}'
>
1749 The port's relative priority value for determining the root
1750 port (the upper
8 bits of the port-id). A port with a lower
1751 port-id will be chosen as the root port. By default, the
1755 <column name=
"other_config" key=
"stp-path-cost"
1756 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
1757 Spanning tree path cost for the port. A lower number indicates
1758 a faster link. By default, the cost is based on the maximum
1763 <group title=
"STP Status">
1764 <column name=
"status" key=
"stp_port_id">
1765 The port ID used in spanning tree advertisements for this port, as
4
1766 hex digits. Configuring the port ID is described in the
1767 <code>stp-port-num
</code> and
<code>stp-port-priority
</code> keys of
1768 the
<code>other_config
</code> section earlier.
1770 <column name=
"status" key=
"stp_state"
1771 type='{
"type":
"string",
"enum": [
"set",
1772 [
"disabled",
"listening",
"learning",
1773 "forwarding",
"blocking"]]}'
>
1774 STP state of the port.
1776 <column name=
"status" key=
"stp_sec_in_state"
1777 type='{
"type":
"integer",
"minInteger":
0}'
>
1778 The amount of time this port has been in the current STP state, in
1781 <column name=
"status" key=
"stp_role"
1782 type='{
"type":
"string",
"enum": [
"set",
1783 [
"root",
"designated",
"alternate"]]}'
>
1784 STP role of the port.
1789 <group title=
"Rapid Spanning Tree Protocol">
1791 The configuration here is only meaningful, and the status and
1792 statistics are only populated, when
802.1D-
1998 Spanning Tree Protocol
1793 is enabled on the port's
<ref column=
"Bridge"/> with its
<ref
1794 column=
"stp_enable"/> column.
1797 <group title=
"RSTP Configuration">
1798 <column name=
"other_config" key=
"rstp-enable"
1799 type='{
"type":
"boolean"}'
>
1800 When RSTP is enabled on a bridge, it is enabled by default on all of
1801 the bridge's ports except bond, internal, and mirror ports (which do
1802 not work with RSTP). If this column's value is
<code>false
</code>,
1803 RSTP is disabled on the port.
1806 <column name=
"other_config" key=
"rstp-port-priority"
1807 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
240}'
>
1808 The port's relative priority value for determining the root port, in
1809 multiples of
16. By default, the port priority is
0x80 (
128). Any
1810 value in the lower
4 bits is rounded off. The significant upper
4
1811 bits become the upper
4 bits of the port-id. A port with the lowest
1812 port-id is elected as the root.
1815 <column name=
"other_config" key=
"rstp-port-num"
1816 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
1817 The local RSTP port number, used as the lower
12 bits of the port-id.
1818 By default the port numbers are assigned automatically, and typically
1819 may not correspond to the OpenFlow port numbers. A port with the
1820 lowest port-id is elected as the root.
1823 <column name=
"other_config" key=
"rstp-port-path-cost"
1824 type='{
"type":
"integer"}'
>
1825 The port path cost. The Port's contribution, when it is
1826 the Root Port, to the Root Path Cost for the Bridge. By default the
1827 cost is automatically calculated from the port's speed.
1830 <column name=
"other_config" key=
"rstp-port-admin-edge"
1831 type='{
"type":
"boolean"}'
>
1832 The admin edge port parameter for the Port. Default is
1836 <column name=
"other_config" key=
"rstp-port-auto-edge"
1837 type='{
"type":
"boolean"}'
>
1838 The auto edge port parameter for the Port. Default is
1842 <column name=
"other_config" key=
"rstp-port-mcheck"
1843 type='{
"type":
"boolean"}'
>
1845 The mcheck port parameter for the Port. Default is
1846 <code>false
</code>. May be set to force the Port Protocol
1847 Migration state machine to transmit RST BPDUs for a
1848 MigrateTime period, to test whether all STP Bridges on the
1849 attached LAN have been removed and the Port can continue to
1850 transmit RSTP BPDUs. Setting mcheck has no effect if the
1851 Bridge is operating in STP Compatibility mode.
1854 Changing the value from
<code>true
</code> to
1855 <code>false
</code> has no effect, but needs to be done if
1856 this behavior is to be triggered again by subsequently
1857 changing the value from
<code>false
</code> to
1863 <group title=
"RSTP Status">
1864 <column name=
"rstp_status" key=
"rstp_port_id">
1865 The port ID used in spanning tree advertisements for this port, as
4
1866 hex digits. Configuring the port ID is described in the
1867 <code>rstp-port-num
</code> and
<code>rstp-port-priority
</code> keys
1868 of the
<code>other_config
</code> section earlier.
1870 <column name=
"rstp_status" key=
"rstp_port_role"
1871 type='{
"type":
"string",
"enum": [
"set",
1872 [
"Root",
"Designated",
"Alternate",
"Backup",
"Disabled"]]}'
>
1873 RSTP role of the port.
1875 <column name=
"rstp_status" key=
"rstp_port_state"
1876 type='{
"type":
"string",
"enum": [
"set",
1877 [
"Disabled",
"Learning",
"Forwarding",
"Discarding"]]}'
>
1878 RSTP state of the port.
1880 <column name=
"rstp_status" key=
"rstp_designated_bridge_id">
1881 The port's RSTP designated bridge ID, in the same form as
<ref
1882 column=
"rstp_status" key=
"rstp_bridge_id"/> in the
<ref
1883 table=
"Bridge"/> table.
1885 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1886 The port's RSTP designated port ID, as
4 hex digits.
1888 <column name=
"rstp_status" key=
"rstp_designated_path_cost"
1889 type='{
"type":
"integer"}'
>
1890 The port's RSTP designated path cost. Lower is better.
1894 <group title=
"RSTP Statistics">
1895 <column name=
"rstp_statistics" key=
"rstp_tx_count">
1896 Number of RSTP BPDUs transmitted through this port.
1898 <column name=
"rstp_statistics" key=
"rstp_rx_count">
1899 Number of valid RSTP BPDUs received by this port.
1901 <column name=
"rstp_statistics" key=
"rstp_error_count">
1902 Number of invalid RSTP BPDUs received by this port.
1904 <column name=
"rstp_statistics" key=
"rstp_uptime">
1905 The duration covered by the other RSTP statistics, in seconds.
1910 <group title=
"Multicast Snooping">
1911 <column name=
"other_config" key=
"mcast-snooping-flood"
1912 type='{
"type":
"boolean"}'
>
1914 If set to
<code>true
</code>, multicast packets (except Reports) are
1915 unconditionally forwarded to the specific port.
1918 <column name=
"other_config" key=
"mcast-snooping-flood-reports"
1919 type='{
"type":
"boolean"}'
>
1921 If set to
<code>true
</code>, multicast Reports are unconditionally
1922 forwarded to the specific port.
1927 <group title=
"Other Features">
1929 Quality of Service configuration for this port.
1933 The MAC address to use for this port for the purpose of choosing the
1934 bridge's MAC address. This column does not necessarily reflect the
1935 port's actual MAC address, nor will setting it change the port's actual
1939 <column name=
"fake_bridge">
1940 Does this port represent a sub-bridge for its tagged VLAN within the
1941 Bridge? See ovs-vsctl(
8) for more information.
1944 <column name=
"protected" type='{
"type":
"boolean"}'
>
1945 The protected ports feature allows certain ports to be designated as
1946 protected. Traffic between protected ports is blocked. Protected
1947 ports can send traffic to unprotected ports. Unprotected ports can
1948 send traffic to any port.
1952 <column name=
"external_ids" key=
"fake-bridge-id-*">
1953 External IDs for a fake bridge (see the
<ref column=
"fake_bridge"/>
1954 column) are defined by prefixing a
<ref table=
"Bridge"/> <ref
1955 table=
"Bridge" column=
"external_ids"/> key with
1956 <code>fake-bridge-
</code>,
1957 e.g.
<code>fake-bridge-xs-network-uuids
</code>.
1960 <column name=
"other_config" key=
"transient"
1961 type='{
"type":
"boolean"}'
>
1963 If set to
<code>true
</code>, the port will be removed when
1964 <code>ovs-ctl start --delete-transient-ports
</code> is used.
1969 <column name=
"bond_active_slave">
1970 For a bonded port, record the mac address of the current active slave.
1973 <group title=
"Port Statistics">
1975 Key-value pairs that report port statistics. The update period
1976 is controlled by
<ref column=
"other_config"
1977 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
1979 <group title=
"Statistics: STP transmit and receive counters">
1980 <column name=
"statistics" key=
"stp_tx_count">
1981 Number of STP BPDUs sent on this port by the spanning
1984 <column name=
"statistics" key=
"stp_rx_count">
1985 Number of STP BPDUs received on this port and accepted by the
1986 spanning tree library.
1988 <column name=
"statistics" key=
"stp_error_count">
1989 Number of bad STP BPDUs received on this port. Bad BPDUs
1990 include runt packets and those with an unexpected protocol ID.
1995 <group title=
"Common Columns">
1996 The overall purpose of these columns is described under
<code>Common
1997 Columns
</code> at the beginning of this document.
1999 <column name=
"other_config"/>
2000 <column name=
"external_ids"/>
2004 <table name=
"Interface" title=
"One physical network device in a Port.">
2005 An interface within a
<ref table=
"Port"/>.
2007 <group title=
"Core Features">
2008 <column name=
"name">
2010 Interface name. Should be alphanumeric. For non-bonded port, this
2011 should be the same as the port name. It must otherwise be unique
2012 among the names of ports, interfaces, and bridges on a host.
2016 The maximum length of an interface name depends on the underlying
2022 The names of interfaces implemented as Linux and BSD network
2023 devices, including interfaces with type
<code>internal
</code>,
2024 <code>tap
</code>, or
<code>system
</code> plus the different types
2025 of tunnel ports, are limited to
15 bytes. Windows limits these
2030 The names of patch ports are not used in the underlying datapath,
2031 so operating system restrictions do not apply. Thus, they may have
2037 Regardless of other restrictions, OpenFlow only supports
15-byte
2038 names, which means that
<code>ovs-ofctl
</code> and OpenFlow
2039 controllers will show names truncated to
15 bytes.
2043 <column name=
"ifindex">
2044 A positive interface index as defined for SNMP MIB-II in RFCs
1213 and
2045 2863, if the interface has one, otherwise
0. The ifindex is useful for
2046 seamless integration with protocols such as SNMP and sFlow.
2049 <column name=
"mac_in_use">
2050 The MAC address in use by this interface.
2054 <p>Ethernet address to set for this interface. If unset then the
2055 default MAC address is used:
</p>
2057 <li>For the local interface, the default is the lowest-numbered MAC
2058 address among the other bridge ports, either the value of the
2059 <ref table=
"Port" column=
"mac"/> in its
<ref table=
"Port"/> record,
2060 if set, or its actual MAC (for bonded ports, the MAC of its slave
2061 whose name is first in alphabetical order). Internal ports and
2062 bridge ports that are used as port mirroring destinations (see the
2063 <ref table=
"Mirror"/> table) are ignored.
</li>
2064 <li>For other internal interfaces, the default MAC is randomly
2066 <li>External interfaces typically have a MAC address associated with
2067 their hardware.
</li>
2069 <p>Some interfaces may not have a software-controllable MAC
2073 <column name=
"error">
2074 If the configuration of the port failed, as indicated by -
1 in
<ref
2075 column=
"ofport"/>, Open vSwitch sets this column to an error
2076 description in human readable form. Otherwise, Open vSwitch clears
2080 <group title=
"OpenFlow Port Number">
2082 When a client adds a new interface, Open vSwitch chooses an OpenFlow
2083 port number for the new port. If the client that adds the port fills
2084 in
<ref column=
"ofport_request"/>, then Open vSwitch tries to use its
2085 value as the OpenFlow port number. Otherwise, or if the requested
2086 port number is already in use or cannot be used for another reason,
2087 Open vSwitch automatically assigns a free port number. Regardless of
2088 how the port number was obtained, Open vSwitch then reports in
<ref
2089 column=
"ofport"/> the port number actually assigned.
2093 Open vSwitch limits the port numbers that it automatically assigns to
2094 the range
1 through
32,
767, inclusive. Controllers therefore have
2095 free use of ports
32,
768 and up.
2098 <column name=
"ofport">
2100 OpenFlow port number for this interface. Open vSwitch sets this
2101 column's value, so other clients should treat it as read-only.
2104 The OpenFlow ``local'' port (
<code>OFPP_LOCAL
</code>) is
65,
534.
2105 The other valid port numbers are in the range
1 to
65,
279,
2106 inclusive. Value -
1 indicates an error adding the interface.
2110 <column name=
"ofport_request"
2111 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65279}'
>
2113 Requested OpenFlow port number for this interface.
2117 A client should ideally set this column's value in the same
2118 database transaction that it uses to create the interface. Open
2119 vSwitch version
2.1 and later will honor a later request for a
2120 specific port number, althuogh it might confuse some controllers:
2121 OpenFlow does not have a way to announce a port number change, so
2122 Open vSwitch represents it over OpenFlow as a port deletion
2123 followed immediately by a port addition.
2127 If
<ref column=
"ofport_request"/> is set or changed to some other
2128 port's automatically assigned port number, Open vSwitch chooses a
2129 new port number for the latter port.
2135 <group title=
"System-Specific Details">
2136 <column name=
"type">
2138 The interface type. The types supported by a particular instance of
2139 Open vSwitch are listed in the
<ref table=
"Open_vSwitch"
2140 column=
"iface_types"/> column in the
<ref table=
"Open_vSwitch"/>
2141 table. The following types are defined:
2145 <dt><code>system
</code></dt>
2146 <dd>An ordinary network device, e.g.
<code>eth0
</code> on Linux.
2147 Sometimes referred to as ``external interfaces'' since they are
2148 generally connected to hardware external to that on which the Open
2149 vSwitch is running. The empty string is a synonym for
2150 <code>system
</code>.
</dd>
2152 <dt><code>internal
</code></dt>
2153 <dd>A simulated network device that sends and receives traffic. An
2154 internal interface whose
<ref column=
"name"/> is the same as its
2155 bridge's
<ref table=
"Open_vSwitch" column=
"name"/> is called the
2156 ``local interface.'' It does not make sense to bond an internal
2157 interface, so the terms ``port'' and ``interface'' are often used
2158 imprecisely for internal interfaces.
</dd>
2160 <dt><code>tap
</code></dt>
2161 <dd>A TUN/TAP device managed by Open vSwitch.
</dd>
2163 <dt><code>geneve
</code></dt>
2165 An Ethernet over Geneve (
<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve
</code>)
2168 A description of how to match and set Geneve options can be found
2169 in the
<code>ovs-ofctl
</code> manual page.
2172 <dt><code>gre
</code></dt>
2174 Generic Routing Encapsulation (GRE) over IPv4/IPv6 tunnel,
2175 configurable to encapsulate layer
2 or layer
3 traffic.
2178 <dt><code>vxlan
</code></dt>
2181 An Ethernet tunnel over the UDP-based VXLAN protocol described in
2185 Open vSwitch uses IANA-assigned UDP destination port
4789. The
2186 source port used for VXLAN traffic varies on a per-flow basis
2187 and is in the ephemeral port range.
2191 <dt><code>lisp
</code></dt>
2194 A layer
3 tunnel over the experimental, UDP-based Locator/ID
2195 Separation Protocol (RFC
6830).
2198 Only IPv4 and IPv6 packets are supported by the protocol, and
2199 they are sent and received without an Ethernet header. Traffic
2200 to/from LISP ports is expected to be configured explicitly, and
2201 the ports are not intended to participate in learning based
2202 switching. As such, they are always excluded from packet
2207 <dt><code>stt
</code></dt>
2209 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
2210 endpoints are in end-systems, as it utilizes the capabilities of
2211 standard network interface cards to improve performance. STT utilizes
2212 a TCP-like header inside the IP header. It is stateless, i.e., there is
2213 no TCP connection state of any kind associated with the tunnel. The
2214 TCP-like header is used to leverage the capabilities of existing
2215 network interface cards, but should not be interpreted as implying
2216 any sort of connection state between endpoints.
2217 Since the STT protocol does not engage in the usual TCP
3-way handshake,
2218 so it will have difficulty traversing stateful firewalls.
2219 The protocol is documented at
2220 https://tools.ietf.org/html/draft-davie-stt
2222 All traffic uses a default destination port of
7471.
2225 <dt><code>patch
</code></dt>
2227 A pair of virtual devices that act as a patch cable.
2230 <dt><code>null
</code></dt>
2231 <dd>An ignored interface. Deprecated and slated for removal in
2237 <group title=
"Tunnel Options">
2239 These options apply to interfaces with
<ref column=
"type"/> of
2240 <code>geneve
</code>,
<code>gre
</code>,
<code>vxlan
</code>,
2241 <code>lisp
</code> and
<code>stt
</code>.
2245 Each tunnel must be uniquely identified by the combination of
<ref
2246 column=
"type"/>,
<ref column=
"options" key=
"remote_ip"/>,
<ref
2247 column=
"options" key=
"local_ip"/>, and
<ref column=
"options"
2248 key=
"in_key"/>. If two ports are defined that are the same except one
2249 has an optional identifier and the other does not, the more specific
2250 one is matched first.
<ref column=
"options" key=
"in_key"/> is
2251 considered more specific than
<ref column=
"options" key=
"local_ip"/> if
2252 a port defines one and another port defines the other.
2255 <column name=
"options" key=
"remote_ip">
2256 <p>Required. The remote tunnel endpoint, one of:
</p>
2260 An IPv4 or IPv6 address (not a DNS name), e.g.
<code>192.168.0.123</code>.
2261 Only unicast endpoints are supported.
2264 The word
<code>flow
</code>. The tunnel accepts packets from any
2265 remote tunnel endpoint. To process only packets from a specific
2266 remote tunnel endpoint, the flow entries may match on the
2267 <code>tun_src
</code> or
<code>tun_ipv6_src
</code>field. When
2268 sending packets to a
<code>remote_ip=flow
</code> tunnel, the flow
2269 actions must explicitly set the
<code>tun_dst
</code> or
2270 <code>tun_ipv6_dst
</code> field to the IP address of the desired
2271 remote tunnel endpoint, e.g. with a
<code>set_field
</code> action.
2276 The remote tunnel endpoint for any packet received from a tunnel
2277 is available in the
<code>tun_src
</code> field for matching in the
2282 <column name=
"options" key=
"local_ip">
2284 Optional. The tunnel destination IP that received packets must
2285 match. Default is to match all addresses. If specified, may be one
2291 An IPv4/IPv6 address (not a DNS name), e.g.
<code>192.168.12.3</code>.
2294 The word
<code>flow
</code>. The tunnel accepts packets sent to any
2295 of the local IP addresses of the system running OVS. To process
2296 only packets sent to a specific IP address, the flow entries may
2297 match on the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code> field.
2298 When sending packets to a
<code>local_ip=flow
</code> tunnel, the flow
2299 actions may explicitly set the
<code>tun_src
</code> or
<code>tun_ipv6_src
</code>
2300 field to the desired IP address, e.g. with a
<code>set_field
</code> action.
2301 However, while routing the tunneled packet out, the local system may
2302 override the specified address with the local IP address configured for the
2303 outgoing system interface.
2306 This option is valid only for tunnels also configured with the
2307 <code>remote_ip=flow
</code> option.
2313 The tunnel destination IP address for any packet received from a
2314 tunnel is available in the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code>
2315 field for matching in the flow table.
2319 <column name=
"options" key=
"in_key">
2320 <p>Optional. The key that received packets must contain, one of:
</p>
2324 <code>0</code>. The tunnel receives packets with no key or with a
2325 key of
0. This is equivalent to specifying no
<ref column=
"options"
2326 key=
"in_key"/> at all.
2329 A positive
24-bit (for Geneve, VXLAN, and LISP),
32-bit (for GRE)
2330 or
64-bit (for STT) number. The tunnel receives only
2331 packets with the specified key.
2334 The word
<code>flow
</code>. The tunnel accepts packets with any
2335 key. The key will be placed in the
<code>tun_id
</code> field for
2336 matching in the flow table. The
<code>ovs-ofctl
</code> manual page
2337 contains additional information about matching fields in OpenFlow
2346 <column name=
"options" key=
"out_key">
2347 <p>Optional. The key to be set on outgoing packets, one of:
</p>
2351 <code>0</code>. Packets sent through the tunnel will have no key.
2352 This is equivalent to specifying no
<ref column=
"options"
2353 key=
"out_key"/> at all.
2356 A positive
24-bit (for Geneve, VXLAN and LISP),
32-bit (for GRE) or
2357 64-bit (for STT) number. Packets sent through the tunnel
2358 will have the specified key.
2361 The word
<code>flow
</code>. Packets sent through the tunnel will
2362 have the key set using the
<code>set_tunnel
</code> Nicira OpenFlow
2363 vendor extension (
0 is used in the absence of an action). The
2364 <code>ovs-ofctl
</code> manual page contains additional information
2365 about the Nicira OpenFlow vendor extensions.
2370 <column name=
"options" key=
"key">
2371 Optional. Shorthand to set
<code>in_key
</code> and
2372 <code>out_key
</code> at the same time.
2375 <column name=
"options" key=
"tos">
2376 Optional. The value of the ToS bits to be set on the encapsulating
2377 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2378 zero. It may also be the word
<code>inherit
</code>, in which case
2379 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2380 (otherwise it will be
0). The ECN fields are always inherited.
2384 <column name=
"options" key=
"ttl">
2385 Optional. The TTL to be set on the encapsulating packet. It may also
2386 be the word
<code>inherit
</code>, in which case the TTL will be copied
2387 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2388 system default, typically
64). Default is the system default TTL.
2391 <column name=
"options" key=
"df_default"
2392 type='{
"type":
"boolean"}'
>
2393 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2394 outer headers to allow path MTU discovery. Default is enabled; set
2395 to
<code>false
</code> to disable.
2398 <column name=
"options" key=
"egress_pkt_mark">
2399 Optional. The pkt_mark to be set on the encapsulating packet. This
2400 option sets packet mark for the tunnel endpoint for all tunnel packets
2401 including tunnel monitoring.
2404 <group title=
"Tunnel Options: lisp only">
2405 <column name=
"options" key=
"packet_type"
2406 type='{
"type":
"string",
"enum": [
"set",
2407 [
"legacy_l3",
"ptap"]]}'
>
2409 A LISP tunnel sends and receives only IPv4 and IPv6 packets. This
2410 option controls what how the tunnel represents the packets that it
2416 By default, or if this option is
<code>legacy_l3
</code>, the
2417 tunnel represents packets as Ethernet frames for compatibility
2418 with legacy OpenFlow controllers that expect this behavior.
2421 If this option is
<code>ptap
</code>, the tunnel represents
2422 packets using the
<code>packet_type
</code> mechanism introduced
2429 <group title=
"Tunnel Options: vxlan only">
2431 <column name=
"options" key=
"exts">
2432 <p>Optional. Comma separated list of optional VXLAN extensions to
2433 enable. The following extensions are supported:
</p>
2437 <code>gbp
</code>: VXLAN-GBP allows to transport the group policy
2438 context of a packet across the VXLAN tunnel to other network
2439 peers. See the description of
<code>tun_gbp_id
</code> and
2440 <code>tun_gbp_flags
</code> in
<code>ovs-fields
</code>(
7) for
2441 additional information.
2442 (
<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy
</code>)
2445 <code>gpe
</code>: Support for Generic Protocol Encapsulation in
2446 accordance with IETF draft
2447 <code>https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe
</code>.
2448 Without this option, a VXLAN packet always encapsulates an
2449 Ethernet frame. With this option, an VXLAN packet may also
2450 encapsulate an IPv4, IPv6, NSH, or MPLS packet.
2455 <column name=
"options" key=
"packet_type"
2456 type='{
"type":
"string",
"enum": [
"set",
2457 [
"legacy_l2",
"legacy_l3",
"ptap"]]}'
>
2459 This option controls what types of packets the tunnel sends and
2460 receives and how it represents them:
2465 By default, or if this option is
<code>legacy_l2
</code>, the
2466 tunnel sends and receives only Ethernet frames.
2469 If this option is
<code>legacy_l3
</code>, the tunnel sends and
2470 receives only non-Ethernet (L3) packet, but the packets are
2471 represented as Ethernet frames for compatibility with legacy
2472 OpenFlow controllers that expect this behavior. This requires
2473 enabling
<code>gpe
</code> in
<ref column=
"options" key=
"exts"/>.
2476 If this option is
<code>ptap
</code>, Open vSwitch represents
2477 packets in the tunnel using the
<code>packet_type
</code>
2478 mechanism introduced in OpenFlow
1.5. This mechanism supports
2479 any kind of packet, but actually sending and receiving
2480 non-Ethernet packets requires additionally enabling
2481 <code>gpe
</code> in
<ref column=
"options" key=
"exts"/>.
2487 <group title=
"Tunnel Options: gre only">
2489 <code>gre
</code> interfaces support these options.
2492 <column name=
"options" key=
"packet_type"
2493 type='{
"type":
"string",
"enum": [
"set",
2494 [
"legacy_l2",
"legacy_l3",
"ptap"]]}'
>
2496 This option controls what types of packets the tunnel sends and
2497 receives and how it represents them:
2502 By default, or if this option is
<code>legacy_l2
</code>, the
2503 tunnel sends and receives only Ethernet frames.
2506 If this option is
<code>legacy_l3
</code>, the tunnel sends and
2507 receives only non-Ethernet (L3) packet, but the packets are
2508 represented as Ethernet frames for compatibility with legacy
2509 OpenFlow controllers that expect this behavior.
2512 If this option is
<code>ptap
</code>, the tunnel sends and
2513 receives any kind of packet. Open vSwitch represents packets in
2514 the tunnel using the
<code>packet_type
</code> mechanism
2515 introduced in OpenFlow
1.5.
2521 <group title=
"Tunnel Options: gre, geneve, and vxlan">
2523 <code>gre
</code>,
<code>geneve
</code>, and
2524 <code>vxlan
</code> interfaces support these options.
2527 <column name=
"options" key=
"csum" type='{
"type":
"boolean"}'
>
2529 Optional. Compute encapsulation header (either GRE or UDP)
2530 checksums on outgoing packets. Default is disabled, set to
2531 <code>true
</code> to enable. Checksums present on incoming
2532 packets will be validated regardless of this setting.
2536 When using the upstream Linux kernel module, computation of
2537 checksums for
<code>geneve
</code> and
<code>vxlan
</code> requires
2538 Linux kernel version
4.0 or higher.
<code>gre
</code> supports
2539 checksums for all versions of Open vSwitch that support GRE.
2540 The out of tree kernel module distributed as part of OVS
2541 can compute all tunnel checksums on any kernel version that it
2549 <group title=
"Patch Options">
2551 Only
<code>patch
</code> interfaces support these options.
2554 <column name=
"options" key=
"peer">
2555 The
<ref column=
"name"/> of the
<ref table=
"Interface"/> for the other
2556 side of the patch. The named
<ref table=
"Interface"/>'s own
2557 <code>peer
</code> option must specify this
<ref table=
"Interface"/>'s
2558 name. That is, the two patch interfaces must have reversed
<ref
2559 column=
"name"/> and
<code>peer
</code> values.
2563 <group title=
"PMD (Poll Mode Driver) Options">
2565 Only PMD netdevs support these options.
2568 <column name=
"options" key=
"n_rxq"
2569 type='{
"type":
"integer",
"minInteger":
1}'
>
2571 Specifies the maximum number of rx queues to be created for PMD
2572 netdev. If not specified or specified to
0, one rx queue will
2573 be created by default.
2574 Not supported by DPDK vHost interfaces.
2578 <column name=
"options" key=
"dpdk-devargs"
2579 type='{
"type":
"string"}'
>
2581 Specifies the PCI address associated with the port for physical
2582 devices, or the virtual driver to be used for the port when a virtual
2583 PMD is intended to be used. For the latter, the argument string
2584 typically takes the form of
2585 <code>eth_
<var>driver_name
</var><var>x
</var></code>, where
2586 <var>driver_name
</var> is a valid virtual DPDK PMD driver name and
2587 <var>x
</var> is a unique identifier of your choice for the given
2588 port. Only supported by the dpdk port type.
2592 <column name=
"other_config" key=
"pmd-rxq-affinity">
2593 <p>Specifies mapping of RX queues of this interface to CPU cores.
</p>
2594 <p>Value should be set in the following form:
</p>
2596 <code>other_config:pmd-rxq-affinity=
<rxq-affinity-list
></code>
2602 <rxq-affinity-list
> ::= NULL |
<non-empty-list
>
2605 <non-empty-list
> ::=
<affinity-pair
> |
2606 <affinity-pair
> ,
<non-empty-list
>
2609 <affinity-pair
> ::=
<queue-id
> :
<core-id
>
2615 <column name=
"options" key=
"vhost-server-path"
2616 type='{
"type":
"string"}'
>
2618 The value specifies the path to the socket associated with a vHost
2619 User client mode device that has been or will be created by QEMU.
2620 Only supported by dpdkvhostuserclient interfaces.
2624 <column name=
"options" key=
"n_rxq_desc"
2625 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4096}'
>
2627 Specifies the rx queue size (number rx descriptors) for dpdk ports.
2628 The value must be a power of
2, less than
4096 and supported
2629 by the hardware of the device being configured.
2630 If not specified or an incorrect value is specified,
2048 rx
2631 descriptors will be used by default.
2635 <column name=
"options" key=
"n_txq_desc"
2636 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4096}'
>
2638 Specifies the tx queue size (number tx descriptors) for dpdk ports.
2639 The value must be a power of
2, less than
4096 and supported
2640 by the hardware of the device being configured.
2641 If not specified or an incorrect value is specified,
2048 tx
2642 descriptors will be used by default.
2649 The MTU (maximum transmission unit) is the largest amount of data
2650 that can fit into a single Ethernet frame. The standard Ethernet
2651 MTU is
1500 bytes. Some physical media and many kinds of virtual
2652 interfaces can be configured with higher MTUs.
2656 A client may change an interface MTU by filling in
2657 <ref column=
"mtu_request"/>. Open vSwitch then reports in
2658 <ref column=
"mtu"/> the currently configured value.
2663 The currently configured MTU for the interface.
2667 This column will be empty for an interface that does not
2668 have an MTU as, for example, some kinds of tunnels do not.
2672 Open vSwitch sets this column's value, so other clients should treat
2677 <column name=
"mtu_request"
2678 type='{
"type":
"integer",
"minInteger":
1}'
>
2680 Requested MTU (Maximum Transmission Unit) for the interface. A client
2681 can fill this column to change the MTU of an interface.
2685 RFC
791 requires every internet module to be able to forward a
2686 datagram of
68 octets without further fragmentation. The maximum
2687 size of an IP packet is
65535 bytes.
2691 If this is not set and if the interface has
<code>internal
</code>
2692 type, Open vSwitch will change the MTU to match the minimum of the
2693 other interfaces in the bridge.
2699 <group title=
"Interface Status">
2701 Status information about interfaces attached to bridges, updated every
2702 5 seconds. Not all interfaces have all of these properties; virtual
2703 interfaces don't have a link speed, for example. Non-applicable
2704 columns will have empty values.
2706 <column name=
"admin_state">
2708 The administrative state of the physical network link.
2712 <column name=
"link_state">
2714 The observed state of the physical network link. This is ordinarily
2715 the link's carrier status. If the interface's
<ref table=
"Port"/> is
2716 a bond configured for miimon monitoring, it is instead the network
2717 link's miimon status.
2721 <column name=
"link_resets">
2723 The number of times Open vSwitch has observed the
2724 <ref column=
"link_state"/> of this
<ref table=
"Interface"/> change.
2728 <column name=
"link_speed">
2730 The negotiated speed of the physical network link.
2731 Valid values are positive integers greater than
0.
2735 <column name=
"duplex">
2737 The duplex mode of the physical network link.
2741 <column name=
"lacp_current">
2742 Boolean value indicating LACP status for this interface. If true, this
2743 interface has current LACP information about its LACP partner. This
2744 information may be used to monitor the health of interfaces in a LACP
2745 enabled port. This column will be empty if LACP is not enabled.
2748 <column name=
"status">
2749 Key-value pairs that report port status. Supported status values are
2750 <ref column=
"type"/>-dependent; some interfaces may not have a valid
2751 <ref column=
"status" key=
"driver_name"/>, for example.
2754 <column name=
"status" key=
"driver_name">
2755 The name of the device driver controlling the network adapter.
2758 <column name=
"status" key=
"driver_version">
2759 The version string of the device driver controlling the network
2763 <column name=
"status" key=
"firmware_version">
2764 The version string of the network adapter's firmware, if available.
2767 <column name=
"status" key=
"source_ip">
2768 The source IP address used for an IPv4/IPv6 tunnel end-point, such as
2772 <column name=
"status" key=
"tunnel_egress_iface">
2773 Egress interface for tunnels. Currently only relevant for tunnels
2774 on Linux systems, this column will show the name of the interface
2775 which is responsible for routing traffic destined for the configured
2776 <ref column=
"options" key=
"remote_ip"/>. This could be an internal
2777 interface such as a bridge port.
2780 <column name=
"status" key=
"tunnel_egress_iface_carrier"
2781 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
2782 Whether carrier is detected on
<ref column=
"status"
2783 key=
"tunnel_egress_iface"/>.
2787 <group title=
"Statistics">
2789 Key-value pairs that report interface statistics. The current
2790 implementation updates these counters periodically. The update period
2791 is controlled by
<ref column=
"other_config"
2792 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
2793 Future implementations may update them when an interface is created,
2794 when they are queried (e.g. using an OVSDB
<code>select
</code>
2795 operation), and just before an interface is deleted due to virtual
2796 interface hot-unplug or VM shutdown, and perhaps at other times, but
2797 not on any regular periodic basis.
2800 These are the same statistics reported by OpenFlow in its
<code>struct
2801 ofp_port_stats
</code> structure. If an interface does not support a
2802 given statistic, then that pair is omitted.
2804 <group title=
"Statistics: Successful transmit and receive counters">
2805 <column name=
"statistics" key=
"rx_packets">
2806 Number of received packets.
2808 <column name=
"statistics" key=
"rx_bytes">
2809 Number of received bytes.
2811 <column name=
"statistics" key=
"tx_packets">
2812 Number of transmitted packets.
2814 <column name=
"statistics" key=
"tx_bytes">
2815 Number of transmitted bytes.
2818 <group title=
"Statistics: Receive errors">
2819 <column name=
"statistics" key=
"rx_dropped">
2820 Number of packets dropped by RX.
2822 <column name=
"statistics" key=
"rx_frame_err">
2823 Number of frame alignment errors.
2825 <column name=
"statistics" key=
"rx_over_err">
2826 Number of packets with RX overrun.
2828 <column name=
"statistics" key=
"rx_crc_err">
2829 Number of CRC errors.
2831 <column name=
"statistics" key=
"rx_errors">
2832 Total number of receive errors, greater than or equal to the sum of
2836 <group title=
"Statistics: Transmit errors">
2837 <column name=
"statistics" key=
"tx_dropped">
2838 Number of packets dropped by TX.
2840 <column name=
"statistics" key=
"collisions">
2841 Number of collisions.
2843 <column name=
"statistics" key=
"tx_errors">
2844 Total number of transmit errors, greater than or equal to the sum of
2850 <group title=
"Ingress Policing">
2852 These settings control ingress policing for packets received on this
2853 interface. On a physical interface, this limits the rate at which
2854 traffic is allowed into the system from the outside; on a virtual
2855 interface (one connected to a virtual machine), this limits the rate at
2856 which the VM is able to transmit.
2859 Policing is a simple form of quality-of-service that simply drops
2860 packets received in excess of the configured rate. Due to its
2861 simplicity, policing is usually less accurate and less effective than
2862 egress QoS (which is configured using the
<ref table=
"QoS"/> and
<ref
2863 table=
"Queue"/> tables).
2866 Policing is currently implemented on Linux and OVS with DPDK. Both
2867 implementations use a simple ``token bucket'' approach:
2871 The size of the bucket corresponds to
<ref
2872 column=
"ingress_policing_burst"/>. Initially the bucket is full.
2875 Whenever a packet is received, its size (converted to tokens) is
2876 compared to the number of tokens currently in the bucket. If the
2877 required number of tokens are available, they are removed and the
2878 packet is forwarded. Otherwise, the packet is dropped.
2881 Whenever it is not full, the bucket is refilled with tokens at the
2882 rate specified by
<ref column=
"ingress_policing_rate"/>.
2886 Policing interacts badly with some network protocols, and especially
2887 with fragmented IP packets. Suppose that there is enough network
2888 activity to keep the bucket nearly empty all the time. Then this token
2889 bucket algorithm will forward a single packet every so often, with the
2890 period depending on packet size and on the configured rate. All of the
2891 fragments of an IP packets are normally transmitted back-to-back, as a
2892 group. In such a situation, therefore, only one of these fragments
2893 will be forwarded and the rest will be dropped. IP does not provide
2894 any way for the intended recipient to ask for only the remaining
2895 fragments. In such a case there are two likely possibilities for what
2896 will happen next: either all of the fragments will eventually be
2897 retransmitted (as TCP will do), in which case the same problem will
2898 recur, or the sender will not realize that its packet has been dropped
2899 and data will simply be lost (as some UDP-based protocols will do).
2900 Either way, it is possible that no forward progress will ever occur.
2902 <column name=
"ingress_policing_rate">
2904 Maximum rate for data received on this interface, in kbps. Data
2905 received faster than this rate is dropped. Set to
<code>0</code>
2906 (the default) to disable policing.
2910 <column name=
"ingress_policing_burst">
2911 <p>Maximum burst size for data received on this interface, in kb. The
2912 default burst size if set to
<code>0</code> is
8000 kbit. This value
2913 has no effect if
<ref column=
"ingress_policing_rate"/>
2914 is
<code>0</code>.
</p>
2916 Specifying a larger burst size lets the algorithm be more forgiving,
2917 which is important for protocols like TCP that react severely to
2918 dropped packets. The burst size should be at least the size of the
2919 interface's MTU. Specifying a value that is numerically at least as
2920 large as
80% of
<ref column=
"ingress_policing_rate"/> helps TCP come
2921 closer to achieving the full rate.
2926 <group title=
"Bidirectional Forwarding Detection (BFD)">
2928 BFD, defined in RFC
5880 and RFC
5881, allows point-to-point
2929 detection of connectivity failures by occasional transmission of
2930 BFD control messages. Open vSwitch implements BFD to serve
2931 as a more popular and standards compliant alternative to CFM.
2935 BFD operates by regularly transmitting BFD control messages at a rate
2936 negotiated independently in each direction. Each endpoint specifies
2937 the rate at which it expects to receive control messages, and the rate
2938 at which it is willing to transmit them. By default, Open vSwitch uses
2939 a detection multiplier of three, meaning that an endpoint signals a
2940 connectivity fault if three consecutive BFD control messages fail to
2941 arrive. In the case of a unidirectional connectivity issue, the system
2942 not receiving BFD control messages signals the problem to its peer in
2943 the messages it transmits.
2947 The Open vSwitch implementation of BFD aims to comply faithfully
2948 with RFC
5880 requirements. Open vSwitch does not implement the
2949 optional Authentication or ``Echo Mode'' features.
2952 <group title=
"BFD Configuration">
2954 A controller sets up key-value pairs in the
<ref column=
"bfd"/>
2955 column to enable and configure BFD.
2958 <column name=
"bfd" key=
"enable" type='{
"type":
"boolean"}'
>
2959 True to enable BFD on this
<ref table=
"Interface"/>. If not
2960 specified, BFD will not be enabled by default.
2963 <column name=
"bfd" key=
"min_rx"
2964 type='{
"type":
"integer",
"minInteger":
1}'
>
2965 The shortest interval, in milliseconds, at which this BFD session
2966 offers to receive BFD control messages. The remote endpoint may
2967 choose to send messages at a slower rate. Defaults to
2971 <column name=
"bfd" key=
"min_tx"
2972 type='{
"type":
"integer",
"minInteger":
1}'
>
2973 The shortest interval, in milliseconds, at which this BFD session is
2974 willing to transmit BFD control messages. Messages will actually be
2975 transmitted at a slower rate if the remote endpoint is not willing to
2976 receive as quickly as specified. Defaults to
<code>100</code>.
2979 <column name=
"bfd" key=
"decay_min_rx" type='{
"type":
"integer"}'
>
2980 An alternate receive interval, in milliseconds, that must be greater
2981 than or equal to
<ref column=
"bfd" key=
"min_rx"/>. The
2982 implementation switches from
<ref column=
"bfd" key=
"min_rx"/> to
<ref
2983 column=
"bfd" key=
"decay_min_rx"/> when there is no obvious incoming
2984 data traffic at the interface, to reduce the CPU and bandwidth cost
2985 of monitoring an idle interface. This feature may be disabled by
2986 setting a value of
0. This feature is reset whenever
<ref
2987 column=
"bfd" key=
"decay_min_rx"/> or
<ref column=
"bfd" key=
"min_rx"/>
2991 <column name=
"bfd" key=
"forwarding_if_rx" type='{
"type":
"boolean"}'
>
2992 When
<code>true
</code>, traffic received on the
2993 <ref table=
"Interface"/> is used to indicate the capability of packet
2994 I/O. BFD control packets are still transmitted and received. At
2995 least one BFD control packet must be received every
100 *
<ref
2996 column=
"bfd" key=
"min_rx"/> amount of time. Otherwise, even if
2997 traffic are received, the
<ref column=
"bfd" key=
"forwarding"/>
2998 will be
<code>false
</code>.
3001 <column name=
"bfd" key=
"cpath_down" type='{
"type":
"boolean"}'
>
3002 Set to true to notify the remote endpoint that traffic should not be
3003 forwarded to this system for some reason other than a connectivty
3004 failure on the interface being monitored. The typical underlying
3005 reason is ``concatenated path down,'' that is, that connectivity
3006 beyond the local system is down. Defaults to false.
3009 <column name=
"bfd" key=
"check_tnl_key" type='{
"type":
"boolean"}'
>
3010 Set to true to make BFD accept only control messages with a tunnel
3011 key of zero. By default, BFD accepts control messages with any
3015 <column name=
"bfd" key=
"bfd_local_src_mac">
3016 Set to an Ethernet address in the form
3017 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
3018 to set the MAC used as source for transmitted BFD packets. The
3019 default is the mac address of the BFD enabled interface.
3022 <column name=
"bfd" key=
"bfd_local_dst_mac">
3023 Set to an Ethernet address in the form
3024 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
3025 to set the MAC used as destination for transmitted BFD packets. The
3026 default is
<code>00:
23:
20:
00:
00:
01</code>.
3029 <column name=
"bfd" key=
"bfd_remote_dst_mac">
3030 Set to an Ethernet address in the form
3031 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
3032 to set the MAC used for checking the destination of received BFD packets.
3033 Packets with different destination MAC will not be considered as BFD packets.
3034 If not specified the destination MAC address of received BFD packets
3038 <column name=
"bfd" key=
"bfd_src_ip">
3039 Set to an IPv4 address to set the IP address used as source for
3040 transmitted BFD packets. The default is
<code>169.254.1.1</code>.
3043 <column name=
"bfd" key=
"bfd_dst_ip">
3044 Set to an IPv4 address to set the IP address used as destination
3045 for transmitted BFD packets. The default is
<code>169.254.1.0</code>.
3048 <column name=
"bfd" key=
"oam">
3049 Some tunnel protocols (such as Geneve) include a bit in the header
3050 to indicate that the encapsulated packet is an OAM frame. By setting
3051 this to true, BFD packets will be marked as OAM if encapsulated in
3052 one of these tunnels.
3055 <column name=
"bfd" key=
"mult"
3056 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
255}'
>
3057 The BFD detection multiplier, which defaults to
3. An endpoint
3058 signals a connectivity fault if the given number of consecutive BFD
3059 control messages fail to arrive.
3063 <group title=
"BFD Status">
3065 The switch sets key-value pairs in the
<ref column=
"bfd_status"/>
3066 column to report the status of BFD on this interface. When BFD is
3067 not enabled, with
<ref column=
"bfd" key=
"enable"/>, the switch clears
3068 all key-value pairs from
<ref column=
"bfd_status"/>.
3071 <column name=
"bfd_status" key=
"state"
3072 type='{
"type":
"string",
3073 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
3074 Reports the state of the BFD session. The BFD session is fully
3075 healthy and negotiated if
<code>UP
</code>.
3078 <column name=
"bfd_status" key=
"forwarding" type='{
"type":
"boolean"}'
>
3079 Reports whether the BFD session believes this
<ref
3080 table=
"Interface"/> may be used to forward traffic. Typically this
3081 means the local session is signaling
<code>UP
</code>, and the remote
3082 system isn't signaling a problem such as concatenated path down.
3085 <column name=
"bfd_status" key=
"diagnostic">
3086 A diagnostic code specifying the local system's reason for the
3087 last change in session state. The error messages are defined in
3088 section
4.1 of [RFC
5880].
3091 <column name=
"bfd_status" key=
"remote_state"
3092 type='{
"type":
"string",
3093 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
3094 Reports the state of the remote endpoint's BFD session.
3097 <column name=
"bfd_status" key=
"remote_diagnostic">
3098 A diagnostic code specifying the remote system's reason for the
3099 last change in session state. The error messages are defined in
3100 section
4.1 of [RFC
5880].
3103 <column name=
"bfd_status" key=
"flap_count"
3104 type='{
"type":
"integer",
"minInteger":
0}'
>
3105 Counts the number of
<ref column=
"bfd_status" key=
"forwarding" />
3106 flaps since start. A flap is considered as a change of the
3107 <ref column=
"bfd_status" key=
"forwarding" /> value.
3112 <group title=
"Connectivity Fault Management">
3114 802.1ag Connectivity Fault Management (CFM) allows a group of
3115 Maintenance Points (MPs) called a Maintenance Association (MA) to
3116 detect connectivity problems with each other. MPs within a MA should
3117 have complete and exclusive interconnectivity. This is verified by
3118 occasionally broadcasting Continuity Check Messages (CCMs) at a
3119 configurable transmission interval.
3123 According to the
802.1ag specification, each Maintenance Point should
3124 be configured out-of-band with a list of Remote Maintenance Points it
3125 should have connectivity to. Open vSwitch differs from the
3126 specification in this area. It simply assumes the link is faulted if
3127 no Remote Maintenance Points are reachable, and considers it not
3132 When operating over tunnels which have no
<code>in_key
</code>, or an
3133 <code>in_key
</code> of
<code>flow
</code>. CFM will only accept CCMs
3134 with a tunnel key of zero.
3137 <column name=
"cfm_mpid">
3139 A Maintenance Point ID (MPID) uniquely identifies each endpoint
3140 within a Maintenance Association. The MPID is used to identify this
3141 endpoint to other Maintenance Points in the MA. Each end of a link
3142 being monitored should have a different MPID. Must be configured to
3143 enable CFM on this
<ref table=
"Interface"/>.
3146 According to the
802.1ag specification, MPIDs can only range between
3147 [
1,
8191]. However, extended mode (see
<ref column=
"other_config"
3148 key=
"cfm_extended"/>) supports eight byte MPIDs.
3152 <column name=
"cfm_flap_count">
3153 Counts the number of cfm fault flapps since boot. A flap is
3154 considered to be a change of the
<ref column=
"cfm_fault"/> value.
3157 <column name=
"cfm_fault">
3159 Indicates a connectivity fault triggered by an inability to receive
3160 heartbeats from any remote endpoint. When a fault is triggered on
3161 <ref table=
"Interface"/>s participating in bonds, they will be
3165 Faults can be triggered for several reasons. Most importantly they
3166 are triggered when no CCMs are received for a period of
3.5 times the
3167 transmission interval. Faults are also triggered when any CCMs
3168 indicate that a Remote Maintenance Point is not receiving CCMs but
3169 able to send them. Finally, a fault is triggered if a CCM is
3170 received which indicates unexpected configuration. Notably, this
3171 case arises when a CCM is received which advertises the local MPID.
3175 <column name=
"cfm_fault_status" key=
"recv">
3176 Indicates a CFM fault was triggered due to a lack of CCMs received on
3177 the
<ref table=
"Interface"/>.
3180 <column name=
"cfm_fault_status" key=
"rdi">
3181 Indicates a CFM fault was triggered due to the reception of a CCM with
3182 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
3183 are not receiving CCMs themselves. This typically indicates a
3184 unidirectional connectivity failure.
3187 <column name=
"cfm_fault_status" key=
"maid">
3188 Indicates a CFM fault was triggered due to the reception of a CCM with
3189 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
3190 with an identification number in addition to the MPID called the MAID.
3191 Open vSwitch only supports receiving CCM broadcasts tagged with the
3192 MAID it uses internally.
3195 <column name=
"cfm_fault_status" key=
"loopback">
3196 Indicates a CFM fault was triggered due to the reception of a CCM
3197 advertising the same MPID configured in the
<ref column=
"cfm_mpid"/>
3198 column of this
<ref table=
"Interface"/>. This may indicate a loop in
3202 <column name=
"cfm_fault_status" key=
"overflow">
3203 Indicates a CFM fault was triggered because the CFM module received
3204 CCMs from more remote endpoints than it can keep track of.
3207 <column name=
"cfm_fault_status" key=
"override">
3208 Indicates a CFM fault was manually triggered by an administrator using
3209 an
<code>ovs-appctl
</code> command.
3212 <column name=
"cfm_fault_status" key=
"interval">
3213 Indicates a CFM fault was triggered due to the reception of a CCM
3214 frame having an invalid interval.
3217 <column name=
"cfm_remote_opstate">
3218 <p>When in extended mode, indicates the operational state of the
3219 remote endpoint as either
<code>up
</code> or
<code>down
</code>. See
3220 <ref column=
"other_config" key=
"cfm_opstate"/>.
3224 <column name=
"cfm_health">
3226 Indicates the health of the interface as a percentage of CCM frames
3227 received over
21 <ref column=
"other_config" key=
"cfm_interval"/>s.
3228 The health of an interface is undefined if it is communicating with
3229 more than one
<ref column=
"cfm_remote_mpids"/>. It reduces if
3230 healthy heartbeats are not received at the expected rate, and
3231 gradually improves as healthy heartbeats are received at the desired
3232 rate. Every
21 <ref column=
"other_config" key=
"cfm_interval"/>s, the
3233 health of the interface is refreshed.
3236 As mentioned above, the faults can be triggered for several reasons.
3237 The link health will deteriorate even if heartbeats are received but
3238 they are reported to be unhealthy. An unhealthy heartbeat in this
3239 context is a heartbeat for which either some fault is set or is out
3240 of sequence. The interface health can be
100 only on receiving
3241 healthy heartbeats at the desired rate.
3245 <column name=
"cfm_remote_mpids">
3246 When CFM is properly configured, Open vSwitch will occasionally
3247 receive CCM broadcasts. These broadcasts contain the MPID of the
3248 sending Maintenance Point. The list of MPIDs from which this
3249 <ref table=
"Interface"/> is receiving broadcasts from is regularly
3250 collected and written to this column.
3253 <column name=
"other_config" key=
"cfm_interval"
3254 type='{
"type":
"integer"}'
>
3256 The interval, in milliseconds, between transmissions of CFM
3257 heartbeats. Three missed heartbeat receptions indicate a
3262 In standard operation only intervals of
3,
10,
100,
1,
000,
10,
000,
3263 60,
000, or
600,
000 ms are supported. Other values will be rounded
3264 down to the nearest value on the list. Extended mode (see
<ref
3265 column=
"other_config" key=
"cfm_extended"/>) supports any interval up
3266 to
65,
535 ms. In either mode, the default is
1000 ms.
3269 <p>We do not recommend using intervals less than
100 ms.
</p>
3272 <column name=
"other_config" key=
"cfm_extended"
3273 type='{
"type":
"boolean"}'
>
3274 When
<code>true
</code>, the CFM module operates in extended mode. This
3275 causes it to use a nonstandard destination address to avoid conflicting
3276 with compliant implementations which may be running concurrently on the
3277 network. Furthermore, extended mode increases the accuracy of the
3278 <code>cfm_interval
</code> configuration parameter by breaking wire
3279 compatibility with
802.1ag compliant implementations. And extended
3280 mode allows eight byte MPIDs. Defaults to
<code>false
</code>.
3283 <column name=
"other_config" key=
"cfm_demand" type='{
"type":
"boolean"}'
>
3285 When
<code>true
</code>, and
3286 <ref column=
"other_config" key=
"cfm_extended"/> is true, the CFM
3287 module operates in demand mode. When in demand mode, traffic
3288 received on the
<ref table=
"Interface"/> is used to indicate
3289 liveness. CCMs are still transmitted and received. At least one
3290 CCM must be received every
100 *
<ref column=
"other_config"
3291 key=
"cfm_interval"/> amount of time. Otherwise, even if traffic
3292 are received, the CFM module will raise the connectivity fault.
3296 Demand mode has a couple of caveats:
3299 To ensure that ovs-vswitchd has enough time to pull statistics
3300 from the datapath, the fault detection interval is set to
3301 3.5 * MAX(
<ref column=
"other_config" key=
"cfm_interval"/>,
500)
3306 To avoid ambiguity, demand mode disables itself when there are
3307 multiple remote maintenance points.
3311 If the
<ref table=
"Interface"/> is heavily congested, CCMs
3312 containing the
<ref column=
"other_config" key=
"cfm_opstate"/>
3313 status may be dropped causing changes in the operational state to
3314 be delayed. Similarly, if CCMs containing the RDI bit are not
3315 received, unidirectional link failures may not be detected.
3321 <column name=
"other_config" key=
"cfm_opstate"
3322 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
3323 When
<code>down
</code>, the CFM module marks all CCMs it generates as
3324 operationally down without triggering a fault. This allows remote
3325 maintenance points to choose not to forward traffic to the
3326 <ref table=
"Interface"/> on which this CFM module is running.
3327 Currently, in Open vSwitch, the opdown bit of CCMs affects
3328 <ref table=
"Interface"/>s participating in bonds, and the bundle
3329 OpenFlow action. This setting is ignored when CFM is not in extended
3330 mode. Defaults to
<code>up
</code>.
3333 <column name=
"other_config" key=
"cfm_ccm_vlan"
3334 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
3335 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3336 with the given value. May be the string
<code>random
</code> in which
3337 case each CCM will be tagged with a different randomly generated VLAN.
3340 <column name=
"other_config" key=
"cfm_ccm_pcp"
3341 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
7}'
>
3342 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3343 with the given PCP value, the VLAN ID of the tag is governed by the
3344 value of
<ref column=
"other_config" key=
"cfm_ccm_vlan"/>. If
3345 <ref column=
"other_config" key=
"cfm_ccm_vlan"/> is unset, a VLAN ID of
3351 <group title=
"Bonding Configuration">
3352 <column name=
"other_config" key=
"lacp-port-id"
3353 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3354 The LACP port ID of this
<ref table=
"Interface"/>. Port IDs are
3355 used in LACP negotiations to identify individual ports
3356 participating in a bond.
3359 <column name=
"other_config" key=
"lacp-port-priority"
3360 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3361 The LACP port priority of this
<ref table=
"Interface"/>. In LACP
3362 negotiations
<ref table=
"Interface"/>s with numerically lower
3363 priorities are preferred for aggregation.
3366 <column name=
"other_config" key=
"lacp-aggregation-key"
3367 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3368 The LACP aggregation key of this
<ref table=
"Interface"/>.
<ref
3369 table=
"Interface"/>s with different aggregation keys may not be active
3370 within a given
<ref table=
"Port"/> at the same time.
3374 <group title=
"Virtual Machine Identifiers">
3376 These key-value pairs specifically apply to an interface that
3377 represents a virtual Ethernet interface connected to a virtual
3378 machine. These key-value pairs should not be present for other types
3379 of interfaces. Keys whose names end in
<code>-uuid
</code> have
3380 values that uniquely identify the entity in question. For a Citrix
3381 XenServer hypervisor, these values are UUIDs in RFC
4122 format.
3382 Other hypervisors may use other formats.
3385 <column name=
"external_ids" key=
"attached-mac">
3386 The MAC address programmed into the ``virtual hardware'' for this
3387 interface, in the form
3388 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
3389 For Citrix XenServer, this is the value of the
<code>MAC
</code> field
3390 in the VIF record for this interface.
3393 <column name=
"external_ids" key=
"iface-id">
3394 A system-unique identifier for the interface. On XenServer, this will
3395 commonly be the same as
<ref column=
"external_ids" key=
"xs-vif-uuid"/>.
3398 <column name=
"external_ids" key=
"iface-status"
3399 type='{
"type":
"string",
3400 "enum": [
"set", [
"active",
"inactive"]]}'
>
3402 Hypervisors may sometimes have more than one interface associated
3403 with a given
<ref column=
"external_ids" key=
"iface-id"/>, only one of
3404 which is actually in use at a given time. For example, in some
3405 circumstances XenServer has both a ``tap'' and a ``vif'' interface
3406 for a single
<ref column=
"external_ids" key=
"iface-id"/>, but only
3407 uses one of them at a time. A hypervisor that behaves this way must
3408 mark the currently in use interface
<code>active
</code> and the
3409 others
<code>inactive
</code>. A hypervisor that never has more than
3410 one interface for a given
<ref column=
"external_ids" key=
"iface-id"/>
3411 may mark that interface
<code>active
</code> or omit
<ref
3412 column=
"external_ids" key=
"iface-status"/> entirely.
3416 During VM migration, a given
<ref column=
"external_ids"
3417 key=
"iface-id"/> might transiently be marked
<code>active
</code> on
3418 two different hypervisors. That is,
<code>active
</code> means that
3419 this
<ref column=
"external_ids" key=
"iface-id"/> is the active
3420 instance within a single hypervisor, not in a broader scope.
3421 There is one exception: some hypervisors support ``migration'' from a
3422 given hypervisor to itself (most often for test purposes). During
3423 such a ``migration,'' two instances of a single
<ref
3424 column=
"external_ids" key=
"iface-id"/> might both be briefly marked
3425 <code>active
</code> on a single hypervisor.
3429 <column name=
"external_ids" key=
"xs-vif-uuid">
3430 The virtual interface associated with this interface.
3433 <column name=
"external_ids" key=
"xs-network-uuid">
3434 The virtual network to which this interface is attached.
3437 <column name=
"external_ids" key=
"vm-id">
3438 The VM to which this interface belongs. On XenServer, this will be the
3439 same as
<ref column=
"external_ids" key=
"xs-vm-uuid"/>.
3442 <column name=
"external_ids" key=
"xs-vm-uuid">
3443 The VM to which this interface belongs.
3447 <group title=
"Auto Attach Configuration">
3449 Auto Attach configuration for a particular interface.
3452 <column name=
"lldp" key=
"enable" type='{
"type":
"boolean"}'
>
3453 True to enable LLDP on this
<ref table=
"Interface"/>. If not
3454 specified, LLDP will be disabled by default.
3458 <group title=
"Flow control Configuration">
3460 Ethernet flow control defined in IEEE
802.1Qbb provides link level flow
3461 control using MAC pause frames. Implemented only for interfaces with
3462 type
<code>dpdk
</code>.
3465 <column name=
"options" key=
"rx-flow-ctrl" type='{
"type":
"boolean"}'
>
3466 Set to
<code>true
</code> to enable Rx flow control on physical ports.
3467 By default, Rx flow control is disabled.
3470 <column name=
"options" key=
"tx-flow-ctrl" type='{
"type":
"boolean"}'
>
3471 Set to
<code>true
</code> to enable Tx flow control on physical ports.
3472 By default, Tx flow control is disabled.
3475 <column name=
"options" key=
"flow-ctrl-autoneg"
3476 type='{
"type":
"boolean"}'
>
3477 Set to
<code>true
</code> to enable flow control auto negotiation on
3478 physical ports. By default, auto-neg is disabled.
3482 <group title=
"Common Columns">
3483 The overall purpose of these columns is described under
<code>Common
3484 Columns
</code> at the beginning of this document.
3486 <column name=
"other_config"/>
3487 <column name=
"external_ids"/>
3491 <table name=
"Flow_Table" title=
"OpenFlow table configuration">
3492 <p>Configuration for a particular OpenFlow table.
</p>
3494 <column name=
"name">
3495 The table's name. Set this column to change the name that controllers
3496 will receive when they request table statistics, e.g.
<code>ovs-ofctl
3497 dump-tables
</code>. The name does not affect switch behavior.
3500 <group title=
"Eviction Policy">
3502 Open vSwitch supports limiting the number of flows that may be
3503 installed in a flow table, via the
<ref column=
"flow_limit"/> column.
3504 When adding a flow would exceed this limit, by default Open vSwitch
3505 reports an error, but there are two ways to configure Open vSwitch to
3506 instead delete (``evict'') a flow to make room for the new one:
3511 Set the
<ref column=
"overflow_policy"/> column to
<code>evict
</code>.
3515 Send an OpenFlow
1.4+ ``table mod request'' to enable eviction for
3516 the flow table (e.g.
<code>ovs-ofctl -O OpenFlow14 mod-table br0
0
3517 evict
</code> to enable eviction on flow table
0 of bridge
3523 When a flow must be evicted due to overflow, the flow to evict is
3524 chosen through an approximation of the following algorithm. This
3525 algorithm is used regardless of how eviction was enabled:
3530 Divide the flows in the table into groups based on the values of the
3531 fields or subfields specified in the
<ref column=
"groups"/> column,
3532 so that all of the flows in a given group have the same values for
3533 those fields. If a flow does not specify a given field, that field's
3534 value is treated as
0. If
<ref column=
"groups"/> is empty, then all
3535 of the flows in the flow table are treated as a single group.
3539 Consider the flows in the largest group, that is, the group that
3540 contains the greatest number of flows. If two or more groups all
3541 have the same largest number of flows, consider the flows in all of
3546 If the flows under consideration have different importance values,
3547 eliminate from consideration any flows except those with the lowest
3548 importance. (``Importance,'' a
16-bit integer value attached to each
3549 flow, was introduced in OpenFlow
1.4. Flows inserted with older
3550 versions of OpenFlow always have an importance of
0.)
3554 Among the flows under consideration, choose the flow that expires
3555 soonest for eviction.
3560 The eviction process only considers flows that have an idle timeout
3561 or a hard timeout. That is, eviction never deletes permanent flows.
3562 (Permanent flows do count against
<ref column=
"flow_limit"/>.)
3565 <column name=
"flow_limit">
3566 If set, limits the number of flows that may be added to the table.
3567 Open vSwitch may limit the number of flows in a table for other
3568 reasons, e.g. due to hardware limitations or for resource availability
3569 or performance reasons.
3572 <column name=
"overflow_policy">
3574 Controls the switch's behavior when an OpenFlow flow table
3575 modification request would add flows in excess of
<ref
3576 column=
"flow_limit"/>. The supported values are:
3580 <dt><code>refuse
</code></dt>
3582 Refuse to add the flow or flows. This is also the default policy
3583 when
<ref column=
"overflow_policy"/> is unset.
3586 <dt><code>evict
</code></dt>
3588 Delete a flow chosen according to the algorithm described above.
3593 <column name=
"groups">
3595 When
<ref column=
"overflow_policy"/> is
<code>evict
</code>, this
3596 controls how flows are chosen for eviction when the flow table would
3597 otherwise exceed
<ref column=
"flow_limit"/> flows. Its value is a
3598 set of NXM fields or sub-fields, each of which takes one of the forms
3599 <code><var>field
</var>[]
</code> or
3600 <code><var>field
</var>[
<var>start
</var>..
<var>end
</var>]
</code>,
3601 e.g.
<code>NXM_OF_IN_PORT[]
</code>. Please see
3602 <code>meta-flow.h
</code> for a complete list of NXM field names.
3606 Open vSwitch ignores any invalid or unknown field specifications.
3610 When eviction is not enabled, via
<ref column=
"overflow_policy"/> or
3611 an OpenFlow
1.4+ ``table mod,'' this column has no effect.
3616 <group title=
"Classifier Optimization">
3617 <column name=
"prefixes">
3619 This string set specifies which fields should be used for
3620 address prefix tracking. Prefix tracking allows the
3621 classifier to skip rules with longer than necessary prefixes,
3622 resulting in better wildcarding for datapath flows.
3625 Prefix tracking may be beneficial when a flow table contains
3626 matches on IP address fields with different prefix lengths.
3627 For example, when a flow table contains IP address matches on
3628 both full addresses and proper prefixes, the full address
3629 matches will typically cause the datapath flow to un-wildcard
3630 the whole address field (depending on flow entry priorities).
3631 In this case each packet with a different address gets handed
3632 to the userspace for flow processing and generates its own
3633 datapath flow. With prefix tracking enabled for the address
3634 field in question packets with addresses matching shorter
3635 prefixes would generate datapath flows where the irrelevant
3636 address bits are wildcarded, allowing the same datapath flow
3637 to handle all the packets within the prefix in question. In
3638 this case many userspace upcalls can be avoided and the
3639 overall performance can be better.
3642 This is a performance optimization only, so packets will
3643 receive the same treatment with or without prefix tracking.
3646 The supported fields are:
<code>tun_id
</code>,
3647 <code>tun_src
</code>,
<code>tun_dst
</code>,
3648 <code>tun_ipv6_src
</code>,
<code>tun_ipv6_dst
</code>,
3649 <code>nw_src
</code>,
<code>nw_dst
</code> (or aliases
3650 <code>ip_src
</code> and
<code>ip_dst
</code>),
3651 <code>ipv6_src
</code>, and
<code>ipv6_dst
</code>. (Using this
3652 feature for
<code>tun_id
</code> would only make sense if the
3653 tunnel IDs have prefix structure similar to IP addresses.)
3657 By default, the
<code>prefixes=ip_dst,ip_src
</code> are used
3658 on each flow table. This instructs the flow classifier to
3659 track the IP destination and source addresses used by the
3660 rules in this specific flow table.
3664 The keyword
<code>none
</code> is recognized as an explicit
3665 override of the default values, causing no prefix fields to be
3670 To set the prefix fields, the flow table record needs to
3675 <dt><code>ovs-vsctl set Bridge br0 flow_tables:
0=@N1 -- --id=@N1 create Flow_Table name=table0
</code></dt>
3677 Creates a flow table record for the OpenFlow table number
0.
3680 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src
</code></dt>
3682 Enables prefix tracking for IP source and destination
3688 There is a maximum number of fields that can be enabled for any
3689 one flow table. Currently this limit is
3.
3694 <group title=
"Common Columns">
3695 The overall purpose of these columns is described under
<code>Common
3696 Columns
</code> at the beginning of this document.
3698 <column name=
"external_ids"/>
3702 <table name=
"QoS" title=
"Quality of Service configuration">
3703 <p>Quality of Service (QoS) configuration for each Port that
3706 <column name=
"type">
3707 <p>The type of QoS to implement. The currently defined types are
3710 <dt><code>linux-htb
</code></dt>
3712 Linux ``hierarchy token bucket'' classifier. See tc-htb(
8) (also at
3713 <code>http://linux.die.net/man/
8/tc-htb
</code>) and the HTB manual
3714 (
<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm
</code>)
3715 for information on how this classifier works and how to configure it.
3718 <dt><code>linux-hfsc
</code></dt>
3720 Linux
"Hierarchical Fair Service Curve" classifier.
3721 See
<code>http://linux-ip.net/articles/hfsc.en/
</code> for
3722 information on how this classifier works.
3725 <dt><code>linux-sfq
</code></dt>
3727 Linux ``Stochastic Fairness Queueing'' classifier. See
3728 <code>tc-sfq
</code>(
8) (also at
3729 <code>http://linux.die.net/man/
8/tc-sfq
</code>) for information on
3730 how this classifier works.
3733 <dt><code>linux-codel
</code></dt>
3735 Linux ``Controlled Delay'' classifier. See
<code>tc-codel
</code>(
8)
3737 <code>http://man7.org/linux/man-pages/man8/tc-codel
.8.html
</code>)
3738 for information on how this classifier works.
3741 <dt><code>linux-fq_codel
</code></dt>
3743 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3744 <code>tc-fq_codel
</code>(
8) (also at
3745 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel
.8.html
</code>)
3746 for information on how this classifier works.
3749 <dt><code>linux-noop
</code></dt>
3751 Linux ``No operation.'' By default, Open vSwitch manages quality of
3752 service on all of its configured ports. This can be helpful, but
3753 sometimes administrators prefer to use other software to manage QoS.
3754 This
<ref column=
"type"/> prevents Open vSwitch from changing the QoS
3755 configuration for a port.
3758 <dt><code>egress-policer
</code></dt>
3760 A DPDK egress policer algorithm using the DPDK
3761 rte_meter library. The rte_meter library provides an implementation
3762 which allows the metering and policing of traffic. The implementation
3763 in OVS essentially creates a single token bucket used to police
3764 traffic. It should be noted that when the rte_meter is configured as
3765 part of QoS there will be a performance overhead as the rte_meter
3766 itself will consume CPU cycles in order to police traffic. These CPU
3767 cycles ordinarily are used for packet proccessing. As such the drop
3768 in performance will be noticed in terms of overall aggregate traffic
3774 <column name=
"queues">
3775 <p>A map from queue numbers to
<ref table=
"Queue"/> records. The
3776 supported range of queue numbers depend on
<ref column=
"type"/>. The
3777 queue numbers are the same as the
<code>queue_id
</code> used in
3778 OpenFlow in
<code>struct ofp_action_enqueue
</code> and other
3782 Queue
0 is the ``default queue.'' It is used by OpenFlow output
3783 actions when no specific queue has been set. When no configuration for
3784 queue
0 is present, it is automatically configured as if a
<ref
3785 table=
"Queue"/> record with empty
<ref table=
"Queue" column=
"dscp"/>
3786 and
<ref table=
"Queue" column=
"other_config"/> columns had been
3788 (Before version
1.6, Open vSwitch would leave queue
0 unconfigured in
3789 this case. With some queuing disciplines, this dropped all packets
3790 destined for the default queue.)
3794 <group title=
"Configuration for linux-htb and linux-hfsc">
3796 The
<code>linux-htb
</code> and
<code>linux-hfsc
</code> classes support
3797 the following key-value pair:
3800 <column name=
"other_config" key=
"max-rate" type='{
"type":
"integer"}'
>
3801 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3802 specified, for physical interfaces, the default is the link rate. For
3803 other interfaces or if the link rate cannot be determined, the default
3804 is currently
100 Mbps.
3808 <group title=
"Configuration for egress-policer QoS">
3810 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3811 <code>egress-policer
</code> provides egress policing for userspace
3812 port types with DPDK.
3814 It has the following key-value pairs defined.
3817 <column name=
"other_config" key=
"cir" type='{
"type":
"integer"}'
>
3818 The Committed Information Rate (CIR) is measured in bytes of IP
3819 packets per second, i.e. it includes the IP header, but not link
3820 specific (e.g. Ethernet) headers. This represents the bytes per second
3821 rate at which the token bucket will be updated. The cir value is
3822 calculated by (pps x packet data size). For example assuming a user
3823 wishes to limit a stream consisting of
64 byte packets to
1 million
3824 packets per second the CIR would be set to to to
46000000. This value
3825 can be broken into '
1,
000,
000 x
46'. Where
1,
000,
000 is the policing
3826 rate for the number of packets per second and
46 represents the size
3827 of the packet data for a
64 byte ip packet.
3829 <column name=
"other_config" key=
"cbs" type='{
"type":
"integer"}'
>
3830 The Committed Burst Size (CBS) is measured in bytes and represents a
3831 token bucket. At a minimum this value should be be set to the expected
3832 largest size packet in the traffic stream. In practice larger values
3833 may be used to increase the size of the token bucket. If a packet can
3834 be transmitted then the cbs will be decremented by the number of
3835 bytes/tokens of the packet. If there are not enough tokens in the cbs
3836 bucket the packet will be dropped.
3840 <group title=
"Common Columns">
3841 The overall purpose of these columns is described under
<code>Common
3842 Columns
</code> at the beginning of this document.
3844 <column name=
"other_config"/>
3845 <column name=
"external_ids"/>
3849 <table name=
"Queue" title=
"QoS output queue.">
3850 <p>A configuration for a port output queue, used in configuring Quality of
3851 Service (QoS) features. May be referenced by
<ref column=
"queues"
3852 table=
"QoS"/> column in
<ref table=
"QoS"/> table.
</p>
3854 <column name=
"dscp">
3855 If set, Open vSwitch will mark all traffic egressing this
3856 <ref table=
"Queue"/> with the given DSCP bits. Traffic egressing the
3857 default
<ref table=
"Queue"/> is only marked if it was explicitly selected
3858 as the
<ref table=
"Queue"/> at the time the packet was output. If unset,
3859 the DSCP bits of traffic egressing this
<ref table=
"Queue"/> will remain
3863 <group title=
"Configuration for linux-htb QoS">
3865 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3866 <code>linux-htb
</code> may use
<code>queue_id
</code>s less than
61440.
3867 It has the following key-value pairs defined.
3870 <column name=
"other_config" key=
"min-rate"
3871 type='{
"type":
"integer",
"minInteger":
1}'
>
3872 Minimum guaranteed bandwidth, in bit/s.
3875 <column name=
"other_config" key=
"max-rate"
3876 type='{
"type":
"integer",
"minInteger":
1}'
>
3877 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3878 queue's rate will not be allowed to exceed the specified value, even
3879 if excess bandwidth is available. If unspecified, defaults to no
3883 <column name=
"other_config" key=
"burst"
3884 type='{
"type":
"integer",
"minInteger":
1}'
>
3885 Burst size, in bits. This is the maximum amount of ``credits'' that a
3886 queue can accumulate while it is idle. Optional. Details of the
3887 <code>linux-htb
</code> implementation require a minimum burst size, so
3888 a too-small
<code>burst
</code> will be silently ignored.
3891 <column name=
"other_config" key=
"priority"
3892 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
3893 A queue with a smaller
<code>priority
</code> will receive all the
3894 excess bandwidth that it can use before a queue with a larger value
3895 receives any. Specific priority values are unimportant; only relative
3896 ordering matters. Defaults to
0 if unspecified.
3900 <group title=
"Configuration for linux-hfsc QoS">
3902 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3903 <code>linux-hfsc
</code> may use
<code>queue_id
</code>s less than
61440.
3904 It has the following key-value pairs defined.
3907 <column name=
"other_config" key=
"min-rate"
3908 type='{
"type":
"integer",
"minInteger":
1}'
>
3909 Minimum guaranteed bandwidth, in bit/s.
3912 <column name=
"other_config" key=
"max-rate"
3913 type='{
"type":
"integer",
"minInteger":
1}'
>
3914 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3915 queue's rate will not be allowed to exceed the specified value, even if
3916 excess bandwidth is available. If unspecified, defaults to no
3921 <group title=
"Common Columns">
3922 The overall purpose of these columns is described under
<code>Common
3923 Columns
</code> at the beginning of this document.
3925 <column name=
"other_config"/>
3926 <column name=
"external_ids"/>
3930 <table name=
"Mirror" title=
"Port mirroring.">
3931 <p>A port mirror within a
<ref table=
"Bridge"/>.
</p>
3932 <p>A port mirror configures a bridge to send selected frames to special
3933 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3934 traffic may also be referred to as SPAN or RSPAN, depending on how
3935 the mirrored traffic is sent.
</p>
3938 When a packet enters an Open vSwitch bridge, it becomes eligible for
3939 mirroring based on its ingress port and VLAN. As the packet travels
3940 through the flow tables, each time it is output to a port, it becomes
3941 eligible for mirroring based on the egress port and VLAN. In Open
3942 vSwitch
2.5 and later, mirroring occurs just after a packet first becomes
3943 eligible, using the packet as it exists at that point; in Open vSwitch
3944 2.4 and earlier, mirroring occurs only after a packet has traversed all
3945 the flow tables, using the original packet as it entered the bridge.
3946 This makes a difference only when the flow table modifies the packet: in
3947 Open vSwitch
2.4, the modifications are never visible to mirrors, whereas
3948 in Open vSwitch
2.5 and later modifications made before the first output
3949 that makes it eligible for mirroring to a particular destination are
3954 A packet that enters an Open vSwitch bridge is mirrored to a particular
3955 destination only once, even if it is eligible for multiple reasons. For
3956 example, a packet would be mirrored to a particular
<ref
3957 column=
"output_port"/> only once, even if it is selected for mirroring to
3958 that port by
<ref column=
"select_dst_port"/> and
<ref
3959 column=
"select_src_port"/> in the same or different
<ref table=
"Mirror"/>
3963 <column name=
"name">
3964 Arbitrary identifier for the
<ref table=
"Mirror"/>.
3967 <group title=
"Selecting Packets for Mirroring">
3969 To be selected for mirroring, a given packet must enter or leave the
3970 bridge through a selected port and it must also be in one of the
3974 <column name=
"select_all">
3975 If true, every packet arriving or departing on any port is
3976 selected for mirroring.
3979 <column name=
"select_dst_port">
3980 Ports on which departing packets are selected for mirroring.
3983 <column name=
"select_src_port">
3984 Ports on which arriving packets are selected for mirroring.
3987 <column name=
"select_vlan">
3988 VLANs on which packets are selected for mirroring. An empty set
3989 selects packets on all VLANs.
3993 <group title=
"Mirroring Destination Configuration">
3995 These columns are mutually exclusive. Exactly one of them must be
3999 <column name=
"output_port">
4000 <p>Output port for selected packets, if nonempty.
</p>
4001 <p>Specifying a port for mirror output reserves that port exclusively
4002 for mirroring. No frames other than those selected for mirroring
4004 will be forwarded to the port, and any frames received on the port
4005 will be discarded.
</p>
4007 The output port may be any kind of port supported by Open vSwitch.
4008 It may be, for example, a physical port (sometimes called SPAN) or a
4013 <column name=
"output_vlan">
4014 <p>Output VLAN for selected packets, if nonempty.
</p>
4015 <p>The frames will be sent out all ports that trunk
4016 <ref column=
"output_vlan"/>, as well as any ports with implicit VLAN
4017 <ref column=
"output_vlan"/>. When a mirrored frame is sent out a
4018 trunk port, the frame's VLAN tag will be set to
4019 <ref column=
"output_vlan"/>, replacing any existing tag; when it is
4020 sent out an implicit VLAN port, the frame will not be tagged. This
4021 type of mirroring is sometimes called RSPAN.
</p>
4023 See the documentation for
4024 <ref column=
"other_config" key=
"forward-bpdu"/> in the
4025 <ref table=
"Interface"/> table for a list of destination MAC
4026 addresses which will not be mirrored to a VLAN to avoid confusing
4027 switches that interpret the protocols that they represent.
4029 <p><em>Please note:
</em> Mirroring to a VLAN can disrupt a network that
4030 contains unmanaged switches. Consider an unmanaged physical switch
4031 with two ports: port
1, connected to an end host, and port
2,
4032 connected to an Open vSwitch configured to mirror received packets
4033 into VLAN
123 on port
2. Suppose that the end host sends a packet on
4034 port
1 that the physical switch forwards to port
2. The Open vSwitch
4035 forwards this packet to its destination and then reflects it back on
4036 port
2 in VLAN
123. This reflected packet causes the unmanaged
4037 physical switch to replace the MAC learning table entry, which
4038 correctly pointed to port
1, with one that incorrectly points to port
4039 2. Afterward, the physical switch will direct packets destined for
4040 the end host to the Open vSwitch on port
2, instead of to the end
4041 host on port
1, disrupting connectivity. If mirroring to a VLAN is
4042 desired in this scenario, then the physical switch must be replaced
4043 by one that learns Ethernet addresses on a per-VLAN basis. In
4044 addition, learning should be disabled on the VLAN containing mirrored
4045 traffic. If this is not done then intermediate switches will learn
4046 the MAC address of each end host from the mirrored traffic. If
4047 packets being sent to that end host are also mirrored, then they will
4048 be dropped since the switch will attempt to send them out the input
4049 port. Disabling learning for the VLAN will cause the switch to
4050 correctly send the packet out all ports configured for that VLAN. If
4051 Open vSwitch is being used as an intermediate switch, learning can be
4052 disabled by adding the mirrored VLAN to
<ref column=
"flood_vlans"/>
4053 in the appropriate
<ref table=
"Bridge"/> table or tables.
</p>
4055 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
4056 VLAN and should generally be preferred.
4060 <column name=
"snaplen">
4061 <p>Maximum per-packet number of bytes to mirror.
</p>
4062 <p>A mirrored packet with size larger than
<ref column=
"snaplen"/>
4063 will be truncated in datapath to
<ref column=
"snaplen"/> bytes
4064 before sending to the mirror output port. If omitted, packets
4070 <group title=
"Statistics: Mirror counters">
4072 Key-value pairs that report mirror statistics. The update period
4073 is controlled by
<ref column=
"other_config"
4074 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
4076 <column name=
"statistics" key=
"tx_packets">
4077 Number of packets transmitted through this mirror.
4079 <column name=
"statistics" key=
"tx_bytes">
4080 Number of bytes transmitted through this mirror.
4084 <group title=
"Common Columns">
4085 The overall purpose of these columns is described under
<code>Common
4086 Columns
</code> at the beginning of this document.
4088 <column name=
"external_ids"/>
4092 <table name=
"Controller" title=
"OpenFlow controller configuration.">
4093 <p>An OpenFlow controller.
</p>
4096 Open vSwitch supports two kinds of OpenFlow controllers:
4100 <dt>Primary controllers
</dt>
4103 This is the kind of controller envisioned by the OpenFlow
1.0
4104 specification. Usually, a primary controller implements a network
4105 policy by taking charge of the switch's flow table.
4109 Open vSwitch initiates and maintains persistent connections to
4110 primary controllers, retrying the connection each time it fails or
4111 drops. The
<ref table=
"Bridge" column=
"fail_mode"/> column in the
4112 <ref table=
"Bridge"/> table applies to primary controllers.
4116 Open vSwitch permits a bridge to have any number of primary
4117 controllers. When multiple controllers are configured, Open
4118 vSwitch connects to all of them simultaneously. Because
4119 OpenFlow
1.0 does not specify how multiple controllers
4120 coordinate in interacting with a single switch, more than
4121 one primary controller should be specified only if the
4122 controllers are themselves designed to coordinate with each
4123 other. (The Nicira-defined
<code>NXT_ROLE
</code> OpenFlow
4124 vendor extension may be useful for this.)
4127 <dt>Service controllers
</dt>
4130 These kinds of OpenFlow controller connections are intended for
4131 occasional support and maintenance use, e.g. with
4132 <code>ovs-ofctl
</code>. Usually a service controller connects only
4133 briefly to inspect or modify some of a switch's state.
4137 Open vSwitch listens for incoming connections from service
4138 controllers. The service controllers initiate and, if necessary,
4139 maintain the connections from their end. The
<ref table=
"Bridge"
4140 column=
"fail_mode"/> column in the
<ref table=
"Bridge"/> table does
4141 not apply to service controllers.
4145 Open vSwitch supports configuring any number of service controllers.
4151 The
<ref column=
"target"/> determines the type of controller.
4154 <group title=
"Core Features">
4155 <column name=
"target">
4156 <p>Connection method for controller.
</p>
4158 The following connection methods are currently supported for primary
4162 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4164 <p>The specified SSL
<var>port
</var> on the host at the
4165 given
<var>ip
</var>, which must be expressed as an IP
4166 address (not a DNS name). The
<ref table=
"Open_vSwitch"
4167 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
4168 table must point to a valid SSL configuration when this form
4170 <p>If
<var>port
</var> is not specified, it defaults to
6653.
</p>
4171 <p>SSL support is an optional feature that is not always built as
4172 part of Open vSwitch.
</p>
4174 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4177 The specified TCP
<var>port
</var> on the host at the given
4178 <var>ip
</var>, which must be expressed as an IP address (not a
4179 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
4180 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4181 e.g.
<code>tcp:[::
1]:
6653</code>.
4184 If
<var>port
</var> is not specified, it defaults to
6653.
4189 The following connection methods are currently supported for service
4193 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4196 Listens for SSL connections on the specified TCP
<var>port
</var>.
4197 If
<var>ip
</var>, which must be expressed as an IP address (not a
4198 DNS name), is specified, then connections are restricted to the
4199 specified local IP address (either IPv4 or IPv6). If
4200 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4201 e.g.
<code>pssl:
6653:[::
1]
</code>.
4204 If
<var>port
</var> is not specified, it defaults to
4205 6653. If
<var>ip
</var> is not specified then it listens only on
4206 IPv4 (but not IPv6) addresses. The
4207 <ref table=
"Open_vSwitch" column=
"ssl"/>
4208 column in the
<ref table=
"Open_vSwitch"/> table must point to a
4209 valid SSL configuration when this form is used.
4212 If
<var>port
</var> is not specified, it currently to
6653.
4215 SSL support is an optional feature that is not always built as
4216 part of Open vSwitch.
4219 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4222 Listens for connections on the specified TCP
<var>port
</var>. If
4223 <var>ip
</var>, which must be expressed as an IP address (not a
4224 DNS name), is specified, then connections are restricted to the
4225 specified local IP address (either IPv4 or IPv6). If
4226 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4227 e.g.
<code>ptcp:
6653:[::
1]
</code>. If
<var>ip
</var> is not
4228 specified then it listens only on IPv4 addresses.
4231 If
<var>port
</var> is not specified, it defaults to
6653.
4235 <p>When multiple controllers are configured for a single bridge, the
4236 <ref column=
"target"/> values must be unique. Duplicate
4237 <ref column=
"target"/> values yield unspecified results.
</p>
4240 <column name=
"connection_mode">
4241 <p>If it is specified, this setting must be one of the following
4242 strings that describes how Open vSwitch contacts this OpenFlow
4243 controller over the network:
</p>
4246 <dt><code>in-band
</code></dt>
4247 <dd>In this mode, this controller's OpenFlow traffic travels over the
4248 bridge associated with the controller. With this setting, Open
4249 vSwitch allows traffic to and from the controller regardless of the
4250 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
4251 would never be able to connect to the controller, because it did
4252 not have a flow to enable it.) This is the most common connection
4253 mode because it is not necessary to maintain two independent
4255 <dt><code>out-of-band
</code></dt>
4256 <dd>In this mode, OpenFlow traffic uses a control network separate
4257 from the bridge associated with this controller, that is, the
4258 bridge does not use any of its own network devices to communicate
4259 with the controller. The control network must be configured
4260 separately, before or after
<code>ovs-vswitchd
</code> is started.
4264 <p>If not specified, the default is implementation-specific.
</p>
4268 <group title=
"Controller Failure Detection and Handling">
4269 <column name=
"max_backoff">
4270 Maximum number of milliseconds to wait between connection attempts.
4271 Default is implementation-specific.
4274 <column name=
"inactivity_probe">
4275 Maximum number of milliseconds of idle time on connection to
4276 controller before sending an inactivity probe message. If Open
4277 vSwitch does not communicate with the controller for the specified
4278 number of seconds, it will send a probe. If a response is not
4279 received for the same additional amount of time, Open vSwitch
4280 assumes the connection has been broken and attempts to reconnect.
4281 Default is implementation-specific. A value of
0 disables
4286 <group title=
"Asynchronous Messages">
4288 OpenFlow switches send certain messages to controllers spontanenously,
4289 that is, not in response to any request from the controller. These
4290 messages are called ``asynchronous messages.'' These columns allow
4291 asynchronous messages to be limited or disabled to ensure the best use
4292 of network resources.
4295 <column name=
"enable_async_messages">
4296 The OpenFlow protocol enables asynchronous messages at time of
4297 connection establishment, which means that a controller can receive
4298 asynchronous messages, potentially many of them, even if it turns them
4299 off immediately after connecting. Set this column to
4300 <code>false
</code> to change Open vSwitch behavior to disable, by
4301 default, all asynchronous messages. The controller can use the
4302 <code>NXT_SET_ASYNC_CONFIG
</code> Nicira extension to OpenFlow to turn
4303 on any messages that it does want to receive, if any.
4306 <group title=
"Controller Rate Limiting">
4308 A switch can forward packets to a controller over the OpenFlow
4309 protocol. Forwarding packets this way at too high a rate can
4310 overwhelm a controller, frustrate use of the OpenFlow connection for
4311 other purposes, increase the latency of flow setup, and use an
4312 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
4313 limiting the rate of packet forwarding to a controller.
4317 There are two main reasons in OpenFlow for a packet to be sent to a
4318 controller: either the packet ``misses'' in the flow table, that is,
4319 there is no matching flow, or a flow table action says to send the
4320 packet to the controller. Open vSwitch limits the rate of each kind
4321 of packet separately at the configured rate. Therefore, the actual
4322 rate that packets are sent to the controller can be up to twice the
4323 configured rate, when packets are sent for both reasons.
4327 This feature is specific to forwarding packets over an OpenFlow
4328 connection. It is not general-purpose QoS. See the
<ref
4329 table=
"QoS"/> table for quality of service configuration, and
<ref
4330 column=
"ingress_policing_rate" table=
"Interface"/> in the
<ref
4331 table=
"Interface"/> table for ingress policing configuration.
4334 <column name=
"controller_rate_limit">
4336 The maximum rate at which the switch will forward packets to the
4337 OpenFlow controller, in packets per second. If no value is
4338 specified, rate limiting is disabled.
4342 <column name=
"controller_burst_limit">
4344 When a high rate triggers rate-limiting, Open vSwitch queues
4345 packets to the controller for each port and transmits them to the
4346 controller at the configured rate. This value limits the number of
4347 queued packets. Ports on a bridge share the packet queue fairly.
4351 This value has no effect unless
<ref
4352 column=
"controller_rate_limit"/> is configured. The current
4353 default when this value is not specified is one-quarter of
<ref
4354 column=
"controller_rate_limit"/>, meaning that queuing can delay
4355 forwarding a packet to the controller by up to
250 ms.
4359 <group title=
"Controller Rate Limiting Statistics">
4361 These values report the effects of rate limiting. Their values are
4362 relative to establishment of the most recent OpenFlow connection,
4363 or since rate limiting was enabled, whichever happened more
4364 recently. Each consists of two values, one with
<code>TYPE
</code>
4365 replaced by
<code>miss
</code> for rate limiting flow table misses,
4366 and the other with
<code>TYPE
</code> replaced by
4367 <code>action
</code> for rate limiting packets sent by OpenFlow
4372 These statistics are reported only when controller rate limiting is
4376 <column name=
"status" key=
"packet-in-TYPE-bypassed"
4377 type='{
"type":
"integer",
"minInteger":
0}'
>
4378 Number of packets sent directly to the controller, without queuing,
4379 because the rate did not exceed the configured maximum.
4382 <column name=
"status" key=
"packet-in-TYPE-queued"
4383 type='{
"type":
"integer",
"minInteger":
0}'
>
4384 Number of packets added to the queue to send later.
4387 <column name=
"status" key=
"packet-in-TYPE-dropped"
4388 type='{
"type":
"integer",
"minInteger":
0}'
>
4389 Number of packets added to the queue that were later dropped due to
4390 overflow. This value is less than or equal to
<ref column=
"status"
4391 key=
"packet-in-TYPE-queued"/>.
4394 <column name=
"status" key=
"packet-in-TYPE-backlog"
4395 type='{
"type":
"integer",
"minInteger":
0}'
>
4396 Number of packets currently queued. The other statistics increase
4397 monotonically, but this one fluctuates between
0 and the
<ref
4398 column=
"controller_burst_limit"/> as conditions change.
4404 <group title=
"Additional In-Band Configuration">
4405 <p>These values are considered only in in-band control mode (see
4406 <ref column=
"connection_mode"/>).
</p>
4408 <p>When multiple controllers are configured on a single bridge, there
4409 should be only one set of unique values in these columns. If different
4410 values are set for these columns in different controllers, the effect
4413 <column name=
"local_ip">
4414 The IP address to configure on the local port,
4415 e.g.
<code>192.168.0.123</code>. If this value is unset, then
4416 <ref column=
"local_netmask"/> and
<ref column=
"local_gateway"/> are
4420 <column name=
"local_netmask">
4421 The IP netmask to configure on the local port,
4422 e.g.
<code>255.255.255.0</code>. If
<ref column=
"local_ip"/> is set
4423 but this value is unset, then the default is chosen based on whether
4424 the IP address is class A, B, or C.
4427 <column name=
"local_gateway">
4428 The IP address of the gateway to configure on the local port, as a
4429 string, e.g.
<code>192.168.0.1</code>. Leave this column unset if
4430 this network has no gateway.
4434 <group title=
"Controller Status">
4435 <column name=
"is_connected">
4436 <code>true
</code> if currently connected to this controller,
4437 <code>false
</code> otherwise.
4441 type='{
"type":
"string",
"enum": [
"set", [
"other",
"master",
"slave"]]}'
>
4442 <p>The level of authority this controller has on the associated
4443 bridge. Possible values are:
</p>
4445 <dt><code>other
</code></dt>
4446 <dd>Allows the controller access to all OpenFlow features.
</dd>
4447 <dt><code>master
</code></dt>
4448 <dd>Equivalent to
<code>other
</code>, except that there may be at
4449 most one master controller at a time. When a controller configures
4450 itself as
<code>master
</code>, any existing master is demoted to
4451 the
<code>slave
</code> role.
</dd>
4452 <dt><code>slave
</code></dt>
4453 <dd>Allows the controller read-only access to OpenFlow features.
4454 Attempts to modify the flow table will be rejected with an
4455 error. Slave controllers do not receive OFPT_PACKET_IN or
4456 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
4461 <column name=
"status" key=
"last_error">
4462 A human-readable description of the last error on the connection
4463 to the controller; i.e.
<code>strerror(errno)
</code>. This key
4464 will exist only if an error has occurred.
4467 <column name=
"status" key=
"state"
4468 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4470 The state of the connection to the controller:
4473 <dt><code>VOID
</code></dt>
4474 <dd>Connection is disabled.
</dd>
4476 <dt><code>BACKOFF
</code></dt>
4477 <dd>Attempting to reconnect at an increasing period.
</dd>
4479 <dt><code>CONNECTING
</code></dt>
4480 <dd>Attempting to connect.
</dd>
4482 <dt><code>ACTIVE
</code></dt>
4483 <dd>Connected, remote host responsive.
</dd>
4485 <dt><code>IDLE
</code></dt>
4486 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4489 These values may change in the future. They are provided only for
4494 <column name=
"status" key=
"sec_since_connect"
4495 type='{
"type":
"integer",
"minInteger":
0}'
>
4496 The amount of time since this controller last successfully connected to
4497 the switch (in seconds). Value is empty if controller has never
4498 successfully connected.
4501 <column name=
"status" key=
"sec_since_disconnect"
4502 type='{
"type":
"integer",
"minInteger":
1}'
>
4503 The amount of time since this controller last disconnected from
4504 the switch (in seconds). Value is empty if controller has never
4509 <group title=
"Connection Parameters">
4511 Additional configuration for a connection between the controller
4512 and the Open vSwitch.
4515 <column name=
"other_config" key=
"dscp"
4516 type='{
"type":
"integer"}'
>
4517 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4518 in the Type of Service (TOS) field in the IP header. DSCP provides a
4519 mechanism to classify the network traffic and provide Quality of
4520 Service (QoS) on IP networks.
4522 The DSCP value specified here is used when establishing the connection
4523 between the controller and the Open vSwitch. If no value is specified,
4524 a default value of
48 is chosen. Valid DSCP values must be in the
4530 <group title=
"Common Columns">
4531 The overall purpose of these columns is described under
<code>Common
4532 Columns
</code> at the beginning of this document.
4534 <column name=
"external_ids"/>
4535 <column name=
"other_config"/>
4539 <table name=
"Manager" title=
"OVSDB management connection.">
4541 Configuration for a database connection to an Open vSwitch database
4546 This table primarily configures the Open vSwitch database
4547 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
4548 (
<code>ovs-vswitchd
</code>). The switch does read the table to determine
4549 what connections should be treated as in-band.
4553 The Open vSwitch database server can initiate and maintain active
4554 connections to remote clients. It can also listen for database
4558 <group title=
"Core Features">
4559 <column name=
"target">
4560 <p>Connection method for managers.
</p>
4562 The following connection methods are currently supported:
4565 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4568 The specified SSL
<var>port
</var> on the host at the given
4569 <var>ip
</var>, which must be expressed as an IP address
4570 (not a DNS name). The
<ref table=
"Open_vSwitch"
4571 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
4572 table must point to a valid SSL configuration when this
4576 If
<var>port
</var> is not specified, it defaults to
6640.
4579 SSL support is an optional feature that is not always
4580 built as part of Open vSwitch.
4584 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4587 The specified TCP
<var>port
</var> on the host at the given
4588 <var>ip
</var>, which must be expressed as an IP address (not a
4589 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
4590 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4591 e.g.
<code>tcp:[::
1]:
6640</code>.
4594 If
<var>port
</var> is not specified, it defaults to
6640.
4597 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4600 Listens for SSL connections on the specified TCP
<var>port
</var>.
4601 Specify
0 for
<var>port
</var> to have the kernel automatically
4602 choose an available port. If
<var>ip
</var>, which must be
4603 expressed as an IP address (not a DNS name), is specified, then
4604 connections are restricted to the specified local IP address
4605 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4606 address, wrap in square brackets,
4607 e.g.
<code>pssl:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4608 specified then it listens only on IPv4 (but not IPv6) addresses.
4609 The
<ref table=
"Open_vSwitch" column=
"ssl"/> column in the
<ref
4610 table=
"Open_vSwitch"/> table must point to a valid SSL
4611 configuration when this form is used.
4614 If
<var>port
</var> is not specified, it defaults to
6640.
4617 SSL support is an optional feature that is not always built as
4618 part of Open vSwitch.
4621 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4624 Listens for connections on the specified TCP
<var>port
</var>.
4625 Specify
0 for
<var>port
</var> to have the kernel automatically
4626 choose an available port. If
<var>ip
</var>, which must be
4627 expressed as an IP address (not a DNS name), is specified, then
4628 connections are restricted to the specified local IP address
4629 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4630 address, wrap it in square brackets,
4631 e.g.
<code>ptcp:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4632 specified then it listens only on IPv4 addresses.
4635 If
<var>port
</var> is not specified, it defaults to
6640.
4639 <p>When multiple managers are configured, the
<ref column=
"target"/>
4640 values must be unique. Duplicate
<ref column=
"target"/> values yield
4641 unspecified results.
</p>
4644 <column name=
"connection_mode">
4646 If it is specified, this setting must be one of the following strings
4647 that describes how Open vSwitch contacts this OVSDB client over the
4652 <dt><code>in-band
</code></dt>
4654 In this mode, this connection's traffic travels over a bridge
4655 managed by Open vSwitch. With this setting, Open vSwitch allows
4656 traffic to and from the client regardless of the contents of the
4657 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4658 to connect to the client, because it did not have a flow to enable
4659 it.) This is the most common connection mode because it is not
4660 necessary to maintain two independent networks.
4662 <dt><code>out-of-band
</code></dt>
4664 In this mode, the client's traffic uses a control network separate
4665 from that managed by Open vSwitch, that is, Open vSwitch does not
4666 use any of its own network devices to communicate with the client.
4667 The control network must be configured separately, before or after
4668 <code>ovs-vswitchd
</code> is started.
4673 If not specified, the default is implementation-specific.
4678 <group title=
"Client Failure Detection and Handling">
4679 <column name=
"max_backoff">
4680 Maximum number of milliseconds to wait between connection attempts.
4681 Default is implementation-specific.
4684 <column name=
"inactivity_probe">
4685 Maximum number of milliseconds of idle time on connection to the client
4686 before sending an inactivity probe message. If Open vSwitch does not
4687 communicate with the client for the specified number of seconds, it
4688 will send a probe. If a response is not received for the same
4689 additional amount of time, Open vSwitch assumes the connection has been
4690 broken and attempts to reconnect. Default is implementation-specific.
4691 A value of
0 disables inactivity probes.
4695 <group title=
"Status">
4697 Key-value pair of
<ref column=
"is_connected"/> is always updated.
4698 Other key-value pairs in the status columns may be updated depends
4699 on the
<ref column=
"target"/> type.
4703 When
<ref column=
"target"/> specifies a connection method that
4704 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4705 <code>punix:
</code>), both
<ref column=
"n_connections"/> and
4706 <ref column=
"is_connected"/> may also be updated while the
4707 remaining key-value pairs are omitted.
4711 On the other hand, when
<ref column=
"target"/> specifies an
4712 outbound connection, all key-value pairs may be updated, except
4713 the above-mentioned two key-value pairs associated with inbound
4714 connection targets. They are omitted.
4717 <column name=
"is_connected">
4718 <code>true
</code> if currently connected to this manager,
4719 <code>false
</code> otherwise.
4722 <column name=
"status" key=
"last_error">
4723 A human-readable description of the last error on the connection
4724 to the manager; i.e.
<code>strerror(errno)
</code>. This key
4725 will exist only if an error has occurred.
4728 <column name=
"status" key=
"state"
4729 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4731 The state of the connection to the manager:
4734 <dt><code>VOID
</code></dt>
4735 <dd>Connection is disabled.
</dd>
4737 <dt><code>BACKOFF
</code></dt>
4738 <dd>Attempting to reconnect at an increasing period.
</dd>
4740 <dt><code>CONNECTING
</code></dt>
4741 <dd>Attempting to connect.
</dd>
4743 <dt><code>ACTIVE
</code></dt>
4744 <dd>Connected, remote host responsive.
</dd>
4746 <dt><code>IDLE
</code></dt>
4747 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4750 These values may change in the future. They are provided only for
4755 <column name=
"status" key=
"sec_since_connect"
4756 type='{
"type":
"integer",
"minInteger":
0}'
>
4757 The amount of time since this manager last successfully connected
4758 to the database (in seconds). Value is empty if manager has never
4759 successfully connected.
4762 <column name=
"status" key=
"sec_since_disconnect"
4763 type='{
"type":
"integer",
"minInteger":
0}'
>
4764 The amount of time since this manager last disconnected from the
4765 database (in seconds). Value is empty if manager has never
4769 <column name=
"status" key=
"locks_held">
4770 Space-separated list of the names of OVSDB locks that the connection
4771 holds. Omitted if the connection does not hold any locks.
4774 <column name=
"status" key=
"locks_waiting">
4775 Space-separated list of the names of OVSDB locks that the connection is
4776 currently waiting to acquire. Omitted if the connection is not waiting
4780 <column name=
"status" key=
"locks_lost">
4781 Space-separated list of the names of OVSDB locks that the connection
4782 has had stolen by another OVSDB client. Omitted if no locks have been
4783 stolen from this connection.
4786 <column name=
"status" key=
"n_connections"
4787 type='{
"type":
"integer",
"minInteger":
2}'
>
4788 When
<ref column=
"target"/> specifies a connection method that
4789 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4790 <code>pssl:
</code>) and more than one connection is actually active,
4791 the value is the number of active connections. Otherwise, this
4792 key-value pair is omitted.
4795 <column name=
"status" key=
"bound_port" type='{
"type":
"integer"}'
>
4796 When
<ref column=
"target"/> is
<code>ptcp:
</code> or
4797 <code>pssl:
</code>, this is the TCP port on which the OVSDB server is
4798 listening. (This is particularly useful when
<ref
4799 column=
"target"/> specifies a port of
0, allowing the kernel to
4800 choose any available port.)
4804 <group title=
"Connection Parameters">
4806 Additional configuration for a connection between the manager
4807 and the Open vSwitch Database.
4810 <column name=
"other_config" key=
"dscp"
4811 type='{
"type":
"integer"}'
>
4812 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4813 in the Type of Service (TOS) field in the IP header. DSCP provides a
4814 mechanism to classify the network traffic and provide Quality of
4815 Service (QoS) on IP networks.
4817 The DSCP value specified here is used when establishing the connection
4818 between the manager and the Open vSwitch. If no value is specified, a
4819 default value of
48 is chosen. Valid DSCP values must be in the range
4824 <group title=
"Common Columns">
4825 The overall purpose of these columns is described under
<code>Common
4826 Columns
</code> at the beginning of this document.
4828 <column name=
"external_ids"/>
4829 <column name=
"other_config"/>
4833 <table name=
"NetFlow">
4834 A NetFlow target. NetFlow is a protocol that exports a number of
4835 details about terminating IP flows, such as the principals involved
4838 <column name=
"targets">
4839 NetFlow targets in the form
4840 <code><var>ip
</var>:
<var>port
</var></code>. The
<var>ip
</var>
4841 must be specified numerically, not as a DNS name.
4844 <column name=
"engine_id">
4845 Engine ID to use in NetFlow messages. Defaults to datapath index
4849 <column name=
"engine_type">
4850 Engine type to use in NetFlow messages. Defaults to datapath
4851 index if not specified.
4854 <column name=
"active_timeout">
4856 The interval at which NetFlow records are sent for flows that
4857 are still active, in seconds. A value of
<code>0</code>
4858 requests the default timeout (currently
600 seconds); a value
4859 of
<code>-
1</code> disables active timeouts.
4863 The NetFlow passive timeout, for flows that become inactive,
4864 is not configurable. It will vary depending on the Open
4865 vSwitch version, the forms and contents of the OpenFlow flow
4866 tables, CPU and memory usage, and network activity. A typical
4867 passive timeout is about a second.
4871 <column name=
"add_id_to_interface">
4872 <p>If this column's value is
<code>false
</code>, the ingress and egress
4873 interface fields of NetFlow flow records are derived from OpenFlow port
4874 numbers. When it is
<code>true
</code>, the
7 most significant bits of
4875 these fields will be replaced by the least significant
7 bits of the
4876 engine id. This is useful because many NetFlow collectors do not
4877 expect multiple switches to be sending messages from the same host, so
4878 they do not store the engine information which could be used to
4879 disambiguate the traffic.
</p>
4880 <p>When this option is enabled, a maximum of
508 ports are supported.
</p>
4883 <group title=
"Common Columns">
4884 The overall purpose of these columns is described under
<code>Common
4885 Columns
</code> at the beginning of this document.
4887 <column name=
"external_ids"/>
4892 SSL configuration for an Open_vSwitch.
4894 <column name=
"private_key">
4895 Name of a PEM file containing the private key used as the switch's
4896 identity for SSL connections to the controller.
4899 <column name=
"certificate">
4900 Name of a PEM file containing a certificate, signed by the
4901 certificate authority (CA) used by the controller and manager,
4902 that certifies the switch's private key, identifying a trustworthy
4906 <column name=
"ca_cert">
4907 Name of a PEM file containing the CA certificate used to verify
4908 that the switch is connected to a trustworthy controller.
4911 <column name=
"bootstrap_ca_cert">
4912 If set to
<code>true
</code>, then Open vSwitch will attempt to
4913 obtain the CA certificate from the controller on its first SSL
4914 connection and save it to the named PEM file. If it is successful,
4915 it will immediately drop the connection and reconnect, and from then
4916 on all SSL connections must be authenticated by a certificate signed
4917 by the CA certificate thus obtained.
<em>This option exposes the
4918 SSL connection to a man-in-the-middle attack obtaining the initial
4919 CA certificate.
</em> It may still be useful for bootstrapping.
4922 <group title=
"Common Columns">
4923 The overall purpose of these columns is described under
<code>Common
4924 Columns
</code> at the beginning of this document.
4926 <column name=
"external_ids"/>
4930 <table name=
"sFlow">
4931 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4932 monitoring of switches.
</p>
4934 <column name=
"agent">
4935 Name of the network device whose IP address should be reported as the
4936 ``agent address'' to collectors. If not specified, the agent device is
4937 figured from the first target address and the routing table. If the
4938 routing table does not contain a route to the target, the IP address
4939 defaults to the
<ref table=
"Controller" column=
"local_ip"/> in the
4940 collector's
<ref table=
"Controller"/>. If an agent IP address cannot be
4941 determined any of these ways, sFlow is disabled.
4944 <column name=
"header">
4945 Number of bytes of a sampled packet to send to the collector.
4946 If not specified, the default is
128 bytes.
4949 <column name=
"polling">
4950 Polling rate in seconds to send port statistics to the collector.
4951 If not specified, defaults to
30 seconds.
4954 <column name=
"sampling">
4955 Rate at which packets should be sampled and sent to the collector.
4956 If not specified, defaults to
400, which means one out of
400
4957 packets, on average, will be sent to the collector.
4960 <column name=
"targets">
4961 sFlow targets in the form
4962 <code><var>ip
</var>:
<var>port
</var></code>.
4965 <group title=
"Common Columns">
4966 The overall purpose of these columns is described under
<code>Common
4967 Columns
</code> at the beginning of this document.
4969 <column name=
"external_ids"/>
4973 <table name=
"IPFIX">
4974 <p>Configuration for sending packets to IPFIX collectors.
</p>
4977 IPFIX is a protocol that exports a number of details about flows. The
4978 IPFIX implementation in Open vSwitch samples packets at a configurable
4979 rate, extracts flow information from those packets, optionally caches and
4980 aggregates the flow information, and sends the result to one or more
4985 IPFIX in Open vSwitch can be configured two different ways:
4990 With
<em>per-bridge sampling
</em>, Open vSwitch performs IPFIX sampling
4991 automatically on all packets that pass through a bridge. To configure
4992 per-bridge sampling, create an
<ref table=
"IPFIX"/> record and point a
4993 <ref table=
"Bridge"/> table's
<ref table=
"Bridge" column=
"ipfix"/>
4994 column to it. The
<ref table=
"Flow_Sample_Collector_Set"/> table is
4995 not used for per-bridge sampling.
5000 With
<em>flow-based sampling
</em>,
<code>sample
</code> actions in the
5001 OpenFlow flow table drive IPFIX sampling. See
5002 <code>ovs-ofctl
</code>(
8) for a description of the
5003 <code>sample
</code> action.
5007 Flow-based sampling also requires database configuration: create a
5008 <ref table=
"IPFIX"/> record that describes the IPFIX configuration
5009 and a
<ref table=
"Flow_Sample_Collector_Set"/> record that points to
5010 the
<ref table=
"Bridge"/> whose flow table holds the
5011 <code>sample
</code> actions and to
<ref table=
"IPFIX"/> record. The
5012 <ref table=
"Bridge" column=
"ipfix"/> in the
<ref table=
"Bridge"/>
5013 table is not used for flow-based sampling.
5018 <column name=
"targets">
5019 IPFIX target collectors in the form
5020 <code><var>ip
</var>:
<var>port
</var></code>.
5023 <column name=
"cache_active_timeout">
5024 The maximum period in seconds for which an IPFIX flow record is
5025 cached and aggregated before being sent. If not specified,
5026 defaults to
0. If
0, caching is disabled.
5029 <column name=
"cache_max_flows">
5030 The maximum number of IPFIX flow records that can be cached at a
5031 time. If not specified, defaults to
0. If
0, caching is
5035 <column name=
"other_config" key=
"enable-tunnel-sampling"
5036 type='{
"type":
"boolean"}'
>
5038 Set to
<code>true
</code> to enable sampling and reporting tunnel
5039 header
7-tuples in IPFIX flow records. Tunnel sampling is enabled
5044 The following enterprise entities report the sampled tunnel info:
5048 <dt>tunnelType:
</dt>
5050 <p>ID:
891, and enterprise ID
6876 (VMware).
</p>
5051 <p>type: unsigned
8-bit integer.
</p>
5052 <p>data type semantics: identifier.
</p>
5053 <p>description: Identifier of the layer
2 network overlay network
5054 encapsulation type:
0x01 VxLAN,
0x02 GRE,
0x03 LISP,
0x07 GENEVE.
</p>
5058 <p>ID:
892, and enterprise ID
6876 (VMware).
</p>
5059 <p>type: variable-length octetarray.
</p>
5060 <p>data type semantics: identifier.
</p>
5061 <p>description: Key which is used for identifying an individual
5062 traffic flow within a VxLAN (
24-bit VNI), GENEVE (
24-bit VNI),
5063 GRE (
32-bit key), or LISP (
24-bit instance ID) tunnel. The
5064 key is encoded in this octetarray as a
3-,
4-, or
8-byte integer
5065 ID in network byte order.
</p>
5067 <dt>tunnelSourceIPv4Address:
</dt>
5069 <p>ID:
893, and enterprise ID
6876 (VMware).
</p>
5070 <p>type: unsigned
32-bit integer.
</p>
5071 <p>data type semantics: identifier.
</p>
5072 <p>description: The IPv4 source address in the tunnel IP packet
5075 <dt>tunnelDestinationIPv4Address:
</dt>
5077 <p>ID:
894, and enterprise ID
6876 (VMware).
</p>
5078 <p>type: unsigned
32-bit integer.
</p>
5079 <p>data type semantics: identifier.
</p>
5080 <p>description: The IPv4 destination address in the tunnel IP
5083 <dt>tunnelProtocolIdentifier:
</dt>
5085 <p>ID:
895, and enterprise ID
6876 (VMware).
</p>
5086 <p>type: unsigned
8-bit integer.
</p>
5087 <p>data type semantics: identifier.
</p>
5088 <p>description: The value of the protocol number in the tunnel
5089 IP packet header. The protocol number identifies the tunnel IP
5090 packet payload type.
</p>
5092 <dt>tunnelSourceTransportPort:
</dt>
5094 <p>ID:
896, and enterprise ID
6876 (VMware).
</p>
5095 <p>type: unsigned
16-bit integer.
</p>
5096 <p>data type semantics: identifier.
</p>
5097 <p>description: The source port identifier in the tunnel transport
5098 header. For the transport protocols UDP, TCP, and SCTP, this is
5099 the source port number given in the respective header.
</p>
5101 <dt>tunnelDestinationTransportPort:
</dt>
5103 <p>ID:
897, and enterprise ID
6876 (VMware).
</p>
5104 <p>type: unsigned
16-bit integer.
</p>
5105 <p>data type semantics: identifier.
</p>
5106 <p>description: The destination port identifier in the tunnel
5107 transport header. For the transport protocols UDP, TCP, and SCTP,
5108 this is the destination port number given in the respective header.
5114 Before Open vSwitch
2.5.90,
<ref column=
"other_config"
5115 key=
"enable-tunnel-sampling"/> was only supported with per-bridge
5116 sampling, and ignored otherwise. Open vSwitch
2.5.90 and later support
5117 <ref column=
"other_config" key=
"enable-tunnel-sampling"/> for
5118 per-bridge and per-flow sampling.
5122 <column name=
"other_config" key=
"virtual_obs_id"
5123 type='{
"type":
"string"}'
>
5125 A string that accompanies each IPFIX flow record. Its intended use is
5126 for the ``virtual observation ID,'' an identifier of a virtual
5127 observation point that is locally unique in a virtual network. It
5128 describes a location in the virtual network where IP packets can be
5129 observed. The maximum length is
254 bytes. If not specified, the
5130 field is omitted from the IPFIX flow record.
5134 The following enterprise entity reports the specified virtual
5139 <dt>virtualObsID:
</dt>
5141 <p>ID:
898, and enterprise ID
6876 (VMware).
</p>
5142 <p>type: variable-length string.
</p>
5143 <p>data type semantics: identifier.
</p>
5144 <p>description: A virtual observation domain ID that is locally
5145 unique in a virtual network.
5151 This feature was introduced in Open vSwitch
2.5.90.
5155 <group title=
"Per-Bridge Sampling">
5157 These values affect only per-bridge sampling. See above for a
5158 description of the differences between per-bridge and flow-based
5162 <column name=
"sampling">
5163 The rate at which packets should be sampled and sent to each target
5164 collector. If not specified, defaults to
400, which means one out of
5165 400 packets, on average, will be sent to each target collector.
5168 <column name=
"obs_domain_id">
5169 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
5170 specified, defaults to
0.
5173 <column name=
"obs_point_id">
5174 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
5175 specified, defaults to
0.
5178 <column name=
"other_config" key=
"enable-input-sampling"
5179 type='{
"type":
"boolean"}'
>
5180 By default, Open vSwitch samples and reports flows at bridge port input
5181 in IPFIX flow records. Set this column to
<code>false
</code> to
5182 disable input sampling.
5185 <column name=
"other_config" key=
"enable-output-sampling"
5186 type='{
"type":
"boolean"}'
>
5187 By default, Open vSwitch samples and reports flows at bridge port
5188 output in IPFIX flow records. Set this column to
<code>false
</code> to
5189 disable output sampling.
5193 <group title=
"Common Columns">
5194 The overall purpose of these columns is described under
<code>Common
5195 Columns
</code> at the beginning of this document.
5197 <column name=
"external_ids"/>
5201 <table name=
"Flow_Sample_Collector_Set">
5203 A set of IPFIX collectors of packet samples generated by OpenFlow
5204 <code>sample
</code> actions. This table is used only for IPFIX
5205 flow-based sampling, not for per-bridge sampling (see the
<ref
5206 table=
"IPFIX"/> table for a description of the two forms).
5210 The ID of this collector set, unique among the bridge's
5211 collector sets, to be used as the
<code>collector_set_id
</code>
5212 in OpenFlow
<code>sample
</code> actions.
5215 <column name=
"bridge">
5216 The bridge into which OpenFlow
<code>sample
</code> actions can
5217 be added to send packet samples to this set of IPFIX collectors.
5220 <column name=
"ipfix">
5221 Configuration of the set of IPFIX collectors to send one flow
5222 record per sampled packet to.
5225 <group title=
"Common Columns">
5226 The overall purpose of these columns is described under
<code>Common
5227 Columns
</code> at the beginning of this document.
5229 <column name=
"external_ids"/>
5233 <table name=
"AutoAttach">
5235 Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
5236 draft standard describes a compact method of using IEEE
802.1AB Link
5237 Layer Discovery Protocol (LLDP) together with a IEEE
802.1aq Shortest
5238 Path Bridging (SPB) network to automatically attach network devices
5239 to individual services in a SPB network. The intent here is to allow
5240 network applications and devices using OVS to be able to easily take
5241 advantage of features offered by industry standard SPB networks.
5245 Auto Attach (AA) uses LLDP to communicate between a directly connected
5246 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
5247 is extended to add two new Type-Length-Value tuples (TLVs). The first
5248 new TLV supports the ongoing discovery of directly connected AA
5249 correspondents. Auto Attach operates by regularly transmitting AA
5250 discovery TLVs between the AA client and AA server. By exchanging these
5251 discovery messages, both the AAC and AAS learn the system name and
5252 system description of their peer. In the OVS context, OVS operates as
5253 the AA client and the AA server resides on a switch at the edge of the
5258 Once AA discovery has been completed the AAC then uses the second new TLV
5259 to deliver identifier mappings from the AAC to the AAS. A primary feature
5260 of Auto Attach is to facilitate the mapping of VLANs defined outside the
5261 SPB network onto service ids (ISIDs) defined within the SPM network. By
5262 doing so individual external VLANs can be mapped onto specific SPB
5263 network services. These VLAN id to ISID mappings can be configured and
5264 managed locally using new options added to the ovs-vsctl command.
5268 The Auto Attach OVS feature does not provide a full implementation of
5269 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
5270 standard and support for the AA TLV extensions is provided. LLDP
5271 protocol support in OVS can be enabled or disabled on a port by port
5272 basis. LLDP support is disabled by default.
5275 <column name=
"system_name">
5276 The system_name string is exported in LLDP messages. It should uniquely
5277 identify the bridge in the network.
5280 <column name=
"system_description">
5281 The system_description string is exported in LLDP messages. It should
5282 describe the type of software and hardware.
5285 <column name=
"mappings">
5286 A mapping from SPB network Individual Service Identifier (ISID) to VLAN