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=
"dpdk-init"
184 type='{
"type":
"boolean"}'
>
186 Set this value to
<code>true
</code> to enable runtime support for
187 DPDK ports. The vswitch must have compile-time support for DPDK as
191 The default value is
<code>false
</code>. Changing this value requires
192 restarting the daemon
195 If this value is
<code>false
</code> at startup, any dpdk ports which
196 are configured in the bridge will fail due to memory errors.
200 <column name=
"other_config" key=
"dpdk-lcore-mask"
201 type='{
"type":
"integer",
"minInteger":
1}'
>
203 Specifies the CPU cores where dpdk lcore threads should be spawned.
204 The DPDK lcore threads are used for DPDK library tasks, such as
205 library internal message processing, logging, etc. Value should be in
206 the form of a hex string (so '
0x123') similar to the 'taskset' mask
210 The lowest order bit corresponds to the first CPU core. A set bit
211 means the corresponding core is available and an lcore thread will be
212 created and pinned to it. If the input does not cover all cores,
213 those uncovered cores are considered not set.
216 For performance reasons, it is best to set this to a single core on
217 the system, rather than allow lcore threads to float.
220 If not specified, the value will be determined by choosing the lowest
221 CPU core from initial cpu affinity list. Otherwise, the value will be
222 passed directly to the DPDK library.
226 <column name=
"other_config" key=
"pmd-cpu-mask">
228 Specifies CPU mask for setting the cpu affinity of PMD (Poll
229 Mode Driver) threads. Value should be in the form of hex string,
230 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
234 The lowest order bit corresponds to the first CPU core. A set bit
235 means the corresponding core is available and a pmd thread will be
236 created and pinned to it. If the input does not cover all cores,
237 those uncovered cores are considered not set.
240 If not specified, one pmd thread will be created for each numa node
241 and pinned to any available core on the numa node by default.
245 <column name=
"other_config" key=
"dpdk-alloc-mem"
246 type='{
"type":
"integer",
"minInteger":
0}'
>
248 Specifies the amount of memory to preallocate from the hugepage pool,
249 regardless of socket. It is recommended that dpdk-socket-mem is used
254 <column name=
"other_config" key=
"dpdk-socket-mem"
255 type='{
"type":
"string"}'
>
257 Specifies the amount of memory to preallocate from the hugepage pool,
258 on a per-socket basis.
261 The specifier is a comma-separated string, in ascending order of CPU
262 socket (ex:
1024,
2048,
4096,
8192 would set socket
0 to preallocate
263 1024MB, socket
1 to preallocate
2048MB, etc.)
266 If dpdk-socket-mem and dpdk-alloc-mem are not specified, dpdk-socket-mem
267 will be used and the default value is
1024,
0. If dpdk-socket-mem and
268 dpdk-alloc-mem are specified at same time, dpdk-socket-mem will be
269 used as default. Changing this value requires restarting the daemon.
273 <column name=
"other_config" key=
"dpdk-hugepage-dir"
274 type='{
"type":
"string"}'
>
276 Specifies the path to the hugetlbfs mount point.
279 If not specified, this will be guessed by the DPDK library (default
280 is /dev/hugepages). Changing this value requires restarting the
285 <column name=
"other_config" key=
"dpdk-extra"
286 type='{
"type":
"string"}'
>
288 Specifies additional eal command line arguments for DPDK.
291 The default is empty. Changing this value requires restarting the
296 <column name=
"other_config" key=
"vhost-sock-dir"
297 type='{
"type":
"string"}'
>
299 Specifies a relative path from
<ref column=
"external_ids"
300 key=
"rundir"/> to the vhost-user unix domain socket files. If this
301 value is unset, the sockets are put directly in
<ref
302 column=
"external_ids" key=
"rundir"/>.
305 Changing this value requires restarting the daemon.
309 <column name=
"other_config" key=
"n-handler-threads"
310 type='{
"type":
"integer",
"minInteger":
1}'
>
312 Specifies the number of threads for software datapaths to use for
313 handling new flows. The default the number of online CPU cores minus
314 the number of revalidators.
317 This configuration is per datapath. If you have more than one
318 software datapath (e.g. some
<code>system
</code> bridges and some
319 <code>netdev
</code> bridges), then the total number of threads is
320 <code>n-handler-threads
</code> times the number of software
325 <column name=
"other_config" key=
"n-revalidator-threads"
326 type='{
"type":
"integer",
"minInteger":
1}'
>
328 Specifies the number of threads for software datapaths to use for
329 revalidating flows in the datapath. Typically, there is a direct
330 correlation between the number of revalidator threads, and the number
331 of flows allowed in the datapath. The default is the number of cpu
332 cores divided by four plus one. If
<code>n-handler-threads
</code> is
333 set, the default changes to the number of cpu cores minus the number
337 This configuration is per datapath. If you have more than one
338 software datapath (e.g. some
<code>system
</code> bridges and some
339 <code>netdev
</code> bridges), then the total number of threads is
340 <code>n-handler-threads
</code> times the number of software
345 <column name=
"other_config" key=
"emc-insert-inv-prob"
346 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
348 Specifies the inverse probability (
1/emc-insert-inv-prob) of a flow
349 being inserted into the Exact Match Cache (EMC). On average one in
350 every
<code>emc-insert-inv-prob
</code> packets that generate a unique
351 flow will cause an insertion into the EMC.
353 A value of
1 will result in an insertion for every flow (
1/
1 =
100%)
354 whereas a value of zero will result in no insertions and essentially
358 Defaults to
100 ie. there is (
1/
100 =)
1% chance of EMC insertion.
362 <column name=
"other_config" key=
"vlan-limit"
363 type='{
"type":
"integer",
"minInteger":
0}'
>
365 Limits the number of VLAN headers that can be matched to the
366 specified number. Further VLAN headers will be treated as payload,
367 e.g. a packet with more
802.1q headers will match Ethernet type
371 Value
<code>0</code> means unlimited. The actual number of supported
372 VLAN headers is the smallest of
<code>vlan-limit
</code>, the number
373 of VLANs supported by Open vSwitch userspace (currently
2), and the
374 number supported by the datapath.
378 If this value is absent, the default is currently
1. This maintains
379 backward compatibility with controllers that were designed for use
380 with Open vSwitch versions earlier than
2.8, which only supported one
386 <group title=
"Status">
387 <column name=
"next_cfg">
388 Sequence number for client to increment. When a client modifies
389 any part of the database configuration and wishes to wait for
390 Open vSwitch to finish applying the changes, it may increment
391 this sequence number.
394 <column name=
"cur_cfg">
395 Sequence number that Open vSwitch sets to the current value of
396 <ref column=
"next_cfg"/> after it finishes applying a set of
397 configuration changes.
400 <group title=
"Statistics">
402 The
<code>statistics
</code> column contains key-value pairs that
403 report statistics about a system running an Open vSwitch. These are
404 updated periodically (currently, every
5 seconds). Key-value pairs
405 that cannot be determined or that do not apply to a platform are
409 <column name=
"other_config" key=
"enable-statistics"
410 type='{
"type":
"boolean"}'
>
411 Statistics are disabled by default to avoid overhead in the common
412 case when statistics gathering is not useful. Set this value to
413 <code>true
</code> to enable populating the
<ref column=
"statistics"/>
414 column or to
<code>false
</code> to explicitly disable it.
417 <column name=
"statistics" key=
"cpu"
418 type='{
"type":
"integer",
"minInteger":
1}'
>
420 Number of CPU processors, threads, or cores currently online and
421 available to the operating system on which Open vSwitch is running,
422 as an integer. This may be less than the number installed, if some
423 are not online or if they are not available to the operating
427 Open vSwitch userspace processes are not multithreaded, but the
428 Linux kernel-based datapath is.
432 <column name=
"statistics" key=
"load_average">
433 A comma-separated list of three floating-point numbers,
434 representing the system load average over the last
1,
5, and
15
435 minutes, respectively.
438 <column name=
"statistics" key=
"memory">
440 A comma-separated list of integers, each of which represents a
441 quantity of memory in kilobytes that describes the operating
442 system on which Open vSwitch is running. In respective order,
447 <li>Total amount of RAM allocated to the OS.
</li>
448 <li>RAM allocated to the OS that is in use.
</li>
449 <li>RAM that can be flushed out to disk or otherwise discarded
450 if that space is needed for another purpose. This number is
451 necessarily less than or equal to the previous value.
</li>
452 <li>Total disk space allocated for swap.
</li>
453 <li>Swap space currently in use.
</li>
457 On Linux, all five values can be determined and are included. On
458 other operating systems, only the first two values can be
459 determined, so the list will only have two values.
463 <column name=
"statistics" key=
"process_NAME">
465 One such key-value pair, with
<code>NAME
</code> replaced by
466 a process name, will exist for each running Open vSwitch
467 daemon process, with
<var>name
</var> replaced by the
468 daemon's name (e.g.
<code>process_ovs-vswitchd
</code>). The
469 value is a comma-separated list of integers. The integers
470 represent the following, with memory measured in kilobytes
471 and durations in milliseconds:
475 <li>The process's virtual memory size.
</li>
476 <li>The process's resident set size.
</li>
477 <li>The amount of user and system CPU time consumed by the
479 <li>The number of times that the process has crashed and been
480 automatically restarted by the monitor.
</li>
481 <li>The duration since the process was started.
</li>
482 <li>The duration for which the process has been running.
</li>
486 The interpretation of some of these values depends on whether the
487 process was started with the
<option>--monitor
</option>. If it
488 was not, then the crash count will always be
0 and the two
489 durations will always be the same. If
<option>--monitor
</option>
490 was given, then the crash count may be positive; if it is, the
491 latter duration is the amount of time since the most recent crash
496 There will be one key-value pair for each file in Open vSwitch's
497 ``run directory'' (usually
<code>/var/run/openvswitch
</code>)
498 whose name ends in
<code>.pid
</code>, whose contents are a
499 process ID, and which is locked by a running process. The
500 <var>name
</var> is taken from the pidfile's name.
504 Currently Open vSwitch is only able to obtain all of the above
505 detail on Linux systems. On other systems, the same key-value
506 pairs will be present but the values will always be the empty
511 <column name=
"statistics" key=
"file_systems">
513 A space-separated list of information on local, writable file
514 systems. Each item in the list describes one file system and
515 consists in turn of a comma-separated list of the following:
519 <li>Mount point, e.g.
<code>/
</code> or
<code>/var/log
</code>.
520 Any spaces or commas in the mount point are replaced by
522 <li>Total size, in kilobytes, as an integer.
</li>
523 <li>Amount of storage in use, in kilobytes, as an integer.
</li>
527 This key-value pair is omitted if there are no local, writable
528 file systems or if Open vSwitch cannot obtain the needed
535 <group title=
"Version Reporting">
537 These columns report the types and versions of the hardware and
538 software running Open vSwitch. We recommend in general that software
539 should test whether specific features are supported instead of relying
540 on version number checks. These values are primarily intended for
541 reporting to human administrators.
544 <column name=
"ovs_version">
545 The Open vSwitch version number, e.g.
<code>1.1.0</code>.
548 <column name=
"db_version">
550 The database schema version number, e.g.
<code>1.2.3</code>. See
551 ovsdb-tool(
1) for an explanation of the numbering scheme.
555 The schema version is part of the database schema, so it can also be
556 retrieved by fetching the schema using the Open vSwitch database
561 <column name=
"system_type">
563 An identifier for the type of system on top of which Open vSwitch
564 runs, e.g.
<code>XenServer
</code> or
<code>KVM
</code>.
567 System integrators are responsible for choosing and setting an
568 appropriate value for this column.
572 <column name=
"system_version">
574 The version of the system identified by
<ref column=
"system_type"/>,
575 e.g.
<code>5.6.100-
39265p
</code> on XenServer
5.6.100 build
39265.
578 System integrators are responsible for choosing and setting an
579 appropriate value for this column.
585 <group title=
"Capabilities">
587 These columns report capabilities of the Open vSwitch instance.
589 <column name=
"datapath_types">
591 This column reports the different dpifs registered with the system.
592 These are the values that this instance supports in the
<ref
593 column=
"datapath_type" table=
"Bridge"/> column of the
<ref
594 table=
"Bridge"/> table.
597 <column name=
"iface_types">
599 This column reports the different netdevs registered with the system.
600 These are the values that this instance supports in the
<ref
601 column=
"type" table=
"Interface"/> column of the
<ref
602 table=
"Interface"/> table.
607 <group title=
"Database Configuration">
609 These columns primarily configure the Open vSwitch database
610 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
611 (
<code>ovs-vswitchd
</code>). The OVSDB database also uses the
<ref
612 column=
"ssl"/> settings.
616 The Open vSwitch switch does read the database configuration to
617 determine remote IP addresses to which in-band control should apply.
620 <column name=
"manager_options">
621 Database clients to which the Open vSwitch database server should
622 connect or to which it should listen, along with options for how these
623 connection should be configured. See the
<ref table=
"Manager"/> table
624 for more information.
628 <group title=
"Common Columns">
629 The overall purpose of these columns is described under
<code>Common
630 Columns
</code> at the beginning of this document.
632 <column name=
"other_config"/>
633 <column name=
"external_ids"/>
637 <table name=
"Bridge">
639 Configuration for a bridge within an
640 <ref table=
"Open_vSwitch"/>.
643 A
<ref table=
"Bridge"/> record represents an Ethernet switch with one or
644 more ``ports,'' which are the
<ref table=
"Port"/> records pointed to by
645 the
<ref table=
"Bridge"/>'s
<ref column=
"ports"/> column.
648 <group title=
"Core Features">
651 Bridge identifier. Must be unique among the names of ports,
652 interfaces, and bridges on a host.
656 The name must be alphanumeric and must not contain forward or
657 backward slashes. The name of a bridge is also the name of an
<ref
658 table=
"Interface"/> (and a
<ref table=
"Port"/>) within the bridge, so
659 the restrictions on the
<ref table=
"Interface" column=
"name"/> column
660 in the
<ref table=
"Interface"/> table, particularly on length, also
661 apply to bridge names. Refer to the documentation for
<ref
662 table=
"Interface"/> names for details.
666 <column name=
"ports">
667 Ports included in the bridge.
670 <column name=
"mirrors">
671 Port mirroring configuration.
674 <column name=
"netflow">
675 NetFlow configuration.
678 <column name=
"sflow">
679 sFlow(R) configuration.
682 <column name=
"ipfix">
686 <column name=
"flood_vlans">
688 VLAN IDs of VLANs on which MAC address learning should be disabled,
689 so that packets are flooded instead of being sent to specific ports
690 that are believed to contain packets' destination MACs. This should
691 ordinarily be used to disable MAC learning on VLANs used for
692 mirroring (RSPAN VLANs). It may also be useful for debugging.
695 SLB bonding (see the
<ref table=
"Port" column=
"bond_mode"/> column in
696 the
<ref table=
"Port"/> table) is incompatible with
697 <code>flood_vlans
</code>. Consider using another bonding mode or
698 a different type of mirror instead.
702 <column name=
"auto_attach">
703 Auto Attach configuration.
707 <group title=
"OpenFlow Configuration">
708 <column name=
"controller">
710 OpenFlow controller set. If unset, then no OpenFlow controllers
715 If there are primary controllers, removing all of them clears the
716 flow table. If there are no primary controllers, adding one also
717 clears the flow table. Other changes to the set of controllers, such
718 as adding or removing a service controller, adding another primary
719 controller to supplement an existing primary controller, or removing
720 only one of two primary controllers, have no effect on the flow
725 <column name=
"flow_tables">
726 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
727 table ID to configuration for that table.
730 <column name=
"fail_mode">
731 <p>When a controller is configured, it is, ordinarily, responsible
732 for setting up all flows on the switch. Thus, if the connection to
733 the controller fails, no new network connections can be set up.
734 If the connection to the controller stays down long enough,
735 no packets can pass through the switch at all. This setting
736 determines the switch's response to such a situation. It may be set
737 to one of the following:
739 <dt><code>standalone
</code></dt>
740 <dd>If no message is received from the controller for three
741 times the inactivity probe interval
742 (see
<ref column=
"inactivity_probe"/>), then Open vSwitch
743 will take over responsibility for setting up flows. In
744 this mode, Open vSwitch causes the bridge to act like an
745 ordinary MAC-learning switch. Open vSwitch will continue
746 to retry connecting to the controller in the background
747 and, when the connection succeeds, it will discontinue its
748 standalone behavior.
</dd>
749 <dt><code>secure
</code></dt>
750 <dd>Open vSwitch will not set up flows on its own when the
751 controller connection fails or when no controllers are
752 defined. The bridge will continue to retry connecting to
753 any defined controllers forever.
</dd>
757 The default is
<code>standalone
</code> if the value is unset, but
758 future versions of Open vSwitch may change the default.
761 The
<code>standalone
</code> mode can create forwarding loops on a
762 bridge that has more than one uplink port unless STP is enabled. To
763 avoid loops on such a bridge, configure
<code>secure
</code> mode or
764 enable STP (see
<ref column=
"stp_enable"/>).
766 <p>When more than one controller is configured,
767 <ref column=
"fail_mode"/> is considered only when none of the
768 configured controllers can be contacted.
</p>
770 Changing
<ref column=
"fail_mode"/> when no primary controllers are
771 configured clears the flow table.
775 <column name=
"datapath_id">
776 Reports the OpenFlow datapath ID in use. Exactly
16 hex digits.
777 (Setting this column has no useful effect. Set
<ref
778 column=
"other-config" key=
"datapath-id"/> instead.)
781 <column name=
"datapath_version">
783 Reports the version number of the Open vSwitch datapath in use.
784 This allows management software to detect and report discrepancies
785 between Open vSwitch userspace and datapath versions. (The
<ref
786 column=
"ovs_version" table=
"Open_vSwitch"/> column in the
<ref
787 table=
"Open_vSwitch"/> reports the Open vSwitch userspace version.)
788 The version reported depends on the datapath in use:
793 When the kernel module included in the Open vSwitch source tree is
794 used, this column reports the Open vSwitch version from which the
799 When the kernel module that is part of the upstream Linux kernel is
800 used, this column reports
<code><unknown
></code>.
804 When the datapath is built into the
<code>ovs-vswitchd
</code>
805 binary, this column reports
<code><built-in
></code>. A
806 built-in datapath is by definition the same version as the rest of
807 the Open VSwitch userspace.
811 Other datapaths (such as the Hyper-V kernel datapath) currently
812 report
<code><unknown
></code>.
817 A version discrepancy between
<code>ovs-vswitchd
</code> and the
818 datapath in use is not normally cause for alarm. The Open vSwitch
819 kernel datapaths for Linux and Hyper-V, in particular, are designed
820 for maximum inter-version compatibility: any userspace version works
821 with with any kernel version. Some reasons do exist to insist on
822 particular user/kernel pairings. First, newer kernel versions add
823 new features, that can only be used by new-enough userspace, e.g.
824 VXLAN tunneling requires certain minimal userspace and kernel
825 versions. Second, as an extension to the first reason, some newer
826 kernel versions add new features for enhancing performance that only
827 new-enough userspace versions can take advantage of.
831 <column name=
"other_config" key=
"datapath-id">
832 Exactly
16 hex digits to set the OpenFlow datapath ID to a specific
833 value. May not be all-zero.
836 <column name=
"other_config" key=
"dp-desc">
837 Human readable description of datapath. It it a maximum
256
838 byte-long free-form string to describe the datapath for
839 debugging purposes, e.g.
<code>switch3 in room
3120</code>.
842 <column name=
"other_config" key=
"disable-in-band"
843 type='{
"type":
"boolean"}'
>
844 If set to
<code>true
</code>, disable in-band control on the bridge
845 regardless of controller and manager settings.
848 <column name=
"other_config" key=
"in-band-queue"
849 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
850 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
851 that will be used by flows set up by in-band control on this bridge.
852 If unset, or if the port used by an in-band control flow does not have
853 QoS configured, or if the port does not have a queue with the specified
854 ID, the default queue is used instead.
857 <column name=
"protocols">
859 List of OpenFlow protocols that may be used when negotiating
860 a connection with a controller. OpenFlow
1.0,
1.1,
1.2, and
861 1.3 are enabled by default if this column is empty.
865 OpenFlow
1.4,
1.5, and
1.6 are not enabled by default because their
866 implementations are missing features. In addition, the OpenFlow
1.6
867 specification is still under development and thus subject to change.
872 <group title=
"Spanning Tree Configuration">
874 The IEEE
802.1D Spanning Tree Protocol (STP) is a network protocol
875 that ensures loop-free topologies. It allows redundant links to
876 be included in the network to provide automatic backup paths if
877 the active links fails.
881 These settings configure the slower-to-converge but still widely
882 supported version of Spanning Tree Protocol, sometimes known as
883 802.1D-
1998. Open vSwitch also supports the newer Rapid Spanning Tree
884 Protocol (RSTP), documented later in the section titled
<code>Rapid
885 Spanning Tree Configuration
</code>.
888 <group title=
"STP Configuration">
889 <column name=
"stp_enable" type='{
"type":
"boolean"}'
>
891 Enable spanning tree on the bridge. By default, STP is disabled
892 on bridges. Bond, internal, and mirror ports are not supported
893 and will not participate in the spanning tree.
897 STP and RSTP are mutually exclusive. If both are enabled, RSTP
902 <column name=
"other_config" key=
"stp-system-id">
903 The bridge's STP identifier (the lower
48 bits of the bridge-id)
905 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
906 By default, the identifier is the MAC address of the bridge.
909 <column name=
"other_config" key=
"stp-priority"
910 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
911 The bridge's relative priority value for determining the root
912 bridge (the upper
16 bits of the bridge-id). A bridge with the
913 lowest bridge-id is elected the root. By default, the priority
917 <column name=
"other_config" key=
"stp-hello-time"
918 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
919 The interval between transmissions of hello messages by
920 designated ports, in seconds. By default the hello interval is
924 <column name=
"other_config" key=
"stp-max-age"
925 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
926 The maximum age of the information transmitted by the bridge
927 when it is the root bridge, in seconds. By default, the maximum
931 <column name=
"other_config" key=
"stp-forward-delay"
932 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
933 The delay to wait between transitioning root and designated
934 ports to
<code>forwarding
</code>, in seconds. By default, the
935 forwarding delay is
15 seconds.
938 <column name=
"other_config" key=
"mcast-snooping-aging-time"
939 type='{
"type":
"integer",
"minInteger":
1}'
>
941 The maximum number of seconds to retain a multicast snooping entry for
942 which no packets have been seen. The default is currently
300
943 seconds (
5 minutes). The value, if specified, is forced into a
944 reasonable range, currently
15 to
3600 seconds.
948 <column name=
"other_config" key=
"mcast-snooping-table-size"
949 type='{
"type":
"integer",
"minInteger":
1}'
>
951 The maximum number of multicast snooping addresses to learn. The
952 default is currently
2048. The value, if specified, is forced into
953 a reasonable range, currently
10 to
1,
000,
000.
956 <column name=
"other_config" key=
"mcast-snooping-disable-flood-unregistered"
957 type='{
"type":
"boolean"}'
>
959 If set to
<code>false
</code>, unregistered multicast packets are forwarded
961 If set to
<code>true
</code>, unregistered multicast packets are forwarded
962 to ports connected to multicast routers.
967 <group title=
"STP Status">
969 These key-value pairs report the status of
802.1D-
1998. They are
970 present only if STP is enabled (via the
<ref column=
"stp_enable"/>
973 <column name=
"status" key=
"stp_bridge_id">
974 The bridge ID used in spanning tree advertisements, in the form
975 <var>xxxx
</var>.
<var>yyyyyyyyyyyy
</var> where the
<var>x
</var>s are
976 the STP priority, the
<var>y
</var>s are the STP system ID, and each
977 <var>x
</var> and
<var>y
</var> is a hex digit.
979 <column name=
"status" key=
"stp_designated_root">
980 The designated root for this spanning tree, in the same form as
<ref
981 column=
"status" key=
"stp_bridge_id"/>. If this bridge is the root,
982 this will have the same value as
<ref column=
"status"
983 key=
"stp_bridge_id"/>, otherwise it will differ.
985 <column name=
"status" key=
"stp_root_path_cost">
986 The path cost of reaching the designated bridge. A lower number is
987 better. The value is
0 if this bridge is the root, otherwise it is
993 <group title=
"Rapid Spanning Tree">
995 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
996 that ensures loop-free topologies. RSTP superseded STP with the
997 publication of
802.1D-
2004. Compared to STP, RSTP converges more
998 quickly and recovers more quickly from failures.
1001 <group title=
"RSTP Configuration">
1002 <column name=
"rstp_enable" type='{
"type":
"boolean"}'
>
1004 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
1005 on bridges. Bond, internal, and mirror ports are not supported
1006 and will not participate in the spanning tree.
1010 STP and RSTP are mutually exclusive. If both are enabled, RSTP
1015 <column name=
"other_config" key=
"rstp-address">
1016 The bridge's RSTP address (the lower
48 bits of the bridge-id)
1018 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
1019 By default, the address is the MAC address of the bridge.
1022 <column name=
"other_config" key=
"rstp-priority"
1023 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
61440}'
>
1024 The bridge's relative priority value for determining the root
1025 bridge (the upper
16 bits of the bridge-id). A bridge with the
1026 lowest bridge-id is elected the root. By default, the priority
1027 is
0x8000 (
32768). This value needs to be a multiple of
4096,
1028 otherwise it's rounded to the nearest inferior one.
1031 <column name=
"other_config" key=
"rstp-ageing-time"
1032 type='{
"type":
"integer",
"minInteger":
10,
"maxInteger":
1000000}'
>
1033 The Ageing Time parameter for the Bridge. The default value
1037 <column name=
"other_config" key=
"rstp-force-protocol-version"
1038 type='{
"type":
"integer"}'
>
1039 The Force Protocol Version parameter for the Bridge. This
1040 can take the value
0 (STP Compatibility mode) or
2
1041 (the default, normal operation).
1044 <column name=
"other_config" key=
"rstp-max-age"
1045 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
1046 The maximum age of the information transmitted by the Bridge
1047 when it is the Root Bridge. The default value is
20.
1050 <column name=
"other_config" key=
"rstp-forward-delay"
1051 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
1052 The delay used by STP Bridges to transition Root and Designated
1053 Ports to Forwarding. The default value is
15.
1056 <column name=
"other_config" key=
"rstp-transmit-hold-count"
1057 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
1058 The Transmit Hold Count used by the Port Transmit state machine
1059 to limit transmission rate. The default value is
6.
1063 <group title=
"RSTP Status">
1065 These key-value pairs report the status of
802.1D-
2004. They are
1066 present only if RSTP is enabled (via the
<ref column=
"rstp_enable"/>
1069 <column name=
"rstp_status" key=
"rstp_bridge_id">
1070 The bridge ID used in rapid spanning tree advertisements, in the form
1071 <var>x
</var>.
<var>yyy
</var>.
<var>zzzzzzzzzzzz
</var> where
1072 <var>x
</var> is the RSTP priority, the
<var>y
</var>s are a locally
1073 assigned system ID extension, the
<var>z
</var>s are the STP system
1074 ID, and each
<var>x
</var>,
<var>y
</var>, or
<var>z
</var> is a hex
1077 <column name=
"rstp_status" key=
"rstp_root_id">
1078 The root of this spanning tree, in the same form as
<ref
1079 column=
"rstp_status" key=
"rstp_bridge_id"/>. If this bridge is the
1080 root, this will have the same value as
<ref column=
"rstp_status"
1081 key=
"rstp_bridge_id"/>, otherwise it will differ.
1083 <column name=
"rstp_status" key=
"rstp_root_path_cost"
1084 type='{
"type":
"integer",
"minInteger":
0}'
>
1085 The path cost of reaching the root. A lower number is better. The
1086 value is
0 if this bridge is the root, otherwise it is higher.
1088 <column name=
"rstp_status" key=
"rstp_designated_id">
1089 The RSTP designated ID, in the same form as
<ref column=
"rstp_status"
1090 key=
"rstp_bridge_id"/>.
1092 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1093 The RSTP designated port ID, as a
4-digit hex number.
1095 <column name=
"rstp_status" key=
"rstp_bridge_port_id">
1096 The RSTP bridge port ID, as a
4-digit hex number.
1101 <group title=
"Multicast Snooping Configuration">
1102 Multicast snooping (RFC
4541) monitors the Internet Group Management
1103 Protocol (IGMP) and Multicast Listener Discovery traffic between hosts
1104 and multicast routers. The switch uses what IGMP and MLD snooping
1105 learns to forward multicast traffic only to interfaces that are connected
1106 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
1107 MLDv1 and MLDv2 protocols.
1109 <column name=
"mcast_snooping_enable">
1110 Enable multicast snooping on the bridge. For now, the default
1115 <group title=
"Other Features">
1116 <column name=
"datapath_type">
1117 Name of datapath provider. The kernel datapath has type
1118 <code>system
</code>. The userspace datapath has type
1119 <code>netdev
</code>. A manager may refer to the
<ref
1120 table=
"Open_vSwitch" column=
"datapath_types"/> column of the
<ref
1121 table=
"Open_vSwitch"/> table for a list of the types accepted by this
1122 Open vSwitch instance.
1125 <column name=
"external_ids" key=
"bridge-id">
1126 A unique identifier of the bridge. On Citrix XenServer this will
1127 commonly be the same as
1128 <ref column=
"external_ids" key=
"xs-network-uuids"/>.
1131 <column name=
"external_ids" key=
"xs-network-uuids">
1132 Semicolon-delimited set of universally unique identifier(s) for the
1133 network with which this bridge is associated on a Citrix XenServer
1134 host. The network identifiers are RFC
4122 UUIDs as displayed by,
1135 e.g.,
<code>xe network-list
</code>.
1138 <column name=
"other_config" key=
"hwaddr">
1139 An Ethernet address in the form
1140 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
1141 to set the hardware address of the local port and influence the
1145 <column name=
"other_config" key=
"forward-bpdu"
1146 type='{
"type":
"boolean"}'
>
1149 Controls forwarding of BPDUs and other network control frames when
1150 NORMAL action is invoked. When this option is
<code>false
</code> or
1151 unset, frames with reserved Ethernet addresses (see table below) will
1152 not be forwarded. When this option is
<code>true
</code>, such frames
1153 will not be treated specially.
1157 The above general rule has the following exceptions:
1162 If STP is enabled on the bridge (see the
<ref column=
"stp_enable"
1163 table=
"Bridge"/> column in the
<ref table=
"Bridge"/> table), the
1164 bridge processes all received STP packets and never passes them to
1165 OpenFlow or forwards them. This is true even if STP is disabled on
1170 If LLDP is enabled on an interface (see the
<ref column=
"lldp"
1171 table=
"Interface"/> column in the
<ref table=
"Interface"/> table),
1172 the interface processes received LLDP packets and never passes them
1173 to OpenFlow or forwards them.
1178 Set this option to
<code>true
</code> if the Open vSwitch bridge
1179 connects different Ethernet networks and is not configured to
1184 This option affects packets with the following destination MAC
1189 <dt><code>01:
80:c2:
00:
00:
00</code></dt>
1190 <dd>IEEE
802.1D Spanning Tree Protocol (STP).
</dd>
1192 <dt><code>01:
80:c2:
00:
00:
01</code></dt>
1193 <dd>IEEE Pause frame.
</dd>
1195 <dt><code>01:
80:c2:
00:
00:
0<var>x
</var></code></dt>
1196 <dd>Other reserved protocols.
</dd>
1198 <dt><code>00:e0:
2b:
00:
00:
00</code></dt>
1199 <dd>Extreme Discovery Protocol (EDP).
</dd>
1202 <code>00:e0:
2b:
00:
00:
04</code> and
<code>00:e0:
2b:
00:
00:
06</code>
1204 <dd>Ethernet Automatic Protection Switching (EAPS).
</dd>
1206 <dt><code>01:
00:
0c:cc:cc:cc
</code></dt>
1208 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1209 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1213 <dt><code>01:
00:
0c:cc:cc:cd
</code></dt>
1214 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.
</dd>
1216 <dt><code>01:
00:
0c:cd:cd:cd
</code></dt>
1217 <dd>Cisco STP Uplink Fast.
</dd>
1219 <dt><code>01:
00:
0c:
00:
00:
00</code></dt>
1220 <dd>Cisco Inter Switch Link.
</dd>
1222 <dt><code>01:
00:
0c:cc:cc:c
<var>x
</var></code></dt>
1227 <column name=
"other_config" key=
"mac-aging-time"
1228 type='{
"type":
"integer",
"minInteger":
1}'
>
1230 The maximum number of seconds to retain a MAC learning entry for
1231 which no packets have been seen. The default is currently
300
1232 seconds (
5 minutes). The value, if specified, is forced into a
1233 reasonable range, currently
15 to
3600 seconds.
1237 A short MAC aging time allows a network to more quickly detect that a
1238 host is no longer connected to a switch port. However, it also makes
1239 it more likely that packets will be flooded unnecessarily, when they
1240 are addressed to a connected host that rarely transmits packets. To
1241 reduce the incidence of unnecessary flooding, use a MAC aging time
1242 longer than the maximum interval at which a host will ordinarily
1247 <column name=
"other_config" key=
"mac-table-size"
1248 type='{
"type":
"integer",
"minInteger":
1}'
>
1250 The maximum number of MAC addresses to learn. The default is
1251 currently
2048. The value, if specified, is forced into a reasonable
1252 range, currently
10 to
1,
000,
000.
1257 <group title=
"Common Columns">
1258 The overall purpose of these columns is described under
<code>Common
1259 Columns
</code> at the beginning of this document.
1261 <column name=
"other_config"/>
1262 <column name=
"external_ids"/>
1266 <table name=
"Port" table=
"Port or bond configuration.">
1267 <p>A port within a
<ref table=
"Bridge"/>.
</p>
1268 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1269 <ref column=
"interfaces"/> column. Such a port logically
1270 corresponds to a port on a physical Ethernet switch. A port
1271 with more than one interface is a ``bonded port'' (see
1272 <ref group=
"Bonding Configuration"/>).
</p>
1273 <p>Some properties that one might think as belonging to a port are actually
1274 part of the port's
<ref table=
"Interface"/> members.
</p>
1276 <column name=
"name">
1277 Port name. For a non-bonded port, this should be the same as its
1278 interface's name. Port names must otherwise be unique among the names of
1279 ports, interfaces, and bridges on a host. Because port and interfaces
1280 names are usually the same, the restrictions on the
<ref
1281 table=
"Interface" column=
"name"/> column in the
<ref table=
"Interface"/>
1282 table, particularly on length, also apply to port names. Refer to the
1283 documentation for
<ref table=
"Interface"/> names for details.
1286 <column name=
"interfaces">
1287 The port's interfaces. If there is more than one, this is a
1291 <group title=
"VLAN Configuration">
1293 In short, a VLAN (short for ``virtual LAN'') is a way to partition a
1294 single switch into multiple switches. VLANs can be confusing, so for
1295 an introduction, please refer to the question ``What's a VLAN?'' in the
1300 A VLAN is sometimes encoded into a packet using a
802.1Q or
802.1ad
1301 VLAN header, but every packet is part of some VLAN whether or not it is
1302 encoded in the packet. (A packet that appears to have no VLAN is part
1303 of VLAN
0, by default.) As a result, it's useful to think of a VLAN as
1304 a metadata property of a packet, separate from how the VLAN is encoded.
1305 For a given port, this column determines how the encoding of a packet
1306 that ingresses or egresses the port maps to the packet's VLAN. When a
1307 packet enters the switch, its VLAN is determined based on its setting
1308 in this column and its VLAN headers, if any, and then, conceptually,
1309 the VLAN headers are then stripped off. Conversely, when a packet
1310 exits the switch, its VLAN and the settings in this column determine
1311 what VLAN headers, if any, are pushed onto the packet before it
1316 The VLAN configuration in this column affects Open vSwitch only when it
1317 is doing ``normal switching.'' It does not affect flows set up by an
1318 OpenFlow controller, outside of the OpenFlow ``normal action.''
1322 Bridge ports support the following types of VLAN configuration:
1329 A trunk port carries packets on one or more specified VLANs
1330 specified in the
<ref column=
"trunks"/> column (often, on every
1331 VLAN). A packet that ingresses on a trunk port is in the VLAN
1332 specified in its
802.1Q header, or VLAN
0 if the packet has no
1333 802.1Q header. A packet that egresses through a trunk port will
1334 have an
802.1Q header if it has a nonzero VLAN ID.
1338 Any packet that ingresses on a trunk port tagged with a VLAN that
1339 the port does not trunk is dropped.
1346 An access port carries packets on exactly one VLAN specified in the
1347 <ref column=
"tag"/> column. Packets egressing on an access port
1348 have no
802.1Q header.
1352 Any packet with an
802.1Q header with a nonzero VLAN ID that
1353 ingresses on an access port is dropped, regardless of whether the
1354 VLAN ID in the header is the access port's VLAN ID.
1358 <dt>native-tagged
</dt>
1360 A native-tagged port resembles a trunk port, with the exception that
1361 a packet without an
802.1Q header that ingresses on a native-tagged
1362 port is in the ``native VLAN'' (specified in the
<ref column=
"tag"/>
1366 <dt>native-untagged
</dt>
1368 A native-untagged port resembles a native-tagged port, with the
1369 exception that a packet that egresses on a native-untagged port in
1370 the native VLAN will not have an
802.1Q header.
1373 <dt>dot1q-tunnel
</dt>
1376 A dot1q-tunnel port is somewhat like an access port. Like an
1377 access port, it carries packets on the single VLAN specified in the
1378 <ref column=
"tag"/> column and this VLAN, called the service VLAN,
1379 does not appear in an
802.1Q header for packets that ingress or
1380 egress on the port. The main difference lies in the behavior when
1381 packets that include a
802.1Q header ingress on the port. Whereas
1382 an access port drops such packets, a dot1q-tunnel port treats these
1383 as double-tagged with the outer service VLAN
<ref column=
"tag"/>
1384 and the inner customer VLAN taken from the
802.1Q header.
1385 Correspondingly, to egress on the port, a packet outer VLAN (or
1386 only VLAN) must be
<ref column=
"tag"/>, which is removed before
1387 egress, which exposes the inner (customer) VLAN if one is present.
1391 If
<ref column=
"cvlans"/> is set, only allows packets in the
1392 specified customer VLANs.
1397 A packet will only egress through bridge ports that carry the VLAN of
1398 the packet, as described by the rules above.
1401 <column name=
"vlan_mode">
1403 The VLAN mode of the port, as described above. When this column is
1404 empty, a default mode is selected as follows:
1408 If
<ref column=
"tag"/> contains a value, the port is an access
1409 port. The
<ref column=
"trunks"/> column should be empty.
1412 Otherwise, the port is a trunk port. The
<ref column=
"trunks"/>
1413 column value is honored if it is present.
1420 For an access port, the port's implicitly tagged VLAN. For a
1421 native-tagged or native-untagged port, the port's native VLAN. Must
1422 be empty if this is a trunk port.
1426 <column name=
"trunks">
1428 For a trunk, native-tagged, or native-untagged port, the
802.1Q VLAN
1429 or VLANs that this port trunks; if it is empty, then the port trunks
1430 all VLANs. Must be empty if this is an access port.
1433 A native-tagged or native-untagged port always trunks its native
1434 VLAN, regardless of whether
<ref column=
"trunks"/> includes that
1439 <column name=
"cvlans">
1441 For a dot1q-tunnel port, the customer VLANs that this port includes.
1442 If this is empty, the port includes all customer VLANs.
1445 For other kinds of ports, this setting is ignored.
1449 <column name=
"other_config" key=
"qinq-ethtype"
1450 type='{
"type":
"string",
"enum": [
"set", [
"802.1ad",
"802.1q"]]}'
>
1452 For a dot1q-tunnel port, this is the TPID for the service tag, that
1453 is, for the
802.1Q header that contains the service VLAN ID. Because
1454 packets that actually ingress and egress a dot1q-tunnel port do not
1455 include an
802.1Q header for the service VLAN, this does not affect
1456 packets on the dot1q-tunnel port itself. Rather, it determines the
1457 service VLAN for a packet that ingresses on a dot1q-tunnel port and
1458 egresses on a trunk port.
1461 The value
<code>802.1ad
</code> specifies TPID
0x88a8, which is also
1462 the default if the setting is omitted. The value
<code>802.1q
</code>
1463 specifies TPID
0x8100.
1466 For other kinds of ports, this setting is ignored.
1470 <column name=
"other_config" key=
"priority-tags"
1471 type='{
"type":
"boolean"}'
>
1473 An
802.1Q header contains two important pieces of information: a VLAN
1474 ID and a priority. A frame with a zero VLAN ID, called a
1475 ``priority-tagged'' frame, is supposed to be treated the same way as
1476 a frame without an
802.1Q header at all (except for the priority).
1480 However, some network elements ignore any frame that has
802.1Q
1481 header at all, even when the VLAN ID is zero. Therefore, by default
1482 Open vSwitch does not output priority-tagged frames, instead omitting
1483 the
802.1Q header entirely if the VLAN ID is zero. Set this key to
1484 <code>true
</code> to enable priority-tagged frames on a port.
1488 Regardless of this setting, Open vSwitch omits the
802.1Q header on
1489 output if both the VLAN ID and priority would be zero.
1493 All frames output to native-tagged ports have a nonzero VLAN ID, so
1494 this setting is not meaningful on native-tagged ports.
1499 <group title=
"Bonding Configuration">
1500 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1501 allows for load balancing and fail-over.
</p>
1504 The following types of bonding will work with any kind of upstream
1505 switch. On the upstream switch, do not configure the interfaces as a
1510 <dt><code>balance-slb
</code></dt>
1512 Balances flows among slaves based on source MAC address and output
1513 VLAN, with periodic rebalancing as traffic patterns change.
1516 <dt><code>active-backup
</code></dt>
1518 Assigns all flows to one slave, failing over to a backup slave when
1519 the active slave is disabled. This is the only bonding mode in which
1520 interfaces may be plugged into different upstream switches.
1525 The following modes require the upstream switch to support
802.3ad with
1526 successful LACP negotiation. If LACP negotiation fails and
1527 other-config:lacp-fallback-ab is true, then
<code>active-backup
</code>
1532 <dt><code>balance-tcp
</code></dt>
1534 Balances flows among slaves based on L2, L3, and L4 protocol
1535 information such as destination MAC address, IP address, and TCP
1540 <p>These columns apply only to bonded ports. Their values are
1541 otherwise ignored.
</p>
1543 <column name=
"bond_mode">
1544 <p>The type of bonding used for a bonded port. Defaults to
1545 <code>active-backup
</code> if unset.
1549 <column name=
"other_config" key=
"bond-hash-basis"
1550 type='{
"type":
"integer"}'
>
1551 An integer hashed along with flows when choosing output slaves in load
1552 balanced bonds. When changed, all flows will be assigned different
1553 hash values possibly causing slave selection decisions to change. Does
1554 not affect bonding modes which do not employ load balancing such as
1555 <code>active-backup
</code>.
1558 <group title=
"Link Failure Detection">
1560 An important part of link bonding is detecting that links are down so
1561 that they may be disabled. These settings determine how Open vSwitch
1562 detects link failure.
1565 <column name=
"other_config" key=
"bond-detect-mode"
1566 type='{
"type":
"string",
"enum": [
"set", [
"carrier",
"miimon"]]}'
>
1567 The means used to detect link failures. Defaults to
1568 <code>carrier
</code> which uses each interface's carrier to detect
1569 failures. When set to
<code>miimon
</code>, will check for failures
1570 by polling each interface's MII.
1573 <column name=
"other_config" key=
"bond-miimon-interval"
1574 type='{
"type":
"integer"}'
>
1575 The interval, in milliseconds, between successive attempts to poll
1576 each interface's MII. Relevant only when
<ref column=
"other_config"
1577 key=
"bond-detect-mode"/> is
<code>miimon
</code>.
1580 <column name=
"bond_updelay">
1582 The number of milliseconds for which the link must stay up on an
1583 interface before the interface is considered to be up. Specify
1584 <code>0</code> to enable the interface immediately.
1588 This setting is honored only when at least one bonded interface is
1589 already enabled. When no interfaces are enabled, then the first
1590 bond interface to come up is enabled immediately.
1594 <column name=
"bond_downdelay">
1595 The number of milliseconds for which the link must stay down on an
1596 interface before the interface is considered to be down. Specify
1597 <code>0</code> to disable the interface immediately.
1601 <group title=
"LACP Configuration">
1603 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1604 allows switches to automatically detect that they are connected by
1605 multiple links and aggregate across those links. These settings
1606 control LACP behavior.
1609 <column name=
"lacp">
1610 Configures LACP on this port. LACP allows directly connected
1611 switches to negotiate which links may be bonded. LACP may be enabled
1612 on non-bonded ports for the benefit of any switches they may be
1613 connected to.
<code>active
</code> ports are allowed to initiate LACP
1614 negotiations.
<code>passive
</code> ports are allowed to participate
1615 in LACP negotiations initiated by a remote switch, but not allowed to
1616 initiate such negotiations themselves. If LACP is enabled on a port
1617 whose partner switch does not support LACP, the bond will be
1618 disabled, unless other-config:lacp-fallback-ab is set to true.
1619 Defaults to
<code>off
</code> if unset.
1622 <column name=
"other_config" key=
"lacp-system-id">
1623 The LACP system ID of this
<ref table=
"Port"/>. The system ID of a
1624 LACP bond is used to identify itself to its partners. Must be a
1625 nonzero MAC address. Defaults to the bridge Ethernet address if
1629 <column name=
"other_config" key=
"lacp-system-priority"
1630 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
1631 The LACP system priority of this
<ref table=
"Port"/>. In LACP
1632 negotiations, link status decisions are made by the system with the
1633 numerically lower priority.
1636 <column name=
"other_config" key=
"lacp-time"
1637 type='{
"type":
"string",
"enum": [
"set", [
"fast",
"slow"]]}'
>
1639 The LACP timing which should be used on this
<ref table=
"Port"/>.
1640 By default
<code>slow
</code> is used. When configured to be
1641 <code>fast
</code> LACP heartbeats are requested at a rate of once
1642 per second causing connectivity problems to be detected more
1643 quickly. In
<code>slow
</code> mode, heartbeats are requested at a
1644 rate of once every
30 seconds.
1648 <column name=
"other_config" key=
"lacp-fallback-ab"
1649 type='{
"type":
"boolean"}'
>
1651 Determines the behavior of openvswitch bond in LACP mode. If
1652 the partner switch does not support LACP, setting this option
1653 to
<code>true
</code> allows openvswitch to fallback to
1654 active-backup. If the option is set to
<code>false
</code>, the
1655 bond will be disabled. In both the cases, once the partner switch
1656 is configured to LACP mode, the bond will use LACP.
1661 <group title=
"Rebalancing Configuration">
1663 These settings control behavior when a bond is in
1664 <code>balance-slb
</code> or
<code>balance-tcp
</code> mode.
1667 <column name=
"other_config" key=
"bond-rebalance-interval"
1668 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
10000}'
>
1669 For a load balanced bonded port, the number of milliseconds between
1670 successive attempts to rebalance the bond, that is, to move flows
1671 from one interface on the bond to another in an attempt to keep usage
1672 of each interface roughly equal. If zero, load balancing is disabled
1673 on the bond (link failure still cause flows to move). If
1674 less than
1000ms, the rebalance interval will be
1000ms.
1678 <column name=
"bond_fake_iface">
1679 For a bonded port, whether to create a fake internal interface with the
1680 name of the port. Use only for compatibility with legacy software that
1685 <group title=
"Spanning Tree Protocol">
1687 The configuration here is only meaningful, and the status is only
1688 populated, when
802.1D-
1998 Spanning Tree Protocol is enabled on the
1689 port's
<ref column=
"Bridge"/> with its
<ref column=
"stp_enable"/>
1693 <group title=
"STP Configuration">
1694 <column name=
"other_config" key=
"stp-enable"
1695 type='{
"type":
"boolean"}'
>
1696 When STP is enabled on a bridge, it is enabled by default on all of
1697 the bridge's ports except bond, internal, and mirror ports (which do
1698 not work with STP). If this column's value is
<code>false
</code>,
1699 STP is disabled on the port.
1702 <column name=
"other_config" key=
"stp-port-num"
1703 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
255}'
>
1704 The port number used for the lower
8 bits of the port-id. By
1705 default, the numbers will be assigned automatically. If any
1706 port's number is manually configured on a bridge, then they
1710 <column name=
"other_config" key=
"stp-port-priority"
1711 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
255}'
>
1712 The port's relative priority value for determining the root
1713 port (the upper
8 bits of the port-id). A port with a lower
1714 port-id will be chosen as the root port. By default, the
1718 <column name=
"other_config" key=
"stp-path-cost"
1719 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
1720 Spanning tree path cost for the port. A lower number indicates
1721 a faster link. By default, the cost is based on the maximum
1726 <group title=
"STP Status">
1727 <column name=
"status" key=
"stp_port_id">
1728 The port ID used in spanning tree advertisements for this port, as
4
1729 hex digits. Configuring the port ID is described in the
1730 <code>stp-port-num
</code> and
<code>stp-port-priority
</code> keys of
1731 the
<code>other_config
</code> section earlier.
1733 <column name=
"status" key=
"stp_state"
1734 type='{
"type":
"string",
"enum": [
"set",
1735 [
"disabled",
"listening",
"learning",
1736 "forwarding",
"blocking"]]}'
>
1737 STP state of the port.
1739 <column name=
"status" key=
"stp_sec_in_state"
1740 type='{
"type":
"integer",
"minInteger":
0}'
>
1741 The amount of time this port has been in the current STP state, in
1744 <column name=
"status" key=
"stp_role"
1745 type='{
"type":
"string",
"enum": [
"set",
1746 [
"root",
"designated",
"alternate"]]}'
>
1747 STP role of the port.
1752 <group title=
"Rapid Spanning Tree Protocol">
1754 The configuration here is only meaningful, and the status and
1755 statistics are only populated, when
802.1D-
1998 Spanning Tree Protocol
1756 is enabled on the port's
<ref column=
"Bridge"/> with its
<ref
1757 column=
"stp_enable"/> column.
1760 <group title=
"RSTP Configuration">
1761 <column name=
"other_config" key=
"rstp-enable"
1762 type='{
"type":
"boolean"}'
>
1763 When RSTP is enabled on a bridge, it is enabled by default on all of
1764 the bridge's ports except bond, internal, and mirror ports (which do
1765 not work with RSTP). If this column's value is
<code>false
</code>,
1766 RSTP is disabled on the port.
1769 <column name=
"other_config" key=
"rstp-port-priority"
1770 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
240}'
>
1771 The port's relative priority value for determining the root port, in
1772 multiples of
16. By default, the port priority is
0x80 (
128). Any
1773 value in the lower
4 bits is rounded off. The significant upper
4
1774 bits become the upper
4 bits of the port-id. A port with the lowest
1775 port-id is elected as the root.
1778 <column name=
"other_config" key=
"rstp-port-num"
1779 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
1780 The local RSTP port number, used as the lower
12 bits of the port-id.
1781 By default the port numbers are assigned automatically, and typically
1782 may not correspond to the OpenFlow port numbers. A port with the
1783 lowest port-id is elected as the root.
1786 <column name=
"other_config" key=
"rstp-port-path-cost"
1787 type='{
"type":
"integer"}'
>
1788 The port path cost. The Port's contribution, when it is
1789 the Root Port, to the Root Path Cost for the Bridge. By default the
1790 cost is automatically calculated from the port's speed.
1793 <column name=
"other_config" key=
"rstp-port-admin-edge"
1794 type='{
"type":
"boolean"}'
>
1795 The admin edge port parameter for the Port. Default is
1799 <column name=
"other_config" key=
"rstp-port-auto-edge"
1800 type='{
"type":
"boolean"}'
>
1801 The auto edge port parameter for the Port. Default is
1805 <column name=
"other_config" key=
"rstp-port-mcheck"
1806 type='{
"type":
"boolean"}'
>
1808 The mcheck port parameter for the Port. Default is
1809 <code>false
</code>. May be set to force the Port Protocol
1810 Migration state machine to transmit RST BPDUs for a
1811 MigrateTime period, to test whether all STP Bridges on the
1812 attached LAN have been removed and the Port can continue to
1813 transmit RSTP BPDUs. Setting mcheck has no effect if the
1814 Bridge is operating in STP Compatibility mode.
1817 Changing the value from
<code>true
</code> to
1818 <code>false
</code> has no effect, but needs to be done if
1819 this behavior is to be triggered again by subsequently
1820 changing the value from
<code>false
</code> to
1826 <group title=
"RSTP Status">
1827 <column name=
"rstp_status" key=
"rstp_port_id">
1828 The port ID used in spanning tree advertisements for this port, as
4
1829 hex digits. Configuring the port ID is described in the
1830 <code>rstp-port-num
</code> and
<code>rstp-port-priority
</code> keys
1831 of the
<code>other_config
</code> section earlier.
1833 <column name=
"rstp_status" key=
"rstp_port_role"
1834 type='{
"type":
"string",
"enum": [
"set",
1835 [
"Root",
"Designated",
"Alternate",
"Backup",
"Disabled"]]}'
>
1836 RSTP role of the port.
1838 <column name=
"rstp_status" key=
"rstp_port_state"
1839 type='{
"type":
"string",
"enum": [
"set",
1840 [
"Disabled",
"Learning",
"Forwarding",
"Discarding"]]}'
>
1841 RSTP state of the port.
1843 <column name=
"rstp_status" key=
"rstp_designated_bridge_id">
1844 The port's RSTP designated bridge ID, in the same form as
<ref
1845 column=
"rstp_status" key=
"rstp_bridge_id"/> in the
<ref
1846 table=
"Bridge"/> table.
1848 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1849 The port's RSTP designated port ID, as
4 hex digits.
1851 <column name=
"rstp_status" key=
"rstp_designated_path_cost"
1852 type='{
"type":
"integer"}'
>
1853 The port's RSTP designated path cost. Lower is better.
1857 <group title=
"RSTP Statistics">
1858 <column name=
"rstp_statistics" key=
"rstp_tx_count">
1859 Number of RSTP BPDUs transmitted through this port.
1861 <column name=
"rstp_statistics" key=
"rstp_rx_count">
1862 Number of valid RSTP BPDUs received by this port.
1864 <column name=
"rstp_statistics" key=
"rstp_error_count">
1865 Number of invalid RSTP BPDUs received by this port.
1867 <column name=
"rstp_statistics" key=
"rstp_uptime">
1868 The duration covered by the other RSTP statistics, in seconds.
1873 <group title=
"Multicast Snooping">
1874 <column name=
"other_config" key=
"mcast-snooping-flood"
1875 type='{
"type":
"boolean"}'
>
1877 If set to
<code>true
</code>, multicast packets (except Reports) are
1878 unconditionally forwarded to the specific port.
1881 <column name=
"other_config" key=
"mcast-snooping-flood-reports"
1882 type='{
"type":
"boolean"}'
>
1884 If set to
<code>true
</code>, multicast Reports are unconditionally
1885 forwarded to the specific port.
1890 <group title=
"Other Features">
1892 Quality of Service configuration for this port.
1896 The MAC address to use for this port for the purpose of choosing the
1897 bridge's MAC address. This column does not necessarily reflect the
1898 port's actual MAC address, nor will setting it change the port's actual
1902 <column name=
"fake_bridge">
1903 Does this port represent a sub-bridge for its tagged VLAN within the
1904 Bridge? See ovs-vsctl(
8) for more information.
1907 <column name=
"protected" type='{
"type":
"boolean"}'
>
1908 The protected ports feature allows certain ports to be designated as
1909 protected. Traffic between protected ports is blocked. Protected
1910 ports can send traffic to unprotected ports. Unprotected ports can
1911 send traffic to any port.
1915 <column name=
"external_ids" key=
"fake-bridge-id-*">
1916 External IDs for a fake bridge (see the
<ref column=
"fake_bridge"/>
1917 column) are defined by prefixing a
<ref table=
"Bridge"/> <ref
1918 table=
"Bridge" column=
"external_ids"/> key with
1919 <code>fake-bridge-
</code>,
1920 e.g.
<code>fake-bridge-xs-network-uuids
</code>.
1923 <column name=
"other_config" key=
"transient"
1924 type='{
"type":
"boolean"}'
>
1926 If set to
<code>true
</code>, the port will be removed when
1927 <code>ovs-ctl start --delete-transient-ports
</code> is used.
1932 <column name=
"bond_active_slave">
1933 For a bonded port, record the mac address of the current active slave.
1936 <group title=
"Port Statistics">
1938 Key-value pairs that report port statistics. The update period
1939 is controlled by
<ref column=
"other_config"
1940 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
1942 <group title=
"Statistics: STP transmit and receive counters">
1943 <column name=
"statistics" key=
"stp_tx_count">
1944 Number of STP BPDUs sent on this port by the spanning
1947 <column name=
"statistics" key=
"stp_rx_count">
1948 Number of STP BPDUs received on this port and accepted by the
1949 spanning tree library.
1951 <column name=
"statistics" key=
"stp_error_count">
1952 Number of bad STP BPDUs received on this port. Bad BPDUs
1953 include runt packets and those with an unexpected protocol ID.
1958 <group title=
"Common Columns">
1959 The overall purpose of these columns is described under
<code>Common
1960 Columns
</code> at the beginning of this document.
1962 <column name=
"other_config"/>
1963 <column name=
"external_ids"/>
1967 <table name=
"Interface" title=
"One physical network device in a Port.">
1968 An interface within a
<ref table=
"Port"/>.
1970 <group title=
"Core Features">
1971 <column name=
"name">
1973 Interface name. Should be alphanumeric. For non-bonded port, this
1974 should be the same as the port name. It must otherwise be unique
1975 among the names of ports, interfaces, and bridges on a host.
1979 The maximum length of an interface name depends on the underlying
1985 The names of interfaces implemented as Linux and BSD network
1986 devices, including interfaces with type
<code>internal
</code>,
1987 <code>tap
</code>, or
<code>system
</code> plus the different types
1988 of tunnel ports, are limited to
15 bytes. Windows limits these
1993 The names of patch ports are not used in the underlying datapath,
1994 so operating system restrictions do not apply. Thus, they may have
2000 Regardless of other restrictions, OpenFlow only supports
15-byte
2001 names, which means that
<code>ovs-ofctl
</code> and OpenFlow
2002 controllers will show names truncated to
15 bytes.
2006 <column name=
"ifindex">
2007 A positive interface index as defined for SNMP MIB-II in RFCs
1213 and
2008 2863, if the interface has one, otherwise
0. The ifindex is useful for
2009 seamless integration with protocols such as SNMP and sFlow.
2012 <column name=
"mac_in_use">
2013 The MAC address in use by this interface.
2017 <p>Ethernet address to set for this interface. If unset then the
2018 default MAC address is used:
</p>
2020 <li>For the local interface, the default is the lowest-numbered MAC
2021 address among the other bridge ports, either the value of the
2022 <ref table=
"Port" column=
"mac"/> in its
<ref table=
"Port"/> record,
2023 if set, or its actual MAC (for bonded ports, the MAC of its slave
2024 whose name is first in alphabetical order). Internal ports and
2025 bridge ports that are used as port mirroring destinations (see the
2026 <ref table=
"Mirror"/> table) are ignored.
</li>
2027 <li>For other internal interfaces, the default MAC is randomly
2029 <li>External interfaces typically have a MAC address associated with
2030 their hardware.
</li>
2032 <p>Some interfaces may not have a software-controllable MAC
2036 <column name=
"error">
2037 If the configuration of the port failed, as indicated by -
1 in
<ref
2038 column=
"ofport"/>, Open vSwitch sets this column to an error
2039 description in human readable form. Otherwise, Open vSwitch clears
2043 <group title=
"OpenFlow Port Number">
2045 When a client adds a new interface, Open vSwitch chooses an OpenFlow
2046 port number for the new port. If the client that adds the port fills
2047 in
<ref column=
"ofport_request"/>, then Open vSwitch tries to use its
2048 value as the OpenFlow port number. Otherwise, or if the requested
2049 port number is already in use or cannot be used for another reason,
2050 Open vSwitch automatically assigns a free port number. Regardless of
2051 how the port number was obtained, Open vSwitch then reports in
<ref
2052 column=
"ofport"/> the port number actually assigned.
2056 Open vSwitch limits the port numbers that it automatically assigns to
2057 the range
1 through
32,
767, inclusive. Controllers therefore have
2058 free use of ports
32,
768 and up.
2061 <column name=
"ofport">
2063 OpenFlow port number for this interface. Open vSwitch sets this
2064 column's value, so other clients should treat it as read-only.
2067 The OpenFlow ``local'' port (
<code>OFPP_LOCAL
</code>) is
65,
534.
2068 The other valid port numbers are in the range
1 to
65,
279,
2069 inclusive. Value -
1 indicates an error adding the interface.
2073 <column name=
"ofport_request"
2074 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65279}'
>
2076 Requested OpenFlow port number for this interface.
2080 A client should ideally set this column's value in the same
2081 database transaction that it uses to create the interface. Open
2082 vSwitch version
2.1 and later will honor a later request for a
2083 specific port number, althuogh it might confuse some controllers:
2084 OpenFlow does not have a way to announce a port number change, so
2085 Open vSwitch represents it over OpenFlow as a port deletion
2086 followed immediately by a port addition.
2090 If
<ref column=
"ofport_request"/> is set or changed to some other
2091 port's automatically assigned port number, Open vSwitch chooses a
2092 new port number for the latter port.
2098 <group title=
"System-Specific Details">
2099 <column name=
"type">
2101 The interface type. The types supported by a particular instance of
2102 Open vSwitch are listed in the
<ref table=
"Open_vSwitch"
2103 column=
"iface_types"/> column in the
<ref table=
"Open_vSwitch"/>
2104 table. The following types are defined:
2108 <dt><code>system
</code></dt>
2109 <dd>An ordinary network device, e.g.
<code>eth0
</code> on Linux.
2110 Sometimes referred to as ``external interfaces'' since they are
2111 generally connected to hardware external to that on which the Open
2112 vSwitch is running. The empty string is a synonym for
2113 <code>system
</code>.
</dd>
2115 <dt><code>internal
</code></dt>
2116 <dd>A simulated network device that sends and receives traffic. An
2117 internal interface whose
<ref column=
"name"/> is the same as its
2118 bridge's
<ref table=
"Open_vSwitch" column=
"name"/> is called the
2119 ``local interface.'' It does not make sense to bond an internal
2120 interface, so the terms ``port'' and ``interface'' are often used
2121 imprecisely for internal interfaces.
</dd>
2123 <dt><code>tap
</code></dt>
2124 <dd>A TUN/TAP device managed by Open vSwitch.
</dd>
2126 <dt><code>geneve
</code></dt>
2128 An Ethernet over Geneve (
<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve
</code>)
2131 A description of how to match and set Geneve options can be found
2132 in the
<code>ovs-ofctl
</code> manual page.
2135 <dt><code>gre
</code></dt>
2137 An Ethernet over RFC
2890 Generic Routing Encapsulation over IPv4/IPv6
2141 <dt><code>vxlan
</code></dt>
2144 An Ethernet tunnel over the UDP-based VXLAN protocol described in
2148 Open vSwitch uses IANA-assigned UDP destination port
4789. The
2149 source port used for VXLAN traffic varies on a per-flow basis
2150 and is in the ephemeral port range.
2154 <dt><code>lisp
</code></dt>
2157 A layer
3 tunnel over the experimental, UDP-based Locator/ID
2158 Separation Protocol (RFC
6830).
2161 Only IPv4 and IPv6 packets are supported by the protocol, and
2162 they are sent and received without an Ethernet header. Traffic
2163 to/from LISP ports is expected to be configured explicitly, and
2164 the ports are not intended to participate in learning based
2165 switching. As such, they are always excluded from packet
2170 <dt><code>stt
</code></dt>
2172 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
2173 endpoints are in end-systems, as it utilizes the capabilities of
2174 standard network interface cards to improve performance. STT utilizes
2175 a TCP-like header inside the IP header. It is stateless, i.e., there is
2176 no TCP connection state of any kind associated with the tunnel. The
2177 TCP-like header is used to leverage the capabilities of existing
2178 network interface cards, but should not be interpreted as implying
2179 any sort of connection state between endpoints.
2180 Since the STT protocol does not engage in the usual TCP
3-way handshake,
2181 so it will have difficulty traversing stateful firewalls.
2182 The protocol is documented at
2183 https://tools.ietf.org/html/draft-davie-stt
2185 All traffic uses a default destination port of
7471.
2188 <dt><code>patch
</code></dt>
2190 A pair of virtual devices that act as a patch cable.
2193 <dt><code>null
</code></dt>
2194 <dd>An ignored interface. Deprecated and slated for removal in
2200 <group title=
"Tunnel Options">
2202 These options apply to interfaces with
<ref column=
"type"/> of
2203 <code>geneve
</code>,
<code>gre
</code>,
<code>vxlan
</code>,
2204 <code>lisp
</code> and
<code>stt
</code>.
2208 Each tunnel must be uniquely identified by the combination of
<ref
2209 column=
"type"/>,
<ref column=
"options" key=
"remote_ip"/>,
<ref
2210 column=
"options" key=
"local_ip"/>, and
<ref column=
"options"
2211 key=
"in_key"/>. If two ports are defined that are the same except one
2212 has an optional identifier and the other does not, the more specific
2213 one is matched first.
<ref column=
"options" key=
"in_key"/> is
2214 considered more specific than
<ref column=
"options" key=
"local_ip"/> if
2215 a port defines one and another port defines the other.
2218 <column name=
"options" key=
"remote_ip">
2219 <p>Required. The remote tunnel endpoint, one of:
</p>
2223 An IPv4 or IPv6 address (not a DNS name), e.g.
<code>192.168.0.123</code>.
2224 Only unicast endpoints are supported.
2227 The word
<code>flow
</code>. The tunnel accepts packets from any
2228 remote tunnel endpoint. To process only packets from a specific
2229 remote tunnel endpoint, the flow entries may match on the
2230 <code>tun_src
</code> or
<code>tun_ipv6_src
</code>field. When
2231 sending packets to a
<code>remote_ip=flow
</code> tunnel, the flow
2232 actions must explicitly set the
<code>tun_dst
</code> or
2233 <code>tun_ipv6_dst
</code> field to the IP address of the desired
2234 remote tunnel endpoint, e.g. with a
<code>set_field
</code> action.
2239 The remote tunnel endpoint for any packet received from a tunnel
2240 is available in the
<code>tun_src
</code> field for matching in the
2245 <column name=
"options" key=
"local_ip">
2247 Optional. The tunnel destination IP that received packets must
2248 match. Default is to match all addresses. If specified, may be one
2254 An IPv4/IPv6 address (not a DNS name), e.g.
<code>192.168.12.3</code>.
2257 The word
<code>flow
</code>. The tunnel accepts packets sent to any
2258 of the local IP addresses of the system running OVS. To process
2259 only packets sent to a specific IP address, the flow entries may
2260 match on the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code> field.
2261 When sending packets to a
<code>local_ip=flow
</code> tunnel, the flow
2262 actions may explicitly set the
<code>tun_src
</code> or
<code>tun_ipv6_src
</code>
2263 field to the desired IP address, e.g. with a
<code>set_field
</code> action.
2264 However, while routing the tunneled packet out, the local system may
2265 override the specified address with the local IP address configured for the
2266 outgoing system interface.
2269 This option is valid only for tunnels also configured with the
2270 <code>remote_ip=flow
</code> option.
2276 The tunnel destination IP address for any packet received from a
2277 tunnel is available in the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code>
2278 field for matching in the flow table.
2282 <column name=
"options" key=
"in_key">
2283 <p>Optional. The key that received packets must contain, one of:
</p>
2287 <code>0</code>. The tunnel receives packets with no key or with a
2288 key of
0. This is equivalent to specifying no
<ref column=
"options"
2289 key=
"in_key"/> at all.
2292 A positive
24-bit (for Geneve, VXLAN, and LISP),
32-bit (for GRE)
2293 or
64-bit (for STT) number. The tunnel receives only
2294 packets with the specified key.
2297 The word
<code>flow
</code>. The tunnel accepts packets with any
2298 key. The key will be placed in the
<code>tun_id
</code> field for
2299 matching in the flow table. The
<code>ovs-ofctl
</code> manual page
2300 contains additional information about matching fields in OpenFlow
2309 <column name=
"options" key=
"out_key">
2310 <p>Optional. The key to be set on outgoing packets, one of:
</p>
2314 <code>0</code>. Packets sent through the tunnel will have no key.
2315 This is equivalent to specifying no
<ref column=
"options"
2316 key=
"out_key"/> at all.
2319 A positive
24-bit (for Geneve, VXLAN and LISP),
32-bit (for GRE) or
2320 64-bit (for STT) number. Packets sent through the tunnel
2321 will have the specified key.
2324 The word
<code>flow
</code>. Packets sent through the tunnel will
2325 have the key set using the
<code>set_tunnel
</code> Nicira OpenFlow
2326 vendor extension (
0 is used in the absence of an action). The
2327 <code>ovs-ofctl
</code> manual page contains additional information
2328 about the Nicira OpenFlow vendor extensions.
2333 <column name=
"options" key=
"key">
2334 Optional. Shorthand to set
<code>in_key
</code> and
2335 <code>out_key
</code> at the same time.
2338 <column name=
"options" key=
"tos">
2339 Optional. The value of the ToS bits to be set on the encapsulating
2340 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2341 zero. It may also be the word
<code>inherit
</code>, in which case
2342 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2343 (otherwise it will be
0). The ECN fields are always inherited.
2347 <column name=
"options" key=
"ttl">
2348 Optional. The TTL to be set on the encapsulating packet. It may also
2349 be the word
<code>inherit
</code>, in which case the TTL will be copied
2350 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2351 system default, typically
64). Default is the system default TTL.
2354 <column name=
"options" key=
"df_default"
2355 type='{
"type":
"boolean"}'
>
2356 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2357 outer headers to allow path MTU discovery. Default is enabled; set
2358 to
<code>false
</code> to disable.
2361 <column name=
"options" key=
"egress_pkt_mark">
2362 Optional. The pkt_mark to be set on the encapsulating packet. This
2363 option sets packet mark for the tunnel endpoint for all tunnel packets
2364 including tunnel monitoring.
2367 <group title=
"Tunnel Options: vxlan only">
2369 <column name=
"options" key=
"exts">
2370 <p>Optional. Comma separated list of optional VXLAN extensions to
2371 enable. The following extensions are supported:
</p>
2375 <code>gbp
</code>: VXLAN-GBP allows to transport the group policy
2376 context of a packet across the VXLAN tunnel to other network
2377 peers. See the description of
<code>tun_gbp_id
</code> and
2378 <code>tun_gbp_flags
</code> in
<code>ovs-fields
</code>(
7) for
2379 additional information.
2380 (
<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy
</code>)
2387 <group title=
"Tunnel Options: gre, geneve, and vxlan">
2389 <code>gre
</code>,
<code>geneve
</code>, and
2390 <code>vxlan
</code> interfaces support these options.
2393 <column name=
"options" key=
"csum" type='{
"type":
"boolean"}'
>
2395 Optional. Compute encapsulation header (either GRE or UDP)
2396 checksums on outgoing packets. Default is disabled, set to
2397 <code>true
</code> to enable. Checksums present on incoming
2398 packets will be validated regardless of this setting.
2402 When using the upstream Linux kernel module, computation of
2403 checksums for
<code>geneve
</code> and
<code>vxlan
</code> requires
2404 Linux kernel version
4.0 or higher.
<code>gre
</code> supports
2405 checksums for all versions of Open vSwitch that support GRE.
2406 The out of tree kernel module distributed as part of OVS
2407 can compute all tunnel checksums on any kernel version that it
2415 <group title=
"Patch Options">
2417 Only
<code>patch
</code> interfaces support these options.
2420 <column name=
"options" key=
"peer">
2421 The
<ref column=
"name"/> of the
<ref table=
"Interface"/> for the other
2422 side of the patch. The named
<ref table=
"Interface"/>'s own
2423 <code>peer
</code> option must specify this
<ref table=
"Interface"/>'s
2424 name. That is, the two patch interfaces must have reversed
<ref
2425 column=
"name"/> and
<code>peer
</code> values.
2429 <group title=
"PMD (Poll Mode Driver) Options">
2431 Only PMD netdevs support these options.
2434 <column name=
"options" key=
"n_rxq"
2435 type='{
"type":
"integer",
"minInteger":
1}'
>
2437 Specifies the maximum number of rx queues to be created for PMD
2438 netdev. If not specified or specified to
0, one rx queue will
2439 be created by default.
2440 Not supported by DPDK vHost interfaces.
2444 <column name=
"options" key=
"dpdk-devargs"
2445 type='{
"type":
"string"}'
>
2447 Specifies the PCI address associated with the port for physical
2448 devices, or the virtual driver to be used for the port when a virtual
2449 PMD is intended to be used. For the latter, the argument string
2450 typically takes the form of eth_
<driver_name
><x
> where
2451 'driver_name' is a valid virtual DPDK PMD driver name and where 'x'
2452 lies in the range of
0 to RTE_MAX_ETHPORTS-
1.
2453 Only supported by the dpdk port type.
2457 <column name=
"other_config" key=
"pmd-rxq-affinity">
2458 <p>Specifies mapping of RX queues of this interface to CPU cores.
</p>
2459 <p>Value should be set in the following form:
</p>
2461 <code>other_config:pmd-rxq-affinity=
<rxq-affinity-list
></code>
2467 <rxq-affinity-list
> ::= NULL |
<non-empty-list
>
2470 <non-empty-list
> ::=
<affinity-pair
> |
2471 <affinity-pair
> ,
<non-empty-list
>
2474 <affinity-pair
> ::=
<queue-id
> :
<core-id
>
2480 <column name=
"options" key=
"vhost-server-path"
2481 type='{
"type":
"string"}'
>
2483 The value specifies the path to the socket associated with a vHost
2484 User client mode device that has been or will be created by QEMU.
2485 Only supported by dpdkvhostuserclient interfaces.
2489 <column name=
"options" key=
"n_rxq_desc"
2490 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4096}'
>
2492 Specifies the rx queue size (number rx descriptors) for dpdk ports.
2493 The value must be a power of
2, less than
4096 and supported
2494 by the hardware of the device being configured.
2495 If not specified or an incorrect value is specified,
2048 rx
2496 descriptors will be used by default.
2500 <column name=
"options" key=
"n_txq_desc"
2501 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4096}'
>
2503 Specifies the tx queue size (number tx descriptors) for dpdk ports.
2504 The value must be a power of
2, less than
4096 and supported
2505 by the hardware of the device being configured.
2506 If not specified or an incorrect value is specified,
2048 tx
2507 descriptors will be used by default.
2514 The MTU (maximum transmission unit) is the largest amount of data
2515 that can fit into a single Ethernet frame. The standard Ethernet
2516 MTU is
1500 bytes. Some physical media and many kinds of virtual
2517 interfaces can be configured with higher MTUs.
2521 A client may change an interface MTU by filling in
2522 <ref column=
"mtu_request"/>. Open vSwitch then reports in
2523 <ref column=
"mtu"/> the currently configured value.
2528 The currently configured MTU for the interface.
2532 This column will be empty for an interface that does not
2533 have an MTU as, for example, some kinds of tunnels do not.
2537 Open vSwitch sets this column's value, so other clients should treat
2542 <column name=
"mtu_request"
2543 type='{
"type":
"integer",
"minInteger":
1}'
>
2545 Requested MTU (Maximum Transmission Unit) for the interface. A client
2546 can fill this column to change the MTU of an interface.
2550 RFC
791 requires every internet module to be able to forward a
2551 datagram of
68 octets without further fragmentation. The maximum
2552 size of an IP packet is
65535 bytes.
2556 If this is not set and if the interface has
<code>internal
</code>
2557 type, Open vSwitch will change the MTU to match the minimum of the
2558 other interfaces in the bridge.
2564 <group title=
"Interface Status">
2566 Status information about interfaces attached to bridges, updated every
2567 5 seconds. Not all interfaces have all of these properties; virtual
2568 interfaces don't have a link speed, for example. Non-applicable
2569 columns will have empty values.
2571 <column name=
"admin_state">
2573 The administrative state of the physical network link.
2577 <column name=
"link_state">
2579 The observed state of the physical network link. This is ordinarily
2580 the link's carrier status. If the interface's
<ref table=
"Port"/> is
2581 a bond configured for miimon monitoring, it is instead the network
2582 link's miimon status.
2586 <column name=
"link_resets">
2588 The number of times Open vSwitch has observed the
2589 <ref column=
"link_state"/> of this
<ref table=
"Interface"/> change.
2593 <column name=
"link_speed">
2595 The negotiated speed of the physical network link.
2596 Valid values are positive integers greater than
0.
2600 <column name=
"duplex">
2602 The duplex mode of the physical network link.
2606 <column name=
"lacp_current">
2607 Boolean value indicating LACP status for this interface. If true, this
2608 interface has current LACP information about its LACP partner. This
2609 information may be used to monitor the health of interfaces in a LACP
2610 enabled port. This column will be empty if LACP is not enabled.
2613 <column name=
"status">
2614 Key-value pairs that report port status. Supported status values are
2615 <ref column=
"type"/>-dependent; some interfaces may not have a valid
2616 <ref column=
"status" key=
"driver_name"/>, for example.
2619 <column name=
"status" key=
"driver_name">
2620 The name of the device driver controlling the network adapter.
2623 <column name=
"status" key=
"driver_version">
2624 The version string of the device driver controlling the network
2628 <column name=
"status" key=
"firmware_version">
2629 The version string of the network adapter's firmware, if available.
2632 <column name=
"status" key=
"source_ip">
2633 The source IP address used for an IPv4/IPv6 tunnel end-point, such as
2637 <column name=
"status" key=
"tunnel_egress_iface">
2638 Egress interface for tunnels. Currently only relevant for tunnels
2639 on Linux systems, this column will show the name of the interface
2640 which is responsible for routing traffic destined for the configured
2641 <ref column=
"options" key=
"remote_ip"/>. This could be an internal
2642 interface such as a bridge port.
2645 <column name=
"status" key=
"tunnel_egress_iface_carrier"
2646 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
2647 Whether carrier is detected on
<ref column=
"status"
2648 key=
"tunnel_egress_iface"/>.
2652 <group title=
"Statistics">
2654 Key-value pairs that report interface statistics. The current
2655 implementation updates these counters periodically. The update period
2656 is controlled by
<ref column=
"other_config"
2657 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
2658 Future implementations may update them when an interface is created,
2659 when they are queried (e.g. using an OVSDB
<code>select
</code>
2660 operation), and just before an interface is deleted due to virtual
2661 interface hot-unplug or VM shutdown, and perhaps at other times, but
2662 not on any regular periodic basis.
2665 These are the same statistics reported by OpenFlow in its
<code>struct
2666 ofp_port_stats
</code> structure. If an interface does not support a
2667 given statistic, then that pair is omitted.
2669 <group title=
"Statistics: Successful transmit and receive counters">
2670 <column name=
"statistics" key=
"rx_packets">
2671 Number of received packets.
2673 <column name=
"statistics" key=
"rx_bytes">
2674 Number of received bytes.
2676 <column name=
"statistics" key=
"tx_packets">
2677 Number of transmitted packets.
2679 <column name=
"statistics" key=
"tx_bytes">
2680 Number of transmitted bytes.
2683 <group title=
"Statistics: Receive errors">
2684 <column name=
"statistics" key=
"rx_dropped">
2685 Number of packets dropped by RX.
2687 <column name=
"statistics" key=
"rx_frame_err">
2688 Number of frame alignment errors.
2690 <column name=
"statistics" key=
"rx_over_err">
2691 Number of packets with RX overrun.
2693 <column name=
"statistics" key=
"rx_crc_err">
2694 Number of CRC errors.
2696 <column name=
"statistics" key=
"rx_errors">
2697 Total number of receive errors, greater than or equal to the sum of
2701 <group title=
"Statistics: Transmit errors">
2702 <column name=
"statistics" key=
"tx_dropped">
2703 Number of packets dropped by TX.
2705 <column name=
"statistics" key=
"collisions">
2706 Number of collisions.
2708 <column name=
"statistics" key=
"tx_errors">
2709 Total number of transmit errors, greater than or equal to the sum of
2715 <group title=
"Ingress Policing">
2717 These settings control ingress policing for packets received on this
2718 interface. On a physical interface, this limits the rate at which
2719 traffic is allowed into the system from the outside; on a virtual
2720 interface (one connected to a virtual machine), this limits the rate at
2721 which the VM is able to transmit.
2724 Policing is a simple form of quality-of-service that simply drops
2725 packets received in excess of the configured rate. Due to its
2726 simplicity, policing is usually less accurate and less effective than
2727 egress QoS (which is configured using the
<ref table=
"QoS"/> and
<ref
2728 table=
"Queue"/> tables).
2731 Policing is currently implemented on Linux and OVS with DPDK. Both
2732 implementations use a simple ``token bucket'' approach:
2736 The size of the bucket corresponds to
<ref
2737 column=
"ingress_policing_burst"/>. Initially the bucket is full.
2740 Whenever a packet is received, its size (converted to tokens) is
2741 compared to the number of tokens currently in the bucket. If the
2742 required number of tokens are available, they are removed and the
2743 packet is forwarded. Otherwise, the packet is dropped.
2746 Whenever it is not full, the bucket is refilled with tokens at the
2747 rate specified by
<ref column=
"ingress_policing_rate"/>.
2751 Policing interacts badly with some network protocols, and especially
2752 with fragmented IP packets. Suppose that there is enough network
2753 activity to keep the bucket nearly empty all the time. Then this token
2754 bucket algorithm will forward a single packet every so often, with the
2755 period depending on packet size and on the configured rate. All of the
2756 fragments of an IP packets are normally transmitted back-to-back, as a
2757 group. In such a situation, therefore, only one of these fragments
2758 will be forwarded and the rest will be dropped. IP does not provide
2759 any way for the intended recipient to ask for only the remaining
2760 fragments. In such a case there are two likely possibilities for what
2761 will happen next: either all of the fragments will eventually be
2762 retransmitted (as TCP will do), in which case the same problem will
2763 recur, or the sender will not realize that its packet has been dropped
2764 and data will simply be lost (as some UDP-based protocols will do).
2765 Either way, it is possible that no forward progress will ever occur.
2767 <column name=
"ingress_policing_rate">
2769 Maximum rate for data received on this interface, in kbps. Data
2770 received faster than this rate is dropped. Set to
<code>0</code>
2771 (the default) to disable policing.
2775 <column name=
"ingress_policing_burst">
2776 <p>Maximum burst size for data received on this interface, in kb. The
2777 default burst size if set to
<code>0</code> is
8000 kbit. This value
2778 has no effect if
<ref column=
"ingress_policing_rate"/>
2779 is
<code>0</code>.
</p>
2781 Specifying a larger burst size lets the algorithm be more forgiving,
2782 which is important for protocols like TCP that react severely to
2783 dropped packets. The burst size should be at least the size of the
2784 interface's MTU. Specifying a value that is numerically at least as
2785 large as
80% of
<ref column=
"ingress_policing_rate"/> helps TCP come
2786 closer to achieving the full rate.
2791 <group title=
"Bidirectional Forwarding Detection (BFD)">
2793 BFD, defined in RFC
5880 and RFC
5881, allows point-to-point
2794 detection of connectivity failures by occasional transmission of
2795 BFD control messages. Open vSwitch implements BFD to serve
2796 as a more popular and standards compliant alternative to CFM.
2800 BFD operates by regularly transmitting BFD control messages at a rate
2801 negotiated independently in each direction. Each endpoint specifies
2802 the rate at which it expects to receive control messages, and the rate
2803 at which it is willing to transmit them. Open vSwitch uses a detection
2804 multiplier of three, meaning that an endpoint signals a connectivity
2805 fault if three consecutive BFD control messages fail to arrive. In the
2806 case of a unidirectional connectivity issue, the system not receiving
2807 BFD control messages signals the problem to its peer in the messages it
2812 The Open vSwitch implementation of BFD aims to comply faithfully
2813 with RFC
5880 requirements. Open vSwitch does not implement the
2814 optional Authentication or ``Echo Mode'' features.
2817 <group title=
"BFD Configuration">
2819 A controller sets up key-value pairs in the
<ref column=
"bfd"/>
2820 column to enable and configure BFD.
2823 <column name=
"bfd" key=
"enable" type='{
"type":
"boolean"}'
>
2824 True to enable BFD on this
<ref table=
"Interface"/>. If not
2825 specified, BFD will not be enabled by default.
2828 <column name=
"bfd" key=
"min_rx"
2829 type='{
"type":
"integer",
"minInteger":
1}'
>
2830 The shortest interval, in milliseconds, at which this BFD session
2831 offers to receive BFD control messages. The remote endpoint may
2832 choose to send messages at a slower rate. Defaults to
2836 <column name=
"bfd" key=
"min_tx"
2837 type='{
"type":
"integer",
"minInteger":
1}'
>
2838 The shortest interval, in milliseconds, at which this BFD session is
2839 willing to transmit BFD control messages. Messages will actually be
2840 transmitted at a slower rate if the remote endpoint is not willing to
2841 receive as quickly as specified. Defaults to
<code>100</code>.
2844 <column name=
"bfd" key=
"decay_min_rx" type='{
"type":
"integer"}'
>
2845 An alternate receive interval, in milliseconds, that must be greater
2846 than or equal to
<ref column=
"bfd" key=
"min_rx"/>. The
2847 implementation switches from
<ref column=
"bfd" key=
"min_rx"/> to
<ref
2848 column=
"bfd" key=
"decay_min_rx"/> when there is no obvious incoming
2849 data traffic at the interface, to reduce the CPU and bandwidth cost
2850 of monitoring an idle interface. This feature may be disabled by
2851 setting a value of
0. This feature is reset whenever
<ref
2852 column=
"bfd" key=
"decay_min_rx"/> or
<ref column=
"bfd" key=
"min_rx"/>
2856 <column name=
"bfd" key=
"forwarding_if_rx" type='{
"type":
"boolean"}'
>
2857 When
<code>true
</code>, traffic received on the
2858 <ref table=
"Interface"/> is used to indicate the capability of packet
2859 I/O. BFD control packets are still transmitted and received. At
2860 least one BFD control packet must be received every
100 *
<ref
2861 column=
"bfd" key=
"min_rx"/> amount of time. Otherwise, even if
2862 traffic are received, the
<ref column=
"bfd" key=
"forwarding"/>
2863 will be
<code>false
</code>.
2866 <column name=
"bfd" key=
"cpath_down" type='{
"type":
"boolean"}'
>
2867 Set to true to notify the remote endpoint that traffic should not be
2868 forwarded to this system for some reason other than a connectivty
2869 failure on the interface being monitored. The typical underlying
2870 reason is ``concatenated path down,'' that is, that connectivity
2871 beyond the local system is down. Defaults to false.
2874 <column name=
"bfd" key=
"check_tnl_key" type='{
"type":
"boolean"}'
>
2875 Set to true to make BFD accept only control messages with a tunnel
2876 key of zero. By default, BFD accepts control messages with any
2880 <column name=
"bfd" key=
"bfd_local_src_mac">
2881 Set to an Ethernet address in the form
2882 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2883 to set the MAC used as source for transmitted BFD packets. The
2884 default is the mac address of the BFD enabled interface.
2887 <column name=
"bfd" key=
"bfd_local_dst_mac">
2888 Set to an Ethernet address in the form
2889 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2890 to set the MAC used as destination for transmitted BFD packets. The
2891 default is
<code>00:
23:
20:
00:
00:
01</code>.
2894 <column name=
"bfd" key=
"bfd_remote_dst_mac">
2895 Set to an Ethernet address in the form
2896 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2897 to set the MAC used for checking the destination of received BFD packets.
2898 Packets with different destination MAC will not be considered as BFD packets.
2899 If not specified the destination MAC address of received BFD packets
2903 <column name=
"bfd" key=
"bfd_src_ip">
2904 Set to an IPv4 address to set the IP address used as source for
2905 transmitted BFD packets. The default is
<code>169.254.1.1</code>.
2908 <column name=
"bfd" key=
"bfd_dst_ip">
2909 Set to an IPv4 address to set the IP address used as destination
2910 for transmitted BFD packets. The default is
<code>169.254.1.0</code>.
2913 <column name=
"bfd" key=
"oam">
2914 Some tunnel protocols (such as Geneve) include a bit in the header
2915 to indicate that the encapsulated packet is an OAM frame. By setting
2916 this to true, BFD packets will be marked as OAM if encapsulated in
2917 one of these tunnels.
2921 <group title=
"BFD Status">
2923 The switch sets key-value pairs in the
<ref column=
"bfd_status"/>
2924 column to report the status of BFD on this interface. When BFD is
2925 not enabled, with
<ref column=
"bfd" key=
"enable"/>, the switch clears
2926 all key-value pairs from
<ref column=
"bfd_status"/>.
2929 <column name=
"bfd_status" key=
"state"
2930 type='{
"type":
"string",
2931 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
2932 Reports the state of the BFD session. The BFD session is fully
2933 healthy and negotiated if
<code>UP
</code>.
2936 <column name=
"bfd_status" key=
"forwarding" type='{
"type":
"boolean"}'
>
2937 Reports whether the BFD session believes this
<ref
2938 table=
"Interface"/> may be used to forward traffic. Typically this
2939 means the local session is signaling
<code>UP
</code>, and the remote
2940 system isn't signaling a problem such as concatenated path down.
2943 <column name=
"bfd_status" key=
"diagnostic">
2944 A diagnostic code specifying the local system's reason for the
2945 last change in session state. The error messages are defined in
2946 section
4.1 of [RFC
5880].
2949 <column name=
"bfd_status" key=
"remote_state"
2950 type='{
"type":
"string",
2951 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
2952 Reports the state of the remote endpoint's BFD session.
2955 <column name=
"bfd_status" key=
"remote_diagnostic">
2956 A diagnostic code specifying the remote system's reason for the
2957 last change in session state. The error messages are defined in
2958 section
4.1 of [RFC
5880].
2961 <column name=
"bfd_status" key=
"flap_count"
2962 type='{
"type":
"integer",
"minInteger":
0}'
>
2963 Counts the number of
<ref column=
"bfd_status" key=
"forwarding" />
2964 flaps since start. A flap is considered as a change of the
2965 <ref column=
"bfd_status" key=
"forwarding" /> value.
2970 <group title=
"Connectivity Fault Management">
2972 802.1ag Connectivity Fault Management (CFM) allows a group of
2973 Maintenance Points (MPs) called a Maintenance Association (MA) to
2974 detect connectivity problems with each other. MPs within a MA should
2975 have complete and exclusive interconnectivity. This is verified by
2976 occasionally broadcasting Continuity Check Messages (CCMs) at a
2977 configurable transmission interval.
2981 According to the
802.1ag specification, each Maintenance Point should
2982 be configured out-of-band with a list of Remote Maintenance Points it
2983 should have connectivity to. Open vSwitch differs from the
2984 specification in this area. It simply assumes the link is faulted if
2985 no Remote Maintenance Points are reachable, and considers it not
2990 When operating over tunnels which have no
<code>in_key
</code>, or an
2991 <code>in_key
</code> of
<code>flow
</code>. CFM will only accept CCMs
2992 with a tunnel key of zero.
2995 <column name=
"cfm_mpid">
2997 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2998 within a Maintenance Association. The MPID is used to identify this
2999 endpoint to other Maintenance Points in the MA. Each end of a link
3000 being monitored should have a different MPID. Must be configured to
3001 enable CFM on this
<ref table=
"Interface"/>.
3004 According to the
802.1ag specification, MPIDs can only range between
3005 [
1,
8191]. However, extended mode (see
<ref column=
"other_config"
3006 key=
"cfm_extended"/>) supports eight byte MPIDs.
3010 <column name=
"cfm_flap_count">
3011 Counts the number of cfm fault flapps since boot. A flap is
3012 considered to be a change of the
<ref column=
"cfm_fault"/> value.
3015 <column name=
"cfm_fault">
3017 Indicates a connectivity fault triggered by an inability to receive
3018 heartbeats from any remote endpoint. When a fault is triggered on
3019 <ref table=
"Interface"/>s participating in bonds, they will be
3023 Faults can be triggered for several reasons. Most importantly they
3024 are triggered when no CCMs are received for a period of
3.5 times the
3025 transmission interval. Faults are also triggered when any CCMs
3026 indicate that a Remote Maintenance Point is not receiving CCMs but
3027 able to send them. Finally, a fault is triggered if a CCM is
3028 received which indicates unexpected configuration. Notably, this
3029 case arises when a CCM is received which advertises the local MPID.
3033 <column name=
"cfm_fault_status" key=
"recv">
3034 Indicates a CFM fault was triggered due to a lack of CCMs received on
3035 the
<ref table=
"Interface"/>.
3038 <column name=
"cfm_fault_status" key=
"rdi">
3039 Indicates a CFM fault was triggered due to the reception of a CCM with
3040 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
3041 are not receiving CCMs themselves. This typically indicates a
3042 unidirectional connectivity failure.
3045 <column name=
"cfm_fault_status" key=
"maid">
3046 Indicates a CFM fault was triggered due to the reception of a CCM with
3047 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
3048 with an identification number in addition to the MPID called the MAID.
3049 Open vSwitch only supports receiving CCM broadcasts tagged with the
3050 MAID it uses internally.
3053 <column name=
"cfm_fault_status" key=
"loopback">
3054 Indicates a CFM fault was triggered due to the reception of a CCM
3055 advertising the same MPID configured in the
<ref column=
"cfm_mpid"/>
3056 column of this
<ref table=
"Interface"/>. This may indicate a loop in
3060 <column name=
"cfm_fault_status" key=
"overflow">
3061 Indicates a CFM fault was triggered because the CFM module received
3062 CCMs from more remote endpoints than it can keep track of.
3065 <column name=
"cfm_fault_status" key=
"override">
3066 Indicates a CFM fault was manually triggered by an administrator using
3067 an
<code>ovs-appctl
</code> command.
3070 <column name=
"cfm_fault_status" key=
"interval">
3071 Indicates a CFM fault was triggered due to the reception of a CCM
3072 frame having an invalid interval.
3075 <column name=
"cfm_remote_opstate">
3076 <p>When in extended mode, indicates the operational state of the
3077 remote endpoint as either
<code>up
</code> or
<code>down
</code>. See
3078 <ref column=
"other_config" key=
"cfm_opstate"/>.
3082 <column name=
"cfm_health">
3084 Indicates the health of the interface as a percentage of CCM frames
3085 received over
21 <ref column=
"other_config" key=
"cfm_interval"/>s.
3086 The health of an interface is undefined if it is communicating with
3087 more than one
<ref column=
"cfm_remote_mpids"/>. It reduces if
3088 healthy heartbeats are not received at the expected rate, and
3089 gradually improves as healthy heartbeats are received at the desired
3090 rate. Every
21 <ref column=
"other_config" key=
"cfm_interval"/>s, the
3091 health of the interface is refreshed.
3094 As mentioned above, the faults can be triggered for several reasons.
3095 The link health will deteriorate even if heartbeats are received but
3096 they are reported to be unhealthy. An unhealthy heartbeat in this
3097 context is a heartbeat for which either some fault is set or is out
3098 of sequence. The interface health can be
100 only on receiving
3099 healthy heartbeats at the desired rate.
3103 <column name=
"cfm_remote_mpids">
3104 When CFM is properly configured, Open vSwitch will occasionally
3105 receive CCM broadcasts. These broadcasts contain the MPID of the
3106 sending Maintenance Point. The list of MPIDs from which this
3107 <ref table=
"Interface"/> is receiving broadcasts from is regularly
3108 collected and written to this column.
3111 <column name=
"other_config" key=
"cfm_interval"
3112 type='{
"type":
"integer"}'
>
3114 The interval, in milliseconds, between transmissions of CFM
3115 heartbeats. Three missed heartbeat receptions indicate a
3120 In standard operation only intervals of
3,
10,
100,
1,
000,
10,
000,
3121 60,
000, or
600,
000 ms are supported. Other values will be rounded
3122 down to the nearest value on the list. Extended mode (see
<ref
3123 column=
"other_config" key=
"cfm_extended"/>) supports any interval up
3124 to
65,
535 ms. In either mode, the default is
1000 ms.
3127 <p>We do not recommend using intervals less than
100 ms.
</p>
3130 <column name=
"other_config" key=
"cfm_extended"
3131 type='{
"type":
"boolean"}'
>
3132 When
<code>true
</code>, the CFM module operates in extended mode. This
3133 causes it to use a nonstandard destination address to avoid conflicting
3134 with compliant implementations which may be running concurrently on the
3135 network. Furthermore, extended mode increases the accuracy of the
3136 <code>cfm_interval
</code> configuration parameter by breaking wire
3137 compatibility with
802.1ag compliant implementations. And extended
3138 mode allows eight byte MPIDs. Defaults to
<code>false
</code>.
3141 <column name=
"other_config" key=
"cfm_demand" type='{
"type":
"boolean"}'
>
3143 When
<code>true
</code>, and
3144 <ref column=
"other_config" key=
"cfm_extended"/> is true, the CFM
3145 module operates in demand mode. When in demand mode, traffic
3146 received on the
<ref table=
"Interface"/> is used to indicate
3147 liveness. CCMs are still transmitted and received. At least one
3148 CCM must be received every
100 *
<ref column=
"other_config"
3149 key=
"cfm_interval"/> amount of time. Otherwise, even if traffic
3150 are received, the CFM module will raise the connectivity fault.
3154 Demand mode has a couple of caveats:
3157 To ensure that ovs-vswitchd has enough time to pull statistics
3158 from the datapath, the fault detection interval is set to
3159 3.5 * MAX(
<ref column=
"other_config" key=
"cfm_interval"/>,
500)
3164 To avoid ambiguity, demand mode disables itself when there are
3165 multiple remote maintenance points.
3169 If the
<ref table=
"Interface"/> is heavily congested, CCMs
3170 containing the
<ref column=
"other_config" key=
"cfm_opstate"/>
3171 status may be dropped causing changes in the operational state to
3172 be delayed. Similarly, if CCMs containing the RDI bit are not
3173 received, unidirectional link failures may not be detected.
3179 <column name=
"other_config" key=
"cfm_opstate"
3180 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
3181 When
<code>down
</code>, the CFM module marks all CCMs it generates as
3182 operationally down without triggering a fault. This allows remote
3183 maintenance points to choose not to forward traffic to the
3184 <ref table=
"Interface"/> on which this CFM module is running.
3185 Currently, in Open vSwitch, the opdown bit of CCMs affects
3186 <ref table=
"Interface"/>s participating in bonds, and the bundle
3187 OpenFlow action. This setting is ignored when CFM is not in extended
3188 mode. Defaults to
<code>up
</code>.
3191 <column name=
"other_config" key=
"cfm_ccm_vlan"
3192 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
3193 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3194 with the given value. May be the string
<code>random
</code> in which
3195 case each CCM will be tagged with a different randomly generated VLAN.
3198 <column name=
"other_config" key=
"cfm_ccm_pcp"
3199 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
7}'
>
3200 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3201 with the given PCP value, the VLAN ID of the tag is governed by the
3202 value of
<ref column=
"other_config" key=
"cfm_ccm_vlan"/>. If
3203 <ref column=
"other_config" key=
"cfm_ccm_vlan"/> is unset, a VLAN ID of
3209 <group title=
"Bonding Configuration">
3210 <column name=
"other_config" key=
"lacp-port-id"
3211 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3212 The LACP port ID of this
<ref table=
"Interface"/>. Port IDs are
3213 used in LACP negotiations to identify individual ports
3214 participating in a bond.
3217 <column name=
"other_config" key=
"lacp-port-priority"
3218 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3219 The LACP port priority of this
<ref table=
"Interface"/>. In LACP
3220 negotiations
<ref table=
"Interface"/>s with numerically lower
3221 priorities are preferred for aggregation.
3224 <column name=
"other_config" key=
"lacp-aggregation-key"
3225 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3226 The LACP aggregation key of this
<ref table=
"Interface"/>.
<ref
3227 table=
"Interface"/>s with different aggregation keys may not be active
3228 within a given
<ref table=
"Port"/> at the same time.
3232 <group title=
"Virtual Machine Identifiers">
3234 These key-value pairs specifically apply to an interface that
3235 represents a virtual Ethernet interface connected to a virtual
3236 machine. These key-value pairs should not be present for other types
3237 of interfaces. Keys whose names end in
<code>-uuid
</code> have
3238 values that uniquely identify the entity in question. For a Citrix
3239 XenServer hypervisor, these values are UUIDs in RFC
4122 format.
3240 Other hypervisors may use other formats.
3243 <column name=
"external_ids" key=
"attached-mac">
3244 The MAC address programmed into the ``virtual hardware'' for this
3245 interface, in the form
3246 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
3247 For Citrix XenServer, this is the value of the
<code>MAC
</code> field
3248 in the VIF record for this interface.
3251 <column name=
"external_ids" key=
"iface-id">
3252 A system-unique identifier for the interface. On XenServer, this will
3253 commonly be the same as
<ref column=
"external_ids" key=
"xs-vif-uuid"/>.
3256 <column name=
"external_ids" key=
"iface-status"
3257 type='{
"type":
"string",
3258 "enum": [
"set", [
"active",
"inactive"]]}'
>
3260 Hypervisors may sometimes have more than one interface associated
3261 with a given
<ref column=
"external_ids" key=
"iface-id"/>, only one of
3262 which is actually in use at a given time. For example, in some
3263 circumstances XenServer has both a ``tap'' and a ``vif'' interface
3264 for a single
<ref column=
"external_ids" key=
"iface-id"/>, but only
3265 uses one of them at a time. A hypervisor that behaves this way must
3266 mark the currently in use interface
<code>active
</code> and the
3267 others
<code>inactive
</code>. A hypervisor that never has more than
3268 one interface for a given
<ref column=
"external_ids" key=
"iface-id"/>
3269 may mark that interface
<code>active
</code> or omit
<ref
3270 column=
"external_ids" key=
"iface-status"/> entirely.
3274 During VM migration, a given
<ref column=
"external_ids"
3275 key=
"iface-id"/> might transiently be marked
<code>active
</code> on
3276 two different hypervisors. That is,
<code>active
</code> means that
3277 this
<ref column=
"external_ids" key=
"iface-id"/> is the active
3278 instance within a single hypervisor, not in a broader scope.
3279 There is one exception: some hypervisors support ``migration'' from a
3280 given hypervisor to itself (most often for test purposes). During
3281 such a ``migration,'' two instances of a single
<ref
3282 column=
"external_ids" key=
"iface-id"/> might both be briefly marked
3283 <code>active
</code> on a single hypervisor.
3287 <column name=
"external_ids" key=
"xs-vif-uuid">
3288 The virtual interface associated with this interface.
3291 <column name=
"external_ids" key=
"xs-network-uuid">
3292 The virtual network to which this interface is attached.
3295 <column name=
"external_ids" key=
"vm-id">
3296 The VM to which this interface belongs. On XenServer, this will be the
3297 same as
<ref column=
"external_ids" key=
"xs-vm-uuid"/>.
3300 <column name=
"external_ids" key=
"xs-vm-uuid">
3301 The VM to which this interface belongs.
3305 <group title=
"Auto Attach Configuration">
3307 Auto Attach configuration for a particular interface.
3310 <column name=
"lldp" key=
"enable" type='{
"type":
"boolean"}'
>
3311 True to enable LLDP on this
<ref table=
"Interface"/>. If not
3312 specified, LLDP will be disabled by default.
3316 <group title=
"Flow control Configuration">
3318 Ethernet flow control defined in IEEE
802.1Qbb provides link level flow
3319 control using MAC pause frames. Implemented only for interfaces with
3320 type
<code>dpdk
</code>.
3323 <column name=
"options" key=
"rx-flow-ctrl" type='{
"type":
"boolean"}'
>
3324 Set to
<code>true
</code> to enable Rx flow control on physical ports.
3325 By default, Rx flow control is disabled.
3328 <column name=
"options" key=
"tx-flow-ctrl" type='{
"type":
"boolean"}'
>
3329 Set to
<code>true
</code> to enable Tx flow control on physical ports.
3330 By default, Tx flow control is disabled.
3333 <column name=
"options" key=
"flow-ctrl-autoneg"
3334 type='{
"type":
"boolean"}'
>
3335 Set to
<code>true
</code> to enable flow control auto negotiation on
3336 physical ports. By default, auto-neg is disabled.
3340 <group title=
"Rx Checksum Offload Configuration">
3342 The checksum validation on the incoming packets are performed on NIC
3343 using Rx checksum offload feature. Implemented only for
<code>dpdk
3344 </code>physical interfaces.
3347 <column name=
"options" key=
"rx-checksum-offload"
3348 type='{
"type":
"boolean"}'
>
3349 Set to
<code>false
</code> to disble Rx checksum offloading on
<code>
3350 dpdk
</code>physical ports. By default, Rx checksum offload is enabled.
3354 <group title=
"Common Columns">
3355 The overall purpose of these columns is described under
<code>Common
3356 Columns
</code> at the beginning of this document.
3358 <column name=
"other_config"/>
3359 <column name=
"external_ids"/>
3363 <table name=
"Flow_Table" title=
"OpenFlow table configuration">
3364 <p>Configuration for a particular OpenFlow table.
</p>
3366 <column name=
"name">
3367 The table's name. Set this column to change the name that controllers
3368 will receive when they request table statistics, e.g.
<code>ovs-ofctl
3369 dump-tables
</code>. The name does not affect switch behavior.
3372 <group title=
"Eviction Policy">
3374 Open vSwitch supports limiting the number of flows that may be
3375 installed in a flow table, via the
<ref column=
"flow_limit"/> column.
3376 When adding a flow would exceed this limit, by default Open vSwitch
3377 reports an error, but there are two ways to configure Open vSwitch to
3378 instead delete (``evict'') a flow to make room for the new one:
3383 Set the
<ref column=
"overflow_policy"/> column to
<code>evict
</code>.
3387 Send an OpenFlow
1.4+ ``table mod request'' to enable eviction for
3388 the flow table (e.g.
<code>ovs-ofctl -O OpenFlow14 mod-table br0
0
3389 evict
</code> to enable eviction on flow table
0 of bridge
3395 When a flow must be evicted due to overflow, the flow to evict is
3396 chosen through an approximation of the following algorithm. This
3397 algorithm is used regardless of how eviction was enabled:
3402 Divide the flows in the table into groups based on the values of the
3403 fields or subfields specified in the
<ref column=
"groups"/> column,
3404 so that all of the flows in a given group have the same values for
3405 those fields. If a flow does not specify a given field, that field's
3406 value is treated as
0. If
<ref column=
"groups"/> is empty, then all
3407 of the flows in the flow table are treated as a single group.
3411 Consider the flows in the largest group, that is, the group that
3412 contains the greatest number of flows. If two or more groups all
3413 have the same largest number of flows, consider the flows in all of
3418 If the flows under consideration have different importance values,
3419 eliminate from consideration any flows except those with the lowest
3420 importance. (``Importance,'' a
16-bit integer value attached to each
3421 flow, was introduced in OpenFlow
1.4. Flows inserted with older
3422 versions of OpenFlow always have an importance of
0.)
3426 Among the flows under consideration, choose the flow that expires
3427 soonest for eviction.
3432 The eviction process only considers flows that have an idle timeout
3433 or a hard timeout. That is, eviction never deletes permanent flows.
3434 (Permanent flows do count against
<ref column=
"flow_limit"/>.)
3437 <column name=
"flow_limit">
3438 If set, limits the number of flows that may be added to the table.
3439 Open vSwitch may limit the number of flows in a table for other
3440 reasons, e.g. due to hardware limitations or for resource availability
3441 or performance reasons.
3444 <column name=
"overflow_policy">
3446 Controls the switch's behavior when an OpenFlow flow table
3447 modification request would add flows in excess of
<ref
3448 column=
"flow_limit"/>. The supported values are:
3452 <dt><code>refuse
</code></dt>
3454 Refuse to add the flow or flows. This is also the default policy
3455 when
<ref column=
"overflow_policy"/> is unset.
3458 <dt><code>evict
</code></dt>
3460 Delete a flow chosen according to the algorithm described above.
3465 <column name=
"groups">
3467 When
<ref column=
"overflow_policy"/> is
<code>evict
</code>, this
3468 controls how flows are chosen for eviction when the flow table would
3469 otherwise exceed
<ref column=
"flow_limit"/> flows. Its value is a
3470 set of NXM fields or sub-fields, each of which takes one of the forms
3471 <code><var>field
</var>[]
</code> or
3472 <code><var>field
</var>[
<var>start
</var>..
<var>end
</var>]
</code>,
3473 e.g.
<code>NXM_OF_IN_PORT[]
</code>. Please see
3474 <code>meta-flow.h
</code> for a complete list of NXM field names.
3478 Open vSwitch ignores any invalid or unknown field specifications.
3482 When eviction is not enabled, via
<ref column=
"overflow_policy"/> or
3483 an OpenFlow
1.4+ ``table mod,'' this column has no effect.
3488 <group title=
"Classifier Optimization">
3489 <column name=
"prefixes">
3491 This string set specifies which fields should be used for
3492 address prefix tracking. Prefix tracking allows the
3493 classifier to skip rules with longer than necessary prefixes,
3494 resulting in better wildcarding for datapath flows.
3497 Prefix tracking may be beneficial when a flow table contains
3498 matches on IP address fields with different prefix lengths.
3499 For example, when a flow table contains IP address matches on
3500 both full addresses and proper prefixes, the full address
3501 matches will typically cause the datapath flow to un-wildcard
3502 the whole address field (depending on flow entry priorities).
3503 In this case each packet with a different address gets handed
3504 to the userspace for flow processing and generates its own
3505 datapath flow. With prefix tracking enabled for the address
3506 field in question packets with addresses matching shorter
3507 prefixes would generate datapath flows where the irrelevant
3508 address bits are wildcarded, allowing the same datapath flow
3509 to handle all the packets within the prefix in question. In
3510 this case many userspace upcalls can be avoided and the
3511 overall performance can be better.
3514 This is a performance optimization only, so packets will
3515 receive the same treatment with or without prefix tracking.
3518 The supported fields are:
<code>tun_id
</code>,
3519 <code>tun_src
</code>,
<code>tun_dst
</code>,
3520 <code>tun_ipv6_src
</code>,
<code>tun_ipv6_dst
</code>,
3521 <code>nw_src
</code>,
<code>nw_dst
</code> (or aliases
3522 <code>ip_src
</code> and
<code>ip_dst
</code>),
3523 <code>ipv6_src
</code>, and
<code>ipv6_dst
</code>. (Using this
3524 feature for
<code>tun_id
</code> would only make sense if the
3525 tunnel IDs have prefix structure similar to IP addresses.)
3529 By default, the
<code>prefixes=ip_dst,ip_src
</code> are used
3530 on each flow table. This instructs the flow classifier to
3531 track the IP destination and source addresses used by the
3532 rules in this specific flow table.
3536 The keyword
<code>none
</code> is recognized as an explicit
3537 override of the default values, causing no prefix fields to be
3542 To set the prefix fields, the flow table record needs to
3547 <dt><code>ovs-vsctl set Bridge br0 flow_tables:
0=@N1 -- --id=@N1 create Flow_Table name=table0
</code></dt>
3549 Creates a flow table record for the OpenFlow table number
0.
3552 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src
</code></dt>
3554 Enables prefix tracking for IP source and destination
3560 There is a maximum number of fields that can be enabled for any
3561 one flow table. Currently this limit is
3.
3566 <group title=
"Common Columns">
3567 The overall purpose of these columns is described under
<code>Common
3568 Columns
</code> at the beginning of this document.
3570 <column name=
"external_ids"/>
3574 <table name=
"QoS" title=
"Quality of Service configuration">
3575 <p>Quality of Service (QoS) configuration for each Port that
3578 <column name=
"type">
3579 <p>The type of QoS to implement. The currently defined types are
3582 <dt><code>linux-htb
</code></dt>
3584 Linux ``hierarchy token bucket'' classifier. See tc-htb(
8) (also at
3585 <code>http://linux.die.net/man/
8/tc-htb
</code>) and the HTB manual
3586 (
<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm
</code>)
3587 for information on how this classifier works and how to configure it.
3590 <dt><code>linux-hfsc
</code></dt>
3592 Linux
"Hierarchical Fair Service Curve" classifier.
3593 See
<code>http://linux-ip.net/articles/hfsc.en/
</code> for
3594 information on how this classifier works.
3597 <dt><code>linux-sfq
</code></dt>
3599 Linux ``Stochastic Fairness Queueing'' classifier. See
3600 <code>tc-sfq
</code>(
8) (also at
3601 <code>http://linux.die.net/man/
8/tc-sfq
</code>) for information on
3602 how this classifier works.
3605 <dt><code>linux-codel
</code></dt>
3607 Linux ``Controlled Delay'' classifier. See
<code>tc-codel
</code>(
8)
3609 <code>http://man7.org/linux/man-pages/man8/tc-codel
.8.html
</code>)
3610 for information on how this classifier works.
3613 <dt><code>linux-fq_codel
</code></dt>
3615 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3616 <code>tc-fq_codel
</code>(
8) (also at
3617 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel
.8.html
</code>)
3618 for information on how this classifier works.
3621 <dt><code>linux-noop
</code></dt>
3623 Linux ``No operation.'' By default, Open vSwitch manages quality of
3624 service on all of its configured ports. This can be helpful, but
3625 sometimes administrators prefer to use other software to manage QoS.
3626 This
<ref column=
"type"/> prevents Open vSwitch from changing the QoS
3627 configuration for a port.
3630 <dt><code>egress-policer
</code></dt>
3632 A DPDK egress policer algorithm using the DPDK
3633 rte_meter library. The rte_meter library provides an implementation
3634 which allows the metering and policing of traffic. The implementation
3635 in OVS essentially creates a single token bucket used to police
3636 traffic. It should be noted that when the rte_meter is configured as
3637 part of QoS there will be a performance overhead as the rte_meter
3638 itself will consume CPU cycles in order to police traffic. These CPU
3639 cycles ordinarily are used for packet proccessing. As such the drop
3640 in performance will be noticed in terms of overall aggregate traffic
3646 <column name=
"queues">
3647 <p>A map from queue numbers to
<ref table=
"Queue"/> records. The
3648 supported range of queue numbers depend on
<ref column=
"type"/>. The
3649 queue numbers are the same as the
<code>queue_id
</code> used in
3650 OpenFlow in
<code>struct ofp_action_enqueue
</code> and other
3654 Queue
0 is the ``default queue.'' It is used by OpenFlow output
3655 actions when no specific queue has been set. When no configuration for
3656 queue
0 is present, it is automatically configured as if a
<ref
3657 table=
"Queue"/> record with empty
<ref table=
"Queue" column=
"dscp"/>
3658 and
<ref table=
"Queue" column=
"other_config"/> columns had been
3660 (Before version
1.6, Open vSwitch would leave queue
0 unconfigured in
3661 this case. With some queuing disciplines, this dropped all packets
3662 destined for the default queue.)
3666 <group title=
"Configuration for linux-htb and linux-hfsc">
3668 The
<code>linux-htb
</code> and
<code>linux-hfsc
</code> classes support
3669 the following key-value pair:
3672 <column name=
"other_config" key=
"max-rate" type='{
"type":
"integer"}'
>
3673 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3674 specified, for physical interfaces, the default is the link rate. For
3675 other interfaces or if the link rate cannot be determined, the default
3676 is currently
100 Mbps.
3680 <group title=
"Configuration for egress-policer QoS">
3682 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3683 <code>egress-policer
</code> provides egress policing for userspace
3684 port types with DPDK.
3686 It has the following key-value pairs defined.
3689 <column name=
"other_config" key=
"cir" type='{
"type":
"integer"}'
>
3690 The Committed Information Rate (CIR) is measured in bytes of IP
3691 packets per second, i.e. it includes the IP header, but not link
3692 specific (e.g. Ethernet) headers. This represents the bytes per second
3693 rate at which the token bucket will be updated. The cir value is
3694 calculated by (pps x packet data size). For example assuming a user
3695 wishes to limit a stream consisting of
64 byte packets to
1 million
3696 packets per second the CIR would be set to to to
46000000. This value
3697 can be broken into '
1,
000,
000 x
46'. Where
1,
000,
000 is the policing
3698 rate for the number of packets per second and
46 represents the size
3699 of the packet data for a
64 byte ip packet.
3701 <column name=
"other_config" key=
"cbs" type='{
"type":
"integer"}'
>
3702 The Committed Burst Size (CBS) is measured in bytes and represents a
3703 token bucket. At a minimum this value should be be set to the expected
3704 largest size packet in the traffic stream. In practice larger values
3705 may be used to increase the size of the token bucket. If a packet can
3706 be transmitted then the cbs will be decremented by the number of
3707 bytes/tokens of the packet. If there are not enough tokens in the cbs
3708 bucket the packet will be dropped.
3712 <group title=
"Common Columns">
3713 The overall purpose of these columns is described under
<code>Common
3714 Columns
</code> at the beginning of this document.
3716 <column name=
"other_config"/>
3717 <column name=
"external_ids"/>
3721 <table name=
"Queue" title=
"QoS output queue.">
3722 <p>A configuration for a port output queue, used in configuring Quality of
3723 Service (QoS) features. May be referenced by
<ref column=
"queues"
3724 table=
"QoS"/> column in
<ref table=
"QoS"/> table.
</p>
3726 <column name=
"dscp">
3727 If set, Open vSwitch will mark all traffic egressing this
3728 <ref table=
"Queue"/> with the given DSCP bits. Traffic egressing the
3729 default
<ref table=
"Queue"/> is only marked if it was explicitly selected
3730 as the
<ref table=
"Queue"/> at the time the packet was output. If unset,
3731 the DSCP bits of traffic egressing this
<ref table=
"Queue"/> will remain
3735 <group title=
"Configuration for linux-htb QoS">
3737 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3738 <code>linux-htb
</code> may use
<code>queue_id
</code>s less than
61440.
3739 It has the following key-value pairs defined.
3742 <column name=
"other_config" key=
"min-rate"
3743 type='{
"type":
"integer",
"minInteger":
1}'
>
3744 Minimum guaranteed bandwidth, in bit/s.
3747 <column name=
"other_config" key=
"max-rate"
3748 type='{
"type":
"integer",
"minInteger":
1}'
>
3749 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3750 queue's rate will not be allowed to exceed the specified value, even
3751 if excess bandwidth is available. If unspecified, defaults to no
3755 <column name=
"other_config" key=
"burst"
3756 type='{
"type":
"integer",
"minInteger":
1}'
>
3757 Burst size, in bits. This is the maximum amount of ``credits'' that a
3758 queue can accumulate while it is idle. Optional. Details of the
3759 <code>linux-htb
</code> implementation require a minimum burst size, so
3760 a too-small
<code>burst
</code> will be silently ignored.
3763 <column name=
"other_config" key=
"priority"
3764 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
3765 A queue with a smaller
<code>priority
</code> will receive all the
3766 excess bandwidth that it can use before a queue with a larger value
3767 receives any. Specific priority values are unimportant; only relative
3768 ordering matters. Defaults to
0 if unspecified.
3772 <group title=
"Configuration for linux-hfsc QoS">
3774 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3775 <code>linux-hfsc
</code> may use
<code>queue_id
</code>s less than
61440.
3776 It has the following key-value pairs defined.
3779 <column name=
"other_config" key=
"min-rate"
3780 type='{
"type":
"integer",
"minInteger":
1}'
>
3781 Minimum guaranteed bandwidth, in bit/s.
3784 <column name=
"other_config" key=
"max-rate"
3785 type='{
"type":
"integer",
"minInteger":
1}'
>
3786 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3787 queue's rate will not be allowed to exceed the specified value, even if
3788 excess bandwidth is available. If unspecified, defaults to no
3793 <group title=
"Common Columns">
3794 The overall purpose of these columns is described under
<code>Common
3795 Columns
</code> at the beginning of this document.
3797 <column name=
"other_config"/>
3798 <column name=
"external_ids"/>
3802 <table name=
"Mirror" title=
"Port mirroring.">
3803 <p>A port mirror within a
<ref table=
"Bridge"/>.
</p>
3804 <p>A port mirror configures a bridge to send selected frames to special
3805 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3806 traffic may also be referred to as SPAN or RSPAN, depending on how
3807 the mirrored traffic is sent.
</p>
3810 When a packet enters an Open vSwitch bridge, it becomes eligible for
3811 mirroring based on its ingress port and VLAN. As the packet travels
3812 through the flow tables, each time it is output to a port, it becomes
3813 eligible for mirroring based on the egress port and VLAN. In Open
3814 vSwitch
2.5 and later, mirroring occurs just after a packet first becomes
3815 eligible, using the packet as it exists at that point; in Open vSwitch
3816 2.4 and earlier, mirroring occurs only after a packet has traversed all
3817 the flow tables, using the original packet as it entered the bridge.
3818 This makes a difference only when the flow table modifies the packet: in
3819 Open vSwitch
2.4, the modifications are never visible to mirrors, whereas
3820 in Open vSwitch
2.5 and later modifications made before the first output
3821 that makes it eligible for mirroring to a particular destination are
3826 A packet that enters an Open vSwitch bridge is mirrored to a particular
3827 destination only once, even if it is eligible for multiple reasons. For
3828 example, a packet would be mirrored to a particular
<ref
3829 column=
"output_port"/> only once, even if it is selected for mirroring to
3830 that port by
<ref column=
"select_dst_port"/> and
<ref
3831 column=
"select_src_port"/> in the same or different
<ref table=
"Mirror"/>
3835 <column name=
"name">
3836 Arbitrary identifier for the
<ref table=
"Mirror"/>.
3839 <group title=
"Selecting Packets for Mirroring">
3841 To be selected for mirroring, a given packet must enter or leave the
3842 bridge through a selected port and it must also be in one of the
3846 <column name=
"select_all">
3847 If true, every packet arriving or departing on any port is
3848 selected for mirroring.
3851 <column name=
"select_dst_port">
3852 Ports on which departing packets are selected for mirroring.
3855 <column name=
"select_src_port">
3856 Ports on which arriving packets are selected for mirroring.
3859 <column name=
"select_vlan">
3860 VLANs on which packets are selected for mirroring. An empty set
3861 selects packets on all VLANs.
3865 <group title=
"Mirroring Destination Configuration">
3867 These columns are mutually exclusive. Exactly one of them must be
3871 <column name=
"output_port">
3872 <p>Output port for selected packets, if nonempty.
</p>
3873 <p>Specifying a port for mirror output reserves that port exclusively
3874 for mirroring. No frames other than those selected for mirroring
3876 will be forwarded to the port, and any frames received on the port
3877 will be discarded.
</p>
3879 The output port may be any kind of port supported by Open vSwitch.
3880 It may be, for example, a physical port (sometimes called SPAN) or a
3885 <column name=
"output_vlan">
3886 <p>Output VLAN for selected packets, if nonempty.
</p>
3887 <p>The frames will be sent out all ports that trunk
3888 <ref column=
"output_vlan"/>, as well as any ports with implicit VLAN
3889 <ref column=
"output_vlan"/>. When a mirrored frame is sent out a
3890 trunk port, the frame's VLAN tag will be set to
3891 <ref column=
"output_vlan"/>, replacing any existing tag; when it is
3892 sent out an implicit VLAN port, the frame will not be tagged. This
3893 type of mirroring is sometimes called RSPAN.
</p>
3895 See the documentation for
3896 <ref column=
"other_config" key=
"forward-bpdu"/> in the
3897 <ref table=
"Interface"/> table for a list of destination MAC
3898 addresses which will not be mirrored to a VLAN to avoid confusing
3899 switches that interpret the protocols that they represent.
3901 <p><em>Please note:
</em> Mirroring to a VLAN can disrupt a network that
3902 contains unmanaged switches. Consider an unmanaged physical switch
3903 with two ports: port
1, connected to an end host, and port
2,
3904 connected to an Open vSwitch configured to mirror received packets
3905 into VLAN
123 on port
2. Suppose that the end host sends a packet on
3906 port
1 that the physical switch forwards to port
2. The Open vSwitch
3907 forwards this packet to its destination and then reflects it back on
3908 port
2 in VLAN
123. This reflected packet causes the unmanaged
3909 physical switch to replace the MAC learning table entry, which
3910 correctly pointed to port
1, with one that incorrectly points to port
3911 2. Afterward, the physical switch will direct packets destined for
3912 the end host to the Open vSwitch on port
2, instead of to the end
3913 host on port
1, disrupting connectivity. If mirroring to a VLAN is
3914 desired in this scenario, then the physical switch must be replaced
3915 by one that learns Ethernet addresses on a per-VLAN basis. In
3916 addition, learning should be disabled on the VLAN containing mirrored
3917 traffic. If this is not done then intermediate switches will learn
3918 the MAC address of each end host from the mirrored traffic. If
3919 packets being sent to that end host are also mirrored, then they will
3920 be dropped since the switch will attempt to send them out the input
3921 port. Disabling learning for the VLAN will cause the switch to
3922 correctly send the packet out all ports configured for that VLAN. If
3923 Open vSwitch is being used as an intermediate switch, learning can be
3924 disabled by adding the mirrored VLAN to
<ref column=
"flood_vlans"/>
3925 in the appropriate
<ref table=
"Bridge"/> table or tables.
</p>
3927 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3928 VLAN and should generally be preferred.
3932 <column name=
"snaplen">
3933 <p>Maximum per-packet number of bytes to mirror.
</p>
3934 <p>A mirrored packet with size larger than
<ref column=
"snaplen"/>
3935 will be truncated in datapath to
<ref column=
"snaplen"/> bytes
3936 before sending to the mirror output port. If omitted, packets
3942 <group title=
"Statistics: Mirror counters">
3944 Key-value pairs that report mirror statistics. The update period
3945 is controlled by
<ref column=
"other_config"
3946 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
3948 <column name=
"statistics" key=
"tx_packets">
3949 Number of packets transmitted through this mirror.
3951 <column name=
"statistics" key=
"tx_bytes">
3952 Number of bytes transmitted through this mirror.
3956 <group title=
"Common Columns">
3957 The overall purpose of these columns is described under
<code>Common
3958 Columns
</code> at the beginning of this document.
3960 <column name=
"external_ids"/>
3964 <table name=
"Controller" title=
"OpenFlow controller configuration.">
3965 <p>An OpenFlow controller.
</p>
3968 Open vSwitch supports two kinds of OpenFlow controllers:
3972 <dt>Primary controllers
</dt>
3975 This is the kind of controller envisioned by the OpenFlow
1.0
3976 specification. Usually, a primary controller implements a network
3977 policy by taking charge of the switch's flow table.
3981 Open vSwitch initiates and maintains persistent connections to
3982 primary controllers, retrying the connection each time it fails or
3983 drops. The
<ref table=
"Bridge" column=
"fail_mode"/> column in the
3984 <ref table=
"Bridge"/> table applies to primary controllers.
3988 Open vSwitch permits a bridge to have any number of primary
3989 controllers. When multiple controllers are configured, Open
3990 vSwitch connects to all of them simultaneously. Because
3991 OpenFlow
1.0 does not specify how multiple controllers
3992 coordinate in interacting with a single switch, more than
3993 one primary controller should be specified only if the
3994 controllers are themselves designed to coordinate with each
3995 other. (The Nicira-defined
<code>NXT_ROLE
</code> OpenFlow
3996 vendor extension may be useful for this.)
3999 <dt>Service controllers
</dt>
4002 These kinds of OpenFlow controller connections are intended for
4003 occasional support and maintenance use, e.g. with
4004 <code>ovs-ofctl
</code>. Usually a service controller connects only
4005 briefly to inspect or modify some of a switch's state.
4009 Open vSwitch listens for incoming connections from service
4010 controllers. The service controllers initiate and, if necessary,
4011 maintain the connections from their end. The
<ref table=
"Bridge"
4012 column=
"fail_mode"/> column in the
<ref table=
"Bridge"/> table does
4013 not apply to service controllers.
4017 Open vSwitch supports configuring any number of service controllers.
4023 The
<ref column=
"target"/> determines the type of controller.
4026 <group title=
"Core Features">
4027 <column name=
"target">
4028 <p>Connection method for controller.
</p>
4030 The following connection methods are currently supported for primary
4034 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4036 <p>The specified SSL
<var>port
</var> on the host at the
4037 given
<var>ip
</var>, which must be expressed as an IP
4038 address (not a DNS name). The
<ref table=
"Open_vSwitch"
4039 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
4040 table must point to a valid SSL configuration when this form
4042 <p>If
<var>port
</var> is not specified, it defaults to
6653.
</p>
4043 <p>SSL support is an optional feature that is not always built as
4044 part of Open vSwitch.
</p>
4046 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4049 The specified TCP
<var>port
</var> on the host at the given
4050 <var>ip
</var>, which must be expressed as an IP address (not a
4051 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
4052 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4053 e.g.
<code>tcp:[::
1]:
6653</code>.
4056 If
<var>port
</var> is not specified, it defaults to
6653.
4061 The following connection methods are currently supported for service
4065 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4068 Listens for SSL connections on the specified TCP
<var>port
</var>.
4069 If
<var>ip
</var>, which must be expressed as an IP address (not a
4070 DNS name), is specified, then connections are restricted to the
4071 specified local IP address (either IPv4 or IPv6). If
4072 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4073 e.g.
<code>pssl:
6653:[::
1]
</code>.
4076 If
<var>port
</var> is not specified, it defaults to
4077 6653. If
<var>ip
</var> is not specified then it listens only on
4078 IPv4 (but not IPv6) addresses. The
4079 <ref table=
"Open_vSwitch" column=
"ssl"/>
4080 column in the
<ref table=
"Open_vSwitch"/> table must point to a
4081 valid SSL configuration when this form is used.
4084 If
<var>port
</var> is not specified, it currently to
6653.
4087 SSL support is an optional feature that is not always built as
4088 part of Open vSwitch.
4091 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4094 Listens for connections on the specified TCP
<var>port
</var>. If
4095 <var>ip
</var>, which must be expressed as an IP address (not a
4096 DNS name), is specified, then connections are restricted to the
4097 specified local IP address (either IPv4 or IPv6). If
4098 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4099 e.g.
<code>ptcp:
6653:[::
1]
</code>. If
<var>ip
</var> is not
4100 specified then it listens only on IPv4 addresses.
4103 If
<var>port
</var> is not specified, it defaults to
6653.
4107 <p>When multiple controllers are configured for a single bridge, the
4108 <ref column=
"target"/> values must be unique. Duplicate
4109 <ref column=
"target"/> values yield unspecified results.
</p>
4112 <column name=
"connection_mode">
4113 <p>If it is specified, this setting must be one of the following
4114 strings that describes how Open vSwitch contacts this OpenFlow
4115 controller over the network:
</p>
4118 <dt><code>in-band
</code></dt>
4119 <dd>In this mode, this controller's OpenFlow traffic travels over the
4120 bridge associated with the controller. With this setting, Open
4121 vSwitch allows traffic to and from the controller regardless of the
4122 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
4123 would never be able to connect to the controller, because it did
4124 not have a flow to enable it.) This is the most common connection
4125 mode because it is not necessary to maintain two independent
4127 <dt><code>out-of-band
</code></dt>
4128 <dd>In this mode, OpenFlow traffic uses a control network separate
4129 from the bridge associated with this controller, that is, the
4130 bridge does not use any of its own network devices to communicate
4131 with the controller. The control network must be configured
4132 separately, before or after
<code>ovs-vswitchd
</code> is started.
4136 <p>If not specified, the default is implementation-specific.
</p>
4140 <group title=
"Controller Failure Detection and Handling">
4141 <column name=
"max_backoff">
4142 Maximum number of milliseconds to wait between connection attempts.
4143 Default is implementation-specific.
4146 <column name=
"inactivity_probe">
4147 Maximum number of milliseconds of idle time on connection to
4148 controller before sending an inactivity probe message. If Open
4149 vSwitch does not communicate with the controller for the specified
4150 number of seconds, it will send a probe. If a response is not
4151 received for the same additional amount of time, Open vSwitch
4152 assumes the connection has been broken and attempts to reconnect.
4153 Default is implementation-specific. A value of
0 disables
4158 <group title=
"Asynchronous Messages">
4160 OpenFlow switches send certain messages to controllers spontanenously,
4161 that is, not in response to any request from the controller. These
4162 messages are called ``asynchronous messages.'' These columns allow
4163 asynchronous messages to be limited or disabled to ensure the best use
4164 of network resources.
4167 <column name=
"enable_async_messages">
4168 The OpenFlow protocol enables asynchronous messages at time of
4169 connection establishment, which means that a controller can receive
4170 asynchronous messages, potentially many of them, even if it turns them
4171 off immediately after connecting. Set this column to
4172 <code>false
</code> to change Open vSwitch behavior to disable, by
4173 default, all asynchronous messages. The controller can use the
4174 <code>NXT_SET_ASYNC_CONFIG
</code> Nicira extension to OpenFlow to turn
4175 on any messages that it does want to receive, if any.
4178 <group title=
"Controller Rate Limiting">
4180 A switch can forward packets to a controller over the OpenFlow
4181 protocol. Forwarding packets this way at too high a rate can
4182 overwhelm a controller, frustrate use of the OpenFlow connection for
4183 other purposes, increase the latency of flow setup, and use an
4184 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
4185 limiting the rate of packet forwarding to a controller.
4189 There are two main reasons in OpenFlow for a packet to be sent to a
4190 controller: either the packet ``misses'' in the flow table, that is,
4191 there is no matching flow, or a flow table action says to send the
4192 packet to the controller. Open vSwitch limits the rate of each kind
4193 of packet separately at the configured rate. Therefore, the actual
4194 rate that packets are sent to the controller can be up to twice the
4195 configured rate, when packets are sent for both reasons.
4199 This feature is specific to forwarding packets over an OpenFlow
4200 connection. It is not general-purpose QoS. See the
<ref
4201 table=
"QoS"/> table for quality of service configuration, and
<ref
4202 column=
"ingress_policing_rate" table=
"Interface"/> in the
<ref
4203 table=
"Interface"/> table for ingress policing configuration.
4206 <column name=
"controller_rate_limit">
4208 The maximum rate at which the switch will forward packets to the
4209 OpenFlow controller, in packets per second. If no value is
4210 specified, rate limiting is disabled.
4214 <column name=
"controller_burst_limit">
4216 When a high rate triggers rate-limiting, Open vSwitch queues
4217 packets to the controller for each port and transmits them to the
4218 controller at the configured rate. This value limits the number of
4219 queued packets. Ports on a bridge share the packet queue fairly.
4223 This value has no effect unless
<ref
4224 column=
"controller_rate_limit"/> is configured. The current
4225 default when this value is not specified is one-quarter of
<ref
4226 column=
"controller_rate_limit"/>, meaning that queuing can delay
4227 forwarding a packet to the controller by up to
250 ms.
4231 <group title=
"Controller Rate Limiting Statistics">
4233 These values report the effects of rate limiting. Their values are
4234 relative to establishment of the most recent OpenFlow connection,
4235 or since rate limiting was enabled, whichever happened more
4236 recently. Each consists of two values, one with
<code>TYPE
</code>
4237 replaced by
<code>miss
</code> for rate limiting flow table misses,
4238 and the other with
<code>TYPE
</code> replaced by
4239 <code>action
</code> for rate limiting packets sent by OpenFlow
4244 These statistics are reported only when controller rate limiting is
4248 <column name=
"status" key=
"packet-in-TYPE-bypassed"
4249 type='{
"type":
"integer",
"minInteger":
0}'
>
4250 Number of packets sent directly to the controller, without queuing,
4251 because the rate did not exceed the configured maximum.
4254 <column name=
"status" key=
"packet-in-TYPE-queued"
4255 type='{
"type":
"integer",
"minInteger":
0}'
>
4256 Number of packets added to the queue to send later.
4259 <column name=
"status" key=
"packet-in-TYPE-dropped"
4260 type='{
"type":
"integer",
"minInteger":
0}'
>
4261 Number of packets added to the queue that were later dropped due to
4262 overflow. This value is less than or equal to
<ref column=
"status"
4263 key=
"packet-in-TYPE-queued"/>.
4266 <column name=
"status" key=
"packet-in-TYPE-backlog"
4267 type='{
"type":
"integer",
"minInteger":
0}'
>
4268 Number of packets currently queued. The other statistics increase
4269 monotonically, but this one fluctuates between
0 and the
<ref
4270 column=
"controller_burst_limit"/> as conditions change.
4276 <group title=
"Additional In-Band Configuration">
4277 <p>These values are considered only in in-band control mode (see
4278 <ref column=
"connection_mode"/>).
</p>
4280 <p>When multiple controllers are configured on a single bridge, there
4281 should be only one set of unique values in these columns. If different
4282 values are set for these columns in different controllers, the effect
4285 <column name=
"local_ip">
4286 The IP address to configure on the local port,
4287 e.g.
<code>192.168.0.123</code>. If this value is unset, then
4288 <ref column=
"local_netmask"/> and
<ref column=
"local_gateway"/> are
4292 <column name=
"local_netmask">
4293 The IP netmask to configure on the local port,
4294 e.g.
<code>255.255.255.0</code>. If
<ref column=
"local_ip"/> is set
4295 but this value is unset, then the default is chosen based on whether
4296 the IP address is class A, B, or C.
4299 <column name=
"local_gateway">
4300 The IP address of the gateway to configure on the local port, as a
4301 string, e.g.
<code>192.168.0.1</code>. Leave this column unset if
4302 this network has no gateway.
4306 <group title=
"Controller Status">
4307 <column name=
"is_connected">
4308 <code>true
</code> if currently connected to this controller,
4309 <code>false
</code> otherwise.
4313 type='{
"type":
"string",
"enum": [
"set", [
"other",
"master",
"slave"]]}'
>
4314 <p>The level of authority this controller has on the associated
4315 bridge. Possible values are:
</p>
4317 <dt><code>other
</code></dt>
4318 <dd>Allows the controller access to all OpenFlow features.
</dd>
4319 <dt><code>master
</code></dt>
4320 <dd>Equivalent to
<code>other
</code>, except that there may be at
4321 most one master controller at a time. When a controller configures
4322 itself as
<code>master
</code>, any existing master is demoted to
4323 the
<code>slave
</code> role.
</dd>
4324 <dt><code>slave
</code></dt>
4325 <dd>Allows the controller read-only access to OpenFlow features.
4326 Attempts to modify the flow table will be rejected with an
4327 error. Slave controllers do not receive OFPT_PACKET_IN or
4328 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
4333 <column name=
"status" key=
"last_error">
4334 A human-readable description of the last error on the connection
4335 to the controller; i.e.
<code>strerror(errno)
</code>. This key
4336 will exist only if an error has occurred.
4339 <column name=
"status" key=
"state"
4340 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4342 The state of the connection to the controller:
4345 <dt><code>VOID
</code></dt>
4346 <dd>Connection is disabled.
</dd>
4348 <dt><code>BACKOFF
</code></dt>
4349 <dd>Attempting to reconnect at an increasing period.
</dd>
4351 <dt><code>CONNECTING
</code></dt>
4352 <dd>Attempting to connect.
</dd>
4354 <dt><code>ACTIVE
</code></dt>
4355 <dd>Connected, remote host responsive.
</dd>
4357 <dt><code>IDLE
</code></dt>
4358 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4361 These values may change in the future. They are provided only for
4366 <column name=
"status" key=
"sec_since_connect"
4367 type='{
"type":
"integer",
"minInteger":
0}'
>
4368 The amount of time since this controller last successfully connected to
4369 the switch (in seconds). Value is empty if controller has never
4370 successfully connected.
4373 <column name=
"status" key=
"sec_since_disconnect"
4374 type='{
"type":
"integer",
"minInteger":
1}'
>
4375 The amount of time since this controller last disconnected from
4376 the switch (in seconds). Value is empty if controller has never
4381 <group title=
"Connection Parameters">
4383 Additional configuration for a connection between the controller
4384 and the Open vSwitch.
4387 <column name=
"other_config" key=
"dscp"
4388 type='{
"type":
"integer"}'
>
4389 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4390 in the Type of Service (TOS) field in the IP header. DSCP provides a
4391 mechanism to classify the network traffic and provide Quality of
4392 Service (QoS) on IP networks.
4394 The DSCP value specified here is used when establishing the connection
4395 between the controller and the Open vSwitch. If no value is specified,
4396 a default value of
48 is chosen. Valid DSCP values must be in the
4402 <group title=
"Common Columns">
4403 The overall purpose of these columns is described under
<code>Common
4404 Columns
</code> at the beginning of this document.
4406 <column name=
"external_ids"/>
4407 <column name=
"other_config"/>
4411 <table name=
"Manager" title=
"OVSDB management connection.">
4413 Configuration for a database connection to an Open vSwitch database
4418 This table primarily configures the Open vSwitch database
4419 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
4420 (
<code>ovs-vswitchd
</code>). The switch does read the table to determine
4421 what connections should be treated as in-band.
4425 The Open vSwitch database server can initiate and maintain active
4426 connections to remote clients. It can also listen for database
4430 <group title=
"Core Features">
4431 <column name=
"target">
4432 <p>Connection method for managers.
</p>
4434 The following connection methods are currently supported:
4437 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4440 The specified SSL
<var>port
</var> on the host at the given
4441 <var>ip
</var>, which must be expressed as an IP address
4442 (not a DNS name). The
<ref table=
"Open_vSwitch"
4443 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
4444 table must point to a valid SSL configuration when this
4448 If
<var>port
</var> is not specified, it defaults to
6640.
4451 SSL support is an optional feature that is not always
4452 built as part of Open vSwitch.
4456 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4459 The specified TCP
<var>port
</var> on the host at the given
4460 <var>ip
</var>, which must be expressed as an IP address (not a
4461 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
4462 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4463 e.g.
<code>tcp:[::
1]:
6640</code>.
4466 If
<var>port
</var> is not specified, it defaults to
6640.
4469 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4472 Listens for SSL connections on the specified TCP
<var>port
</var>.
4473 Specify
0 for
<var>port
</var> to have the kernel automatically
4474 choose an available port. If
<var>ip
</var>, which must be
4475 expressed as an IP address (not a DNS name), is specified, then
4476 connections are restricted to the specified local IP address
4477 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4478 address, wrap in square brackets,
4479 e.g.
<code>pssl:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4480 specified then it listens only on IPv4 (but not IPv6) addresses.
4481 The
<ref table=
"Open_vSwitch" column=
"ssl"/> column in the
<ref
4482 table=
"Open_vSwitch"/> table must point to a valid SSL
4483 configuration when this form is used.
4486 If
<var>port
</var> is not specified, it defaults to
6640.
4489 SSL support is an optional feature that is not always built as
4490 part of Open vSwitch.
4493 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4496 Listens for connections on the specified TCP
<var>port
</var>.
4497 Specify
0 for
<var>port
</var> to have the kernel automatically
4498 choose an available port. If
<var>ip
</var>, which must be
4499 expressed as an IP address (not a DNS name), is specified, then
4500 connections are restricted to the specified local IP address
4501 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4502 address, wrap it in square brackets,
4503 e.g.
<code>ptcp:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4504 specified then it listens only on IPv4 addresses.
4507 If
<var>port
</var> is not specified, it defaults to
6640.
4511 <p>When multiple managers are configured, the
<ref column=
"target"/>
4512 values must be unique. Duplicate
<ref column=
"target"/> values yield
4513 unspecified results.
</p>
4516 <column name=
"connection_mode">
4518 If it is specified, this setting must be one of the following strings
4519 that describes how Open vSwitch contacts this OVSDB client over the
4524 <dt><code>in-band
</code></dt>
4526 In this mode, this connection's traffic travels over a bridge
4527 managed by Open vSwitch. With this setting, Open vSwitch allows
4528 traffic to and from the client regardless of the contents of the
4529 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4530 to connect to the client, because it did not have a flow to enable
4531 it.) This is the most common connection mode because it is not
4532 necessary to maintain two independent networks.
4534 <dt><code>out-of-band
</code></dt>
4536 In this mode, the client's traffic uses a control network separate
4537 from that managed by Open vSwitch, that is, Open vSwitch does not
4538 use any of its own network devices to communicate with the client.
4539 The control network must be configured separately, before or after
4540 <code>ovs-vswitchd
</code> is started.
4545 If not specified, the default is implementation-specific.
4550 <group title=
"Client Failure Detection and Handling">
4551 <column name=
"max_backoff">
4552 Maximum number of milliseconds to wait between connection attempts.
4553 Default is implementation-specific.
4556 <column name=
"inactivity_probe">
4557 Maximum number of milliseconds of idle time on connection to the client
4558 before sending an inactivity probe message. If Open vSwitch does not
4559 communicate with the client for the specified number of seconds, it
4560 will send a probe. If a response is not received for the same
4561 additional amount of time, Open vSwitch assumes the connection has been
4562 broken and attempts to reconnect. Default is implementation-specific.
4563 A value of
0 disables inactivity probes.
4567 <group title=
"Status">
4569 Key-value pair of
<ref column=
"is_connected"/> is always updated.
4570 Other key-value pairs in the status columns may be updated depends
4571 on the
<ref column=
"target"/> type.
4575 When
<ref column=
"target"/> specifies a connection method that
4576 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4577 <code>punix:
</code>), both
<ref column=
"n_connections"/> and
4578 <ref column=
"is_connected"/> may also be updated while the
4579 remaining key-value pairs are omitted.
4583 On the other hand, when
<ref column=
"target"/> specifies an
4584 outbound connection, all key-value pairs may be updated, except
4585 the above-mentioned two key-value pairs associated with inbound
4586 connection targets. They are omitted.
4589 <column name=
"is_connected">
4590 <code>true
</code> if currently connected to this manager,
4591 <code>false
</code> otherwise.
4594 <column name=
"status" key=
"last_error">
4595 A human-readable description of the last error on the connection
4596 to the manager; i.e.
<code>strerror(errno)
</code>. This key
4597 will exist only if an error has occurred.
4600 <column name=
"status" key=
"state"
4601 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4603 The state of the connection to the manager:
4606 <dt><code>VOID
</code></dt>
4607 <dd>Connection is disabled.
</dd>
4609 <dt><code>BACKOFF
</code></dt>
4610 <dd>Attempting to reconnect at an increasing period.
</dd>
4612 <dt><code>CONNECTING
</code></dt>
4613 <dd>Attempting to connect.
</dd>
4615 <dt><code>ACTIVE
</code></dt>
4616 <dd>Connected, remote host responsive.
</dd>
4618 <dt><code>IDLE
</code></dt>
4619 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4622 These values may change in the future. They are provided only for
4627 <column name=
"status" key=
"sec_since_connect"
4628 type='{
"type":
"integer",
"minInteger":
0}'
>
4629 The amount of time since this manager last successfully connected
4630 to the database (in seconds). Value is empty if manager has never
4631 successfully connected.
4634 <column name=
"status" key=
"sec_since_disconnect"
4635 type='{
"type":
"integer",
"minInteger":
0}'
>
4636 The amount of time since this manager last disconnected from the
4637 database (in seconds). Value is empty if manager has never
4641 <column name=
"status" key=
"locks_held">
4642 Space-separated list of the names of OVSDB locks that the connection
4643 holds. Omitted if the connection does not hold any locks.
4646 <column name=
"status" key=
"locks_waiting">
4647 Space-separated list of the names of OVSDB locks that the connection is
4648 currently waiting to acquire. Omitted if the connection is not waiting
4652 <column name=
"status" key=
"locks_lost">
4653 Space-separated list of the names of OVSDB locks that the connection
4654 has had stolen by another OVSDB client. Omitted if no locks have been
4655 stolen from this connection.
4658 <column name=
"status" key=
"n_connections"
4659 type='{
"type":
"integer",
"minInteger":
2}'
>
4660 When
<ref column=
"target"/> specifies a connection method that
4661 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4662 <code>pssl:
</code>) and more than one connection is actually active,
4663 the value is the number of active connections. Otherwise, this
4664 key-value pair is omitted.
4667 <column name=
"status" key=
"bound_port" type='{
"type":
"integer"}'
>
4668 When
<ref column=
"target"/> is
<code>ptcp:
</code> or
4669 <code>pssl:
</code>, this is the TCP port on which the OVSDB server is
4670 listening. (This is particularly useful when
<ref
4671 column=
"target"/> specifies a port of
0, allowing the kernel to
4672 choose any available port.)
4676 <group title=
"Connection Parameters">
4678 Additional configuration for a connection between the manager
4679 and the Open vSwitch Database.
4682 <column name=
"other_config" key=
"dscp"
4683 type='{
"type":
"integer"}'
>
4684 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4685 in the Type of Service (TOS) field in the IP header. DSCP provides a
4686 mechanism to classify the network traffic and provide Quality of
4687 Service (QoS) on IP networks.
4689 The DSCP value specified here is used when establishing the connection
4690 between the manager and the Open vSwitch. If no value is specified, a
4691 default value of
48 is chosen. Valid DSCP values must be in the range
4696 <group title=
"Common Columns">
4697 The overall purpose of these columns is described under
<code>Common
4698 Columns
</code> at the beginning of this document.
4700 <column name=
"external_ids"/>
4701 <column name=
"other_config"/>
4705 <table name=
"NetFlow">
4706 A NetFlow target. NetFlow is a protocol that exports a number of
4707 details about terminating IP flows, such as the principals involved
4710 <column name=
"targets">
4711 NetFlow targets in the form
4712 <code><var>ip
</var>:
<var>port
</var></code>. The
<var>ip
</var>
4713 must be specified numerically, not as a DNS name.
4716 <column name=
"engine_id">
4717 Engine ID to use in NetFlow messages. Defaults to datapath index
4721 <column name=
"engine_type">
4722 Engine type to use in NetFlow messages. Defaults to datapath
4723 index if not specified.
4726 <column name=
"active_timeout">
4728 The interval at which NetFlow records are sent for flows that
4729 are still active, in seconds. A value of
<code>0</code>
4730 requests the default timeout (currently
600 seconds); a value
4731 of
<code>-
1</code> disables active timeouts.
4735 The NetFlow passive timeout, for flows that become inactive,
4736 is not configurable. It will vary depending on the Open
4737 vSwitch version, the forms and contents of the OpenFlow flow
4738 tables, CPU and memory usage, and network activity. A typical
4739 passive timeout is about a second.
4743 <column name=
"add_id_to_interface">
4744 <p>If this column's value is
<code>false
</code>, the ingress and egress
4745 interface fields of NetFlow flow records are derived from OpenFlow port
4746 numbers. When it is
<code>true
</code>, the
7 most significant bits of
4747 these fields will be replaced by the least significant
7 bits of the
4748 engine id. This is useful because many NetFlow collectors do not
4749 expect multiple switches to be sending messages from the same host, so
4750 they do not store the engine information which could be used to
4751 disambiguate the traffic.
</p>
4752 <p>When this option is enabled, a maximum of
508 ports are supported.
</p>
4755 <group title=
"Common Columns">
4756 The overall purpose of these columns is described under
<code>Common
4757 Columns
</code> at the beginning of this document.
4759 <column name=
"external_ids"/>
4764 SSL configuration for an Open_vSwitch.
4766 <column name=
"private_key">
4767 Name of a PEM file containing the private key used as the switch's
4768 identity for SSL connections to the controller.
4771 <column name=
"certificate">
4772 Name of a PEM file containing a certificate, signed by the
4773 certificate authority (CA) used by the controller and manager,
4774 that certifies the switch's private key, identifying a trustworthy
4778 <column name=
"ca_cert">
4779 Name of a PEM file containing the CA certificate used to verify
4780 that the switch is connected to a trustworthy controller.
4783 <column name=
"bootstrap_ca_cert">
4784 If set to
<code>true
</code>, then Open vSwitch will attempt to
4785 obtain the CA certificate from the controller on its first SSL
4786 connection and save it to the named PEM file. If it is successful,
4787 it will immediately drop the connection and reconnect, and from then
4788 on all SSL connections must be authenticated by a certificate signed
4789 by the CA certificate thus obtained.
<em>This option exposes the
4790 SSL connection to a man-in-the-middle attack obtaining the initial
4791 CA certificate.
</em> It may still be useful for bootstrapping.
4794 <group title=
"Common Columns">
4795 The overall purpose of these columns is described under
<code>Common
4796 Columns
</code> at the beginning of this document.
4798 <column name=
"external_ids"/>
4802 <table name=
"sFlow">
4803 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4804 monitoring of switches.
</p>
4806 <column name=
"agent">
4807 Name of the network device whose IP address should be reported as the
4808 ``agent address'' to collectors. If not specified, the agent device is
4809 figured from the first target address and the routing table. If the
4810 routing table does not contain a route to the target, the IP address
4811 defaults to the
<ref table=
"Controller" column=
"local_ip"/> in the
4812 collector's
<ref table=
"Controller"/>. If an agent IP address cannot be
4813 determined any of these ways, sFlow is disabled.
4816 <column name=
"header">
4817 Number of bytes of a sampled packet to send to the collector.
4818 If not specified, the default is
128 bytes.
4821 <column name=
"polling">
4822 Polling rate in seconds to send port statistics to the collector.
4823 If not specified, defaults to
30 seconds.
4826 <column name=
"sampling">
4827 Rate at which packets should be sampled and sent to the collector.
4828 If not specified, defaults to
400, which means one out of
400
4829 packets, on average, will be sent to the collector.
4832 <column name=
"targets">
4833 sFlow targets in the form
4834 <code><var>ip
</var>:
<var>port
</var></code>.
4837 <group title=
"Common Columns">
4838 The overall purpose of these columns is described under
<code>Common
4839 Columns
</code> at the beginning of this document.
4841 <column name=
"external_ids"/>
4845 <table name=
"IPFIX">
4846 <p>Configuration for sending packets to IPFIX collectors.
</p>
4849 IPFIX is a protocol that exports a number of details about flows. The
4850 IPFIX implementation in Open vSwitch samples packets at a configurable
4851 rate, extracts flow information from those packets, optionally caches and
4852 aggregates the flow information, and sends the result to one or more
4857 IPFIX in Open vSwitch can be configured two different ways:
4862 With
<em>per-bridge sampling
</em>, Open vSwitch performs IPFIX sampling
4863 automatically on all packets that pass through a bridge. To configure
4864 per-bridge sampling, create an
<ref table=
"IPFIX"/> record and point a
4865 <ref table=
"Bridge"/> table's
<ref table=
"Bridge" column=
"ipfix"/>
4866 column to it. The
<ref table=
"Flow_Sample_Collector_Set"/> table is
4867 not used for per-bridge sampling.
4872 With
<em>flow-based sampling
</em>,
<code>sample
</code> actions in the
4873 OpenFlow flow table drive IPFIX sampling. See
4874 <code>ovs-ofctl
</code>(
8) for a description of the
4875 <code>sample
</code> action.
4879 Flow-based sampling also requires database configuration: create a
4880 <ref table=
"IPFIX"/> record that describes the IPFIX configuration
4881 and a
<ref table=
"Flow_Sample_Collector_Set"/> record that points to
4882 the
<ref table=
"Bridge"/> whose flow table holds the
4883 <code>sample
</code> actions and to
<ref table=
"IPFIX"/> record. The
4884 <ref table=
"Bridge" column=
"ipfix"/> in the
<ref table=
"Bridge"/>
4885 table is not used for flow-based sampling.
4890 <column name=
"targets">
4891 IPFIX target collectors in the form
4892 <code><var>ip
</var>:
<var>port
</var></code>.
4895 <column name=
"cache_active_timeout">
4896 The maximum period in seconds for which an IPFIX flow record is
4897 cached and aggregated before being sent. If not specified,
4898 defaults to
0. If
0, caching is disabled.
4901 <column name=
"cache_max_flows">
4902 The maximum number of IPFIX flow records that can be cached at a
4903 time. If not specified, defaults to
0. If
0, caching is
4907 <column name=
"other_config" key=
"enable-tunnel-sampling"
4908 type='{
"type":
"boolean"}'
>
4910 Set to
<code>true
</code> to enable sampling and reporting tunnel
4911 header
7-tuples in IPFIX flow records. Tunnel sampling is enabled
4916 The following enterprise entities report the sampled tunnel info:
4920 <dt>tunnelType:
</dt>
4922 <p>ID:
891, and enterprise ID
6876 (VMware).
</p>
4923 <p>type: unsigned
8-bit integer.
</p>
4924 <p>data type semantics: identifier.
</p>
4925 <p>description: Identifier of the layer
2 network overlay network
4926 encapsulation type:
0x01 VxLAN,
0x02 GRE,
0x03 LISP,
0x07 GENEVE.
</p>
4930 <p>ID:
892, and enterprise ID
6876 (VMware).
</p>
4931 <p>type: variable-length octetarray.
</p>
4932 <p>data type semantics: identifier.
</p>
4933 <p>description: Key which is used for identifying an individual
4934 traffic flow within a VxLAN (
24-bit VNI), GENEVE (
24-bit VNI),
4935 GRE (
32-bit key), or LISP (
24-bit instance ID) tunnel. The
4936 key is encoded in this octetarray as a
3-,
4-, or
8-byte integer
4937 ID in network byte order.
</p>
4939 <dt>tunnelSourceIPv4Address:
</dt>
4941 <p>ID:
893, and enterprise ID
6876 (VMware).
</p>
4942 <p>type: unsigned
32-bit integer.
</p>
4943 <p>data type semantics: identifier.
</p>
4944 <p>description: The IPv4 source address in the tunnel IP packet
4947 <dt>tunnelDestinationIPv4Address:
</dt>
4949 <p>ID:
894, and enterprise ID
6876 (VMware).
</p>
4950 <p>type: unsigned
32-bit integer.
</p>
4951 <p>data type semantics: identifier.
</p>
4952 <p>description: The IPv4 destination address in the tunnel IP
4955 <dt>tunnelProtocolIdentifier:
</dt>
4957 <p>ID:
895, and enterprise ID
6876 (VMware).
</p>
4958 <p>type: unsigned
8-bit integer.
</p>
4959 <p>data type semantics: identifier.
</p>
4960 <p>description: The value of the protocol number in the tunnel
4961 IP packet header. The protocol number identifies the tunnel IP
4962 packet payload type.
</p>
4964 <dt>tunnelSourceTransportPort:
</dt>
4966 <p>ID:
896, and enterprise ID
6876 (VMware).
</p>
4967 <p>type: unsigned
16-bit integer.
</p>
4968 <p>data type semantics: identifier.
</p>
4969 <p>description: The source port identifier in the tunnel transport
4970 header. For the transport protocols UDP, TCP, and SCTP, this is
4971 the source port number given in the respective header.
</p>
4973 <dt>tunnelDestinationTransportPort:
</dt>
4975 <p>ID:
897, and enterprise ID
6876 (VMware).
</p>
4976 <p>type: unsigned
16-bit integer.
</p>
4977 <p>data type semantics: identifier.
</p>
4978 <p>description: The destination port identifier in the tunnel
4979 transport header. For the transport protocols UDP, TCP, and SCTP,
4980 this is the destination port number given in the respective header.
4986 Before Open vSwitch
2.5.90,
<ref column=
"other_config"
4987 key=
"enable-tunnel-sampling"/> was only supported with per-bridge
4988 sampling, and ignored otherwise. Open vSwitch
2.5.90 and later support
4989 <ref column=
"other_config" key=
"enable-tunnel-sampling"/> for
4990 per-bridge and per-flow sampling.
4994 <column name=
"other_config" key=
"virtual_obs_id"
4995 type='{
"type":
"string"}'
>
4997 A string that accompanies each IPFIX flow record. Its intended use is
4998 for the ``virtual observation ID,'' an identifier of a virtual
4999 observation point that is locally unique in a virtual network. It
5000 describes a location in the virtual network where IP packets can be
5001 observed. The maximum length is
254 bytes. If not specified, the
5002 field is omitted from the IPFIX flow record.
5006 The following enterprise entity reports the specified virtual
5011 <dt>virtualObsID:
</dt>
5013 <p>ID:
898, and enterprise ID
6876 (VMware).
</p>
5014 <p>type: variable-length string.
</p>
5015 <p>data type semantics: identifier.
</p>
5016 <p>description: A virtual observation domain ID that is locally
5017 unique in a virtual network.
5023 This feature was introduced in Open vSwitch
2.5.90.
5027 <group title=
"Per-Bridge Sampling">
5029 These values affect only per-bridge sampling. See above for a
5030 description of the differences between per-bridge and flow-based
5034 <column name=
"sampling">
5035 The rate at which packets should be sampled and sent to each target
5036 collector. If not specified, defaults to
400, which means one out of
5037 400 packets, on average, will be sent to each target collector.
5040 <column name=
"obs_domain_id">
5041 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
5042 specified, defaults to
0.
5045 <column name=
"obs_point_id">
5046 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
5047 specified, defaults to
0.
5050 <column name=
"other_config" key=
"enable-input-sampling"
5051 type='{
"type":
"boolean"}'
>
5052 By default, Open vSwitch samples and reports flows at bridge port input
5053 in IPFIX flow records. Set this column to
<code>false
</code> to
5054 disable input sampling.
5057 <column name=
"other_config" key=
"enable-output-sampling"
5058 type='{
"type":
"boolean"}'
>
5059 By default, Open vSwitch samples and reports flows at bridge port
5060 output in IPFIX flow records. Set this column to
<code>false
</code> to
5061 disable output sampling.
5065 <group title=
"Common Columns">
5066 The overall purpose of these columns is described under
<code>Common
5067 Columns
</code> at the beginning of this document.
5069 <column name=
"external_ids"/>
5073 <table name=
"Flow_Sample_Collector_Set">
5075 A set of IPFIX collectors of packet samples generated by OpenFlow
5076 <code>sample
</code> actions. This table is used only for IPFIX
5077 flow-based sampling, not for per-bridge sampling (see the
<ref
5078 table=
"IPFIX"/> table for a description of the two forms).
5082 The ID of this collector set, unique among the bridge's
5083 collector sets, to be used as the
<code>collector_set_id
</code>
5084 in OpenFlow
<code>sample
</code> actions.
5087 <column name=
"bridge">
5088 The bridge into which OpenFlow
<code>sample
</code> actions can
5089 be added to send packet samples to this set of IPFIX collectors.
5092 <column name=
"ipfix">
5093 Configuration of the set of IPFIX collectors to send one flow
5094 record per sampled packet to.
5097 <group title=
"Common Columns">
5098 The overall purpose of these columns is described under
<code>Common
5099 Columns
</code> at the beginning of this document.
5101 <column name=
"external_ids"/>
5105 <table name=
"AutoAttach">
5107 Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
5108 draft standard describes a compact method of using IEEE
802.1AB Link
5109 Layer Discovery Protocol (LLDP) together with a IEEE
802.1aq Shortest
5110 Path Bridging (SPB) network to automatically attach network devices
5111 to individual services in a SPB network. The intent here is to allow
5112 network applications and devices using OVS to be able to easily take
5113 advantage of features offered by industry standard SPB networks.
5117 Auto Attach (AA) uses LLDP to communicate between a directly connected
5118 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
5119 is extended to add two new Type-Length-Value tuples (TLVs). The first
5120 new TLV supports the ongoing discovery of directly connected AA
5121 correspondents. Auto Attach operates by regularly transmitting AA
5122 discovery TLVs between the AA client and AA server. By exchanging these
5123 discovery messages, both the AAC and AAS learn the system name and
5124 system description of their peer. In the OVS context, OVS operates as
5125 the AA client and the AA server resides on a switch at the edge of the
5130 Once AA discovery has been completed the AAC then uses the second new TLV
5131 to deliver identifier mappings from the AAC to the AAS. A primary feature
5132 of Auto Attach is to facilitate the mapping of VLANs defined outside the
5133 SPB network onto service ids (ISIDs) defined within the SPM network. By
5134 doing so individual external VLANs can be mapped onto specific SPB
5135 network services. These VLAN id to ISID mappings can be configured and
5136 managed locally using new options added to the ovs-vsctl command.
5140 The Auto Attach OVS feature does not provide a full implementation of
5141 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
5142 standard and support for the AA TLV extensions is provided. LLDP
5143 protocol support in OVS can be enabled or disabled on a port by port
5144 basis. LLDP support is disabled by default.
5147 <column name=
"system_name">
5148 The system_name string is exported in LLDP messages. It should uniquely
5149 identify the bridge in the network.
5152 <column name=
"system_description">
5153 The system_description string is exported in LLDP messages. It should
5154 describe the type of software and hardware.
5157 <column name=
"mappings">
5158 A mapping from SPB network Individual Service Identifier (ISID) to VLAN