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.
79 <column name=
"other_config" key=
"stats-update-interval"
80 type='{
"type":
"integer",
"minInteger":
5000}'
>
82 Interval for updating statistics to the database, in milliseconds.
83 This option will affect the update of the
<code>statistics
</code>
84 column in the following tables:
<code>Port
</code>,
<code>Interface
85 </code>,
<code>Mirror
</code>.
88 Default value is
5000 ms.
91 Getting statistics more frequently can be achieved via OpenFlow.
95 <column name=
"other_config" key=
"flow-restore-wait"
96 type='{
"type":
"boolean"}'
>
98 When
<code>ovs-vswitchd
</code> starts up, it has an empty flow table
99 and therefore it handles all arriving packets in its default fashion
100 according to its configuration, by dropping them or sending them to
101 an OpenFlow controller or switching them as a standalone switch.
102 This behavior is ordinarily desirable. However, if
103 <code>ovs-vswitchd
</code> is restarting as part of a ``hot-upgrade,''
104 then this leads to a relatively long period during which packets are
108 This option allows for improvement. When
<code>ovs-vswitchd
</code>
109 starts with this value set as
<code>true
</code>, it will neither
110 flush or expire previously set datapath flows nor will it send and
111 receive any packets to or from the datapath. When this value is
112 later set to
<code>false
</code>,
<code>ovs-vswitchd
</code> will
113 start receiving packets from the datapath and re-setup the flows.
116 Thus, with this option, the procedure for a hot-upgrade of
117 <code>ovs-vswitchd
</code> becomes roughly the following:
121 Stop
<code>ovs-vswitchd
</code>.
124 Set
<ref column=
"other_config" key=
"flow-restore-wait"/>
125 to
<code>true
</code>.
128 Start
<code>ovs-vswitchd
</code>.
131 Use
<code>ovs-ofctl
</code> (or some other program, such as an
132 OpenFlow controller) to restore the OpenFlow flow table
133 to the desired state.
136 Set
<ref column=
"other_config" key=
"flow-restore-wait"/>
137 to
<code>false
</code> (or remove it entirely from the database).
141 The
<code>ovs-ctl
</code>'s ``restart'' and ``force-reload-kmod''
142 functions use the above config option during hot upgrades.
146 <column name=
"other_config" key=
"flow-limit"
147 type='{
"type":
"integer",
"minInteger":
0}'
>
150 number of flows allowed in the datapath flow table. Internally OVS
151 will choose a flow limit which will likely be lower than this number,
152 based on real time network conditions. Tweaking this value is
153 discouraged unless you know exactly what you're doing.
156 The default is
200000.
160 <column name=
"other_config" key=
"max-idle"
161 type='{
"type":
"integer",
"minInteger":
500}'
>
163 The maximum time (in ms) that idle flows will remain cached in the
164 datapath. Internally OVS will check the validity and activity for
165 datapath flows regularly and may expire flows quicker than this
166 number, based on real time network conditions. Tweaking this
167 value is discouraged unless you know exactly what you're doing.
170 The default is
10000.
174 <column name=
"other_config" key=
"dpdk-init"
175 type='{
"type":
"boolean"}'
>
177 Set this value to
<code>true
</code> to enable runtime support for
178 DPDK ports. The vswitch must have compile-time support for DPDK as
182 The default value is
<code>false
</code>. Changing this value requires
183 restarting the daemon
186 If this value is
<code>false
</code> at startup, any dpdk ports which
187 are configured in the bridge will fail due to memory errors.
191 <column name=
"other_config" key=
"dpdk-lcore-mask"
192 type='{
"type":
"integer",
"minInteger":
1}'
>
194 Specifies the CPU cores where dpdk lcore threads should be spawned.
195 The DPDK lcore threads are used for DPDK library tasks, such as
196 library internal message processing, logging, etc. Value should be in
197 the form of a hex string (so '
0x123') similar to the 'taskset' mask
201 The lowest order bit corresponds to the first CPU core. A set bit
202 means the corresponding core is available and an lcore thread will be
203 created and pinned to it. If the input does not cover all cores,
204 those uncovered cores are considered not set.
207 For performance reasons, it is best to set this to a single core on
208 the system, rather than allow lcore threads to float.
211 If not specified, the value will be determined by choosing the lowest
212 CPU core from initial cpu affinity list. Otherwise, the value will be
213 passed directly to the DPDK library.
217 <column name=
"other_config" key=
"pmd-cpu-mask">
219 Specifies CPU mask for setting the cpu affinity of PMD (Poll
220 Mode Driver) threads. Value should be in the form of hex string,
221 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
225 The lowest order bit corresponds to the first CPU core. A set bit
226 means the corresponding core is available and a pmd thread will be
227 created and pinned to it. If the input does not cover all cores,
228 those uncovered cores are considered not set.
231 If not specified, one pmd thread will be created for each numa node
232 and pinned to any available core on the numa node by default.
236 <column name=
"other_config" key=
"dpdk-alloc-mem"
237 type='{
"type":
"integer",
"minInteger":
0}'
>
239 Specifies the amount of memory to preallocate from the hugepage pool,
240 regardless of socket. It is recommended that dpdk-socket-mem is used
244 If not specified, the value is
0. Changing this value requires
245 restarting the daemon.
249 <column name=
"other_config" key=
"dpdk-socket-mem"
250 type='{
"type":
"string"}'
>
252 Specifies the amount of memory to preallocate from the hugepage pool,
253 on a per-socket basis.
256 The specifier is a comma-separated string, in ascending order of CPU
257 socket (ex:
1024,
2048,
4096,
8192 would set socket
0 to preallocate
258 1024MB, socket
1 to preallocate
2048MB, etc.)
261 If not specified, the default value is
1024,
0. Changing this value
262 requires restarting the daemon.
266 <column name=
"other_config" key=
"dpdk-hugepage-dir"
267 type='{
"type":
"string"}'
>
269 Specifies the path to the hugetlbfs mount point.
272 If not specified, this will be guessed by the DPDK library (default
273 is /dev/hugepages). Changing this value requires restarting the
278 <column name=
"other_config" key=
"dpdk-extra"
279 type='{
"type":
"string"}'
>
281 Specifies additional eal command line arguments for DPDK.
284 The default is empty. Changing this value requires restarting the
289 <column name=
"other_config" key=
"vhost-sock-dir"
290 type='{
"type":
"string"}'
>
292 Specifies the path to the vhost-user unix domain socket files. This
293 path must exist and be a subdirectory tree of the Open vSwitch
297 Defaults to the working directory of the application. Changing this
298 value requires restarting the daemon.
302 <column name=
"other_config" key=
"n-handler-threads"
303 type='{
"type":
"integer",
"minInteger":
1}'
>
305 Specifies the number of threads for software datapaths to use for
306 handling new flows. The default the number of online CPU cores minus
307 the number of revalidators.
310 This configuration is per datapath. If you have more than one
311 software datapath (e.g. some
<code>system
</code> bridges and some
312 <code>netdev
</code> bridges), then the total number of threads is
313 <code>n-handler-threads
</code> times the number of software
318 <column name=
"other_config" key=
"n-revalidator-threads"
319 type='{
"type":
"integer",
"minInteger":
1}'
>
321 Specifies the number of threads for software datapaths to use for
322 revalidating flows in the datapath. Typically, there is a direct
323 correlation between the number of revalidator threads, and the number
324 of flows allowed in the datapath. The default is the number of cpu
325 cores divided by four plus one. If
<code>n-handler-threads
</code> is
326 set, the default changes to the number of cpu cores minus the number
330 This configuration is per datapath. If you have more than one
331 software datapath (e.g. some
<code>system
</code> bridges and some
332 <code>netdev
</code> bridges), then the total number of threads is
333 <code>n-handler-threads
</code> times the number of software
339 <group title=
"Status">
340 <column name=
"next_cfg">
341 Sequence number for client to increment. When a client modifies
342 any part of the database configuration and wishes to wait for
343 Open vSwitch to finish applying the changes, it may increment
344 this sequence number.
347 <column name=
"cur_cfg">
348 Sequence number that Open vSwitch sets to the current value of
349 <ref column=
"next_cfg"/> after it finishes applying a set of
350 configuration changes.
353 <group title=
"Statistics">
355 The
<code>statistics
</code> column contains key-value pairs that
356 report statistics about a system running an Open vSwitch. These are
357 updated periodically (currently, every
5 seconds). Key-value pairs
358 that cannot be determined or that do not apply to a platform are
362 <column name=
"other_config" key=
"enable-statistics"
363 type='{
"type":
"boolean"}'
>
364 Statistics are disabled by default to avoid overhead in the common
365 case when statistics gathering is not useful. Set this value to
366 <code>true
</code> to enable populating the
<ref column=
"statistics"/>
367 column or to
<code>false
</code> to explicitly disable it.
370 <column name=
"statistics" key=
"cpu"
371 type='{
"type":
"integer",
"minInteger":
1}'
>
373 Number of CPU processors, threads, or cores currently online and
374 available to the operating system on which Open vSwitch is running,
375 as an integer. This may be less than the number installed, if some
376 are not online or if they are not available to the operating
380 Open vSwitch userspace processes are not multithreaded, but the
381 Linux kernel-based datapath is.
385 <column name=
"statistics" key=
"load_average">
386 A comma-separated list of three floating-point numbers,
387 representing the system load average over the last
1,
5, and
15
388 minutes, respectively.
391 <column name=
"statistics" key=
"memory">
393 A comma-separated list of integers, each of which represents a
394 quantity of memory in kilobytes that describes the operating
395 system on which Open vSwitch is running. In respective order,
400 <li>Total amount of RAM allocated to the OS.
</li>
401 <li>RAM allocated to the OS that is in use.
</li>
402 <li>RAM that can be flushed out to disk or otherwise discarded
403 if that space is needed for another purpose. This number is
404 necessarily less than or equal to the previous value.
</li>
405 <li>Total disk space allocated for swap.
</li>
406 <li>Swap space currently in use.
</li>
410 On Linux, all five values can be determined and are included. On
411 other operating systems, only the first two values can be
412 determined, so the list will only have two values.
416 <column name=
"statistics" key=
"process_NAME">
418 One such key-value pair, with
<code>NAME
</code> replaced by
419 a process name, will exist for each running Open vSwitch
420 daemon process, with
<var>name
</var> replaced by the
421 daemon's name (e.g.
<code>process_ovs-vswitchd
</code>). The
422 value is a comma-separated list of integers. The integers
423 represent the following, with memory measured in kilobytes
424 and durations in milliseconds:
428 <li>The process's virtual memory size.
</li>
429 <li>The process's resident set size.
</li>
430 <li>The amount of user and system CPU time consumed by the
432 <li>The number of times that the process has crashed and been
433 automatically restarted by the monitor.
</li>
434 <li>The duration since the process was started.
</li>
435 <li>The duration for which the process has been running.
</li>
439 The interpretation of some of these values depends on whether the
440 process was started with the
<option>--monitor
</option>. If it
441 was not, then the crash count will always be
0 and the two
442 durations will always be the same. If
<option>--monitor
</option>
443 was given, then the crash count may be positive; if it is, the
444 latter duration is the amount of time since the most recent crash
449 There will be one key-value pair for each file in Open vSwitch's
450 ``run directory'' (usually
<code>/var/run/openvswitch
</code>)
451 whose name ends in
<code>.pid
</code>, whose contents are a
452 process ID, and which is locked by a running process. The
453 <var>name
</var> is taken from the pidfile's name.
457 Currently Open vSwitch is only able to obtain all of the above
458 detail on Linux systems. On other systems, the same key-value
459 pairs will be present but the values will always be the empty
464 <column name=
"statistics" key=
"file_systems">
466 A space-separated list of information on local, writable file
467 systems. Each item in the list describes one file system and
468 consists in turn of a comma-separated list of the following:
472 <li>Mount point, e.g.
<code>/
</code> or
<code>/var/log
</code>.
473 Any spaces or commas in the mount point are replaced by
475 <li>Total size, in kilobytes, as an integer.
</li>
476 <li>Amount of storage in use, in kilobytes, as an integer.
</li>
480 This key-value pair is omitted if there are no local, writable
481 file systems or if Open vSwitch cannot obtain the needed
488 <group title=
"Version Reporting">
490 These columns report the types and versions of the hardware and
491 software running Open vSwitch. We recommend in general that software
492 should test whether specific features are supported instead of relying
493 on version number checks. These values are primarily intended for
494 reporting to human administrators.
497 <column name=
"ovs_version">
498 The Open vSwitch version number, e.g.
<code>1.1.0</code>.
501 <column name=
"db_version">
503 The database schema version number in the form
504 <code><var>major
</var>.
<var>minor
</var>.
<var>tweak
</var></code>,
505 e.g.
<code>1.2.3</code>. Whenever the database schema is changed in
506 a non-backward compatible way (e.g. deleting a column or a table),
507 <var>major
</var> is incremented. When the database schema is changed
508 in a backward compatible way (e.g. adding a new column),
509 <var>minor
</var> is incremented. When the database schema is changed
510 cosmetically (e.g. reindenting its syntax),
<var>tweak
</var> is
515 The schema version is part of the database schema, so it can also be
516 retrieved by fetching the schema using the Open vSwitch database
521 <column name=
"system_type">
523 An identifier for the type of system on top of which Open vSwitch
524 runs, e.g.
<code>XenServer
</code> or
<code>KVM
</code>.
527 System integrators are responsible for choosing and setting an
528 appropriate value for this column.
532 <column name=
"system_version">
534 The version of the system identified by
<ref column=
"system_type"/>,
535 e.g.
<code>5.6.100-
39265p
</code> on XenServer
5.6.100 build
39265.
538 System integrators are responsible for choosing and setting an
539 appropriate value for this column.
545 <group title=
"Capabilities">
547 These columns report capabilities of the Open vSwitch instance.
549 <column name=
"datapath_types">
551 This column reports the different dpifs registered with the system.
552 These are the values that this instance supports in the
<ref
553 column=
"datapath_type" table=
"Bridge"/> column of the
<ref
554 table=
"Bridge"/> table.
557 <column name=
"iface_types">
559 This column reports the different netdevs registered with the system.
560 These are the values that this instance supports in the
<ref
561 column=
"type" table=
"Interface"/> column of the
<ref
562 table=
"Interface"/> table.
567 <group title=
"Database Configuration">
569 These columns primarily configure the Open vSwitch database
570 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
571 (
<code>ovs-vswitchd
</code>). The OVSDB database also uses the
<ref
572 column=
"ssl"/> settings.
576 The Open vSwitch switch does read the database configuration to
577 determine remote IP addresses to which in-band control should apply.
580 <column name=
"manager_options">
581 Database clients to which the Open vSwitch database server should
582 connect or to which it should listen, along with options for how these
583 connection should be configured. See the
<ref table=
"Manager"/> table
584 for more information.
588 <group title=
"Common Columns">
589 The overall purpose of these columns is described under
<code>Common
590 Columns
</code> at the beginning of this document.
592 <column name=
"other_config"/>
593 <column name=
"external_ids"/>
597 <table name=
"Bridge">
599 Configuration for a bridge within an
600 <ref table=
"Open_vSwitch"/>.
603 A
<ref table=
"Bridge"/> record represents an Ethernet switch with one or
604 more ``ports,'' which are the
<ref table=
"Port"/> records pointed to by
605 the
<ref table=
"Bridge"/>'s
<ref column=
"ports"/> column.
608 <group title=
"Core Features">
611 Bridge identifier. Must be unique among the names of ports,
612 interfaces, and bridges on a host.
616 The name must be alphanumeric and must not contain forward or
617 backward slashes. The name of a bridge is also the name of an
<ref
618 table=
"Interface"/> (and a
<ref table=
"Port"/>) within the bridge, so
619 the restrictions on the
<ref table=
"Interface" column=
"name"/> column
620 in the
<ref table=
"Interface"/> table, particularly on length, also
621 apply to bridge names. Refer to the documentation for
<ref
622 table=
"Interface"/> names for details.
626 <column name=
"ports">
627 Ports included in the bridge.
630 <column name=
"mirrors">
631 Port mirroring configuration.
634 <column name=
"netflow">
635 NetFlow configuration.
638 <column name=
"sflow">
639 sFlow(R) configuration.
642 <column name=
"ipfix">
646 <column name=
"flood_vlans">
648 VLAN IDs of VLANs on which MAC address learning should be disabled,
649 so that packets are flooded instead of being sent to specific ports
650 that are believed to contain packets' destination MACs. This should
651 ordinarily be used to disable MAC learning on VLANs used for
652 mirroring (RSPAN VLANs). It may also be useful for debugging.
655 SLB bonding (see the
<ref table=
"Port" column=
"bond_mode"/> column in
656 the
<ref table=
"Port"/> table) is incompatible with
657 <code>flood_vlans
</code>. Consider using another bonding mode or
658 a different type of mirror instead.
662 <column name=
"auto_attach">
663 Auto Attach configuration.
667 <group title=
"OpenFlow Configuration">
668 <column name=
"controller">
670 OpenFlow controller set. If unset, then no OpenFlow controllers
675 If there are primary controllers, removing all of them clears the
676 flow table. If there are no primary controllers, adding one also
677 clears the flow table. Other changes to the set of controllers, such
678 as adding or removing a service controller, adding another primary
679 controller to supplement an existing primary controller, or removing
680 only one of two primary controllers, have no effect on the flow
685 <column name=
"flow_tables">
686 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
687 table ID to configuration for that table.
690 <column name=
"fail_mode">
691 <p>When a controller is configured, it is, ordinarily, responsible
692 for setting up all flows on the switch. Thus, if the connection to
693 the controller fails, no new network connections can be set up.
694 If the connection to the controller stays down long enough,
695 no packets can pass through the switch at all. This setting
696 determines the switch's response to such a situation. It may be set
697 to one of the following:
699 <dt><code>standalone
</code></dt>
700 <dd>If no message is received from the controller for three
701 times the inactivity probe interval
702 (see
<ref column=
"inactivity_probe"/>), then Open vSwitch
703 will take over responsibility for setting up flows. In
704 this mode, Open vSwitch causes the bridge to act like an
705 ordinary MAC-learning switch. Open vSwitch will continue
706 to retry connecting to the controller in the background
707 and, when the connection succeeds, it will discontinue its
708 standalone behavior.
</dd>
709 <dt><code>secure
</code></dt>
710 <dd>Open vSwitch will not set up flows on its own when the
711 controller connection fails or when no controllers are
712 defined. The bridge will continue to retry connecting to
713 any defined controllers forever.
</dd>
717 The default is
<code>standalone
</code> if the value is unset, but
718 future versions of Open vSwitch may change the default.
721 The
<code>standalone
</code> mode can create forwarding loops on a
722 bridge that has more than one uplink port unless STP is enabled. To
723 avoid loops on such a bridge, configure
<code>secure
</code> mode or
724 enable STP (see
<ref column=
"stp_enable"/>).
726 <p>When more than one controller is configured,
727 <ref column=
"fail_mode"/> is considered only when none of the
728 configured controllers can be contacted.
</p>
730 Changing
<ref column=
"fail_mode"/> when no primary controllers are
731 configured clears the flow table.
735 <column name=
"datapath_id">
736 Reports the OpenFlow datapath ID in use. Exactly
16 hex digits.
737 (Setting this column has no useful effect. Set
<ref
738 column=
"other-config" key=
"datapath-id"/> instead.)
741 <column name=
"datapath_version">
743 Reports the version number of the Open vSwitch datapath in use.
744 This allows management software to detect and report discrepancies
745 between Open vSwitch userspace and datapath versions. (The
<ref
746 column=
"ovs_version" table=
"Open_vSwitch"/> column in the
<ref
747 table=
"Open_vSwitch"/> reports the Open vSwitch userspace version.)
748 The version reported depends on the datapath in use:
753 When the kernel module included in the Open vSwitch source tree is
754 used, this column reports the Open vSwitch version from which the
759 When the kernel module that is part of the upstream Linux kernel is
760 used, this column reports
<code><unknown
></code>.
764 When the datapath is built into the
<code>ovs-vswitchd
</code>
765 binary, this column reports
<code><built-in
></code>. A
766 built-in datapath is by definition the same version as the rest of
767 the Open VSwitch userspace.
771 Other datapaths (such as the Hyper-V kernel datapath) currently
772 report
<code><unknown
></code>.
777 A version discrepancy between
<code>ovs-vswitchd
</code> and the
778 datapath in use is not normally cause for alarm. The Open vSwitch
779 kernel datapaths for Linux and Hyper-V, in particular, are designed
780 for maximum inter-version compatibility: any userspace version works
781 with with any kernel version. Some reasons do exist to insist on
782 particular user/kernel pairings. First, newer kernel versions add
783 new features, that can only be used by new-enough userspace, e.g.
784 VXLAN tunneling requires certain minimal userspace and kernel
785 versions. Second, as an extension to the first reason, some newer
786 kernel versions add new features for enhancing performance that only
787 new-enough userspace versions can take advantage of.
791 <column name=
"other_config" key=
"datapath-id">
792 Exactly
16 hex digits to set the OpenFlow datapath ID to a specific
793 value. May not be all-zero.
796 <column name=
"other_config" key=
"dp-desc">
797 Human readable description of datapath. It it a maximum
256
798 byte-long free-form string to describe the datapath for
799 debugging purposes, e.g.
<code>switch3 in room
3120</code>.
802 <column name=
"other_config" key=
"disable-in-band"
803 type='{
"type":
"boolean"}'
>
804 If set to
<code>true
</code>, disable in-band control on the bridge
805 regardless of controller and manager settings.
808 <column name=
"other_config" key=
"in-band-queue"
809 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
810 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
811 that will be used by flows set up by in-band control on this bridge.
812 If unset, or if the port used by an in-band control flow does not have
813 QoS configured, or if the port does not have a queue with the specified
814 ID, the default queue is used instead.
817 <column name=
"protocols">
819 List of OpenFlow protocols that may be used when negotiating
820 a connection with a controller. OpenFlow
1.0,
1.1,
1.2, and
821 1.3 are enabled by default if this column is empty.
825 OpenFlow
1.4,
1.5, and
1.6 are not enabled by default because their
826 implementations are missing features. In addition, the OpenFlow
1.6
827 specification is still under development and thus subject to change.
832 <group title=
"Spanning Tree Configuration">
834 The IEEE
802.1D Spanning Tree Protocol (STP) is a network protocol
835 that ensures loop-free topologies. It allows redundant links to
836 be included in the network to provide automatic backup paths if
837 the active links fails.
841 These settings configure the slower-to-converge but still widely
842 supported version of Spanning Tree Protocol, sometimes known as
843 802.1D-
1998. Open vSwitch also supports the newer Rapid Spanning Tree
844 Protocol (RSTP), documented later in the section titled
<code>Rapid
845 Spanning Tree Configuration
</code>.
848 <group title=
"STP Configuration">
849 <column name=
"stp_enable" type='{
"type":
"boolean"}'
>
851 Enable spanning tree on the bridge. By default, STP is disabled
852 on bridges. Bond, internal, and mirror ports are not supported
853 and will not participate in the spanning tree.
857 STP and RSTP are mutually exclusive. If both are enabled, RSTP
862 <column name=
"other_config" key=
"stp-system-id">
863 The bridge's STP identifier (the lower
48 bits of the bridge-id)
865 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
866 By default, the identifier is the MAC address of the bridge.
869 <column name=
"other_config" key=
"stp-priority"
870 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
871 The bridge's relative priority value for determining the root
872 bridge (the upper
16 bits of the bridge-id). A bridge with the
873 lowest bridge-id is elected the root. By default, the priority
877 <column name=
"other_config" key=
"stp-hello-time"
878 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
879 The interval between transmissions of hello messages by
880 designated ports, in seconds. By default the hello interval is
884 <column name=
"other_config" key=
"stp-max-age"
885 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
886 The maximum age of the information transmitted by the bridge
887 when it is the root bridge, in seconds. By default, the maximum
891 <column name=
"other_config" key=
"stp-forward-delay"
892 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
893 The delay to wait between transitioning root and designated
894 ports to
<code>forwarding
</code>, in seconds. By default, the
895 forwarding delay is
15 seconds.
898 <column name=
"other_config" key=
"mcast-snooping-aging-time"
899 type='{
"type":
"integer",
"minInteger":
1}'
>
901 The maximum number of seconds to retain a multicast snooping entry for
902 which no packets have been seen. The default is currently
300
903 seconds (
5 minutes). The value, if specified, is forced into a
904 reasonable range, currently
15 to
3600 seconds.
908 <column name=
"other_config" key=
"mcast-snooping-table-size"
909 type='{
"type":
"integer",
"minInteger":
1}'
>
911 The maximum number of multicast snooping addresses to learn. The
912 default is currently
2048. The value, if specified, is forced into
913 a reasonable range, currently
10 to
1,
000,
000.
916 <column name=
"other_config" key=
"mcast-snooping-disable-flood-unregistered"
917 type='{
"type":
"boolean"}'
>
919 If set to
<code>false
</code>, unregistered multicast packets are forwarded
921 If set to
<code>true
</code>, unregistered multicast packets are forwarded
922 to ports connected to multicast routers.
927 <group title=
"STP Status">
929 These key-value pairs report the status of
802.1D-
1998. They are
930 present only if STP is enabled (via the
<ref column=
"stp_enable"/>
933 <column name=
"status" key=
"stp_bridge_id">
934 The bridge ID used in spanning tree advertisements, in the form
935 <var>xxxx
</var>.
<var>yyyyyyyyyyyy
</var> where the
<var>x
</var>s are
936 the STP priority, the
<var>y
</var>s are the STP system ID, and each
937 <var>x
</var> and
<var>y
</var> is a hex digit.
939 <column name=
"status" key=
"stp_designated_root">
940 The designated root for this spanning tree, in the same form as
<ref
941 column=
"status" key=
"stp_bridge_id"/>. If this bridge is the root,
942 this will have the same value as
<ref column=
"status"
943 key=
"stp_bridge_id"/>, otherwise it will differ.
945 <column name=
"status" key=
"stp_root_path_cost">
946 The path cost of reaching the designated bridge. A lower number is
947 better. The value is
0 if this bridge is the root, otherwise it is
953 <group title=
"Rapid Spanning Tree">
955 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
956 that ensures loop-free topologies. RSTP superseded STP with the
957 publication of
802.1D-
2004. Compared to STP, RSTP converges more
958 quickly and recovers more quickly from failures.
961 <group title=
"RSTP Configuration">
962 <column name=
"rstp_enable" type='{
"type":
"boolean"}'
>
964 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
965 on bridges. Bond, internal, and mirror ports are not supported
966 and will not participate in the spanning tree.
970 STP and RSTP are mutually exclusive. If both are enabled, RSTP
975 <column name=
"other_config" key=
"rstp-address">
976 The bridge's RSTP address (the lower
48 bits of the bridge-id)
978 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
979 By default, the address is the MAC address of the bridge.
982 <column name=
"other_config" key=
"rstp-priority"
983 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
61440}'
>
984 The bridge's relative priority value for determining the root
985 bridge (the upper
16 bits of the bridge-id). A bridge with the
986 lowest bridge-id is elected the root. By default, the priority
987 is
0x8000 (
32768). This value needs to be a multiple of
4096,
988 otherwise it's rounded to the nearest inferior one.
991 <column name=
"other_config" key=
"rstp-ageing-time"
992 type='{
"type":
"integer",
"minInteger":
10,
"maxInteger":
1000000}'
>
993 The Ageing Time parameter for the Bridge. The default value
997 <column name=
"other_config" key=
"rstp-force-protocol-version"
998 type='{
"type":
"integer"}'
>
999 The Force Protocol Version parameter for the Bridge. This
1000 can take the value
0 (STP Compatibility mode) or
2
1001 (the default, normal operation).
1004 <column name=
"other_config" key=
"rstp-max-age"
1005 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
1006 The maximum age of the information transmitted by the Bridge
1007 when it is the Root Bridge. The default value is
20.
1010 <column name=
"other_config" key=
"rstp-forward-delay"
1011 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
1012 The delay used by STP Bridges to transition Root and Designated
1013 Ports to Forwarding. The default value is
15.
1016 <column name=
"other_config" key=
"rstp-transmit-hold-count"
1017 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
1018 The Transmit Hold Count used by the Port Transmit state machine
1019 to limit transmission rate. The default value is
6.
1023 <group title=
"RSTP Status">
1025 These key-value pairs report the status of
802.1D-
2004. They are
1026 present only if RSTP is enabled (via the
<ref column=
"rstp_enable"/>
1029 <column name=
"rstp_status" key=
"rstp_bridge_id">
1030 The bridge ID used in rapid spanning tree advertisements, in the form
1031 <var>x
</var>.
<var>yyy
</var>.
<var>zzzzzzzzzzzz
</var> where
1032 <var>x
</var> is the RSTP priority, the
<var>y
</var>s are a locally
1033 assigned system ID extension, the
<var>z
</var>s are the STP system
1034 ID, and each
<var>x
</var>,
<var>y
</var>, or
<var>z
</var> is a hex
1037 <column name=
"rstp_status" key=
"rstp_root_id">
1038 The root of this spanning tree, in the same form as
<ref
1039 column=
"rstp_status" key=
"rstp_bridge_id"/>. If this bridge is the
1040 root, this will have the same value as
<ref column=
"rstp_status"
1041 key=
"rstp_bridge_id"/>, otherwise it will differ.
1043 <column name=
"rstp_status" key=
"rstp_root_path_cost"
1044 type='{
"type":
"integer",
"minInteger":
0}'
>
1045 The path cost of reaching the root. A lower number is better. The
1046 value is
0 if this bridge is the root, otherwise it is higher.
1048 <column name=
"rstp_status" key=
"rstp_designated_id">
1049 The RSTP designated ID, in the same form as
<ref column=
"rstp_status"
1050 key=
"rstp_bridge_id"/>.
1052 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1053 The RSTP designated port ID, as a
4-digit hex number.
1055 <column name=
"rstp_status" key=
"rstp_bridge_port_id">
1056 The RSTP bridge port ID, as a
4-digit hex number.
1061 <group title=
"Multicast Snooping Configuration">
1062 Multicast snooping (RFC
4541) monitors the Internet Group Management
1063 Protocol (IGMP) and Multicast Listener Discovery traffic between hosts
1064 and multicast routers. The switch uses what IGMP and MLD snooping
1065 learns to forward multicast traffic only to interfaces that are connected
1066 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
1067 MLDv1 and MLDv2 protocols.
1069 <column name=
"mcast_snooping_enable">
1070 Enable multicast snooping on the bridge. For now, the default
1075 <group title=
"Other Features">
1076 <column name=
"datapath_type">
1077 Name of datapath provider. The kernel datapath has type
1078 <code>system
</code>. The userspace datapath has type
1079 <code>netdev
</code>. A manager may refer to the
<ref
1080 table=
"Open_vSwitch" column=
"datapath_types"/> column of the
<ref
1081 table=
"Open_vSwitch"/> table for a list of the types accepted by this
1082 Open vSwitch instance.
1085 <column name=
"external_ids" key=
"bridge-id">
1086 A unique identifier of the bridge. On Citrix XenServer this will
1087 commonly be the same as
1088 <ref column=
"external_ids" key=
"xs-network-uuids"/>.
1091 <column name=
"external_ids" key=
"xs-network-uuids">
1092 Semicolon-delimited set of universally unique identifier(s) for the
1093 network with which this bridge is associated on a Citrix XenServer
1094 host. The network identifiers are RFC
4122 UUIDs as displayed by,
1095 e.g.,
<code>xe network-list
</code>.
1098 <column name=
"other_config" key=
"hwaddr">
1099 An Ethernet address in the form
1100 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
1101 to set the hardware address of the local port and influence the
1105 <column name=
"other_config" key=
"forward-bpdu"
1106 type='{
"type":
"boolean"}'
>
1109 Controls forwarding of BPDUs and other network control frames when
1110 NORMAL action is invoked. When this option is
<code>false
</code> or
1111 unset, frames with reserved Ethernet addresses (see table below) will
1112 not be forwarded. When this option is
<code>true
</code>, such frames
1113 will not be treated specially.
1117 The above general rule has the following exceptions:
1122 If STP is enabled on the bridge (see the
<ref column=
"stp_enable"
1123 table=
"Bridge"/> column in the
<ref table=
"Bridge"/> table), the
1124 bridge processes all received STP packets and never passes them to
1125 OpenFlow or forwards them. This is true even if STP is disabled on
1130 If LLDP is enabled on an interface (see the
<ref column=
"lldp"
1131 table=
"Interface"/> column in the
<ref table=
"Interface"/> table),
1132 the interface processes received LLDP packets and never passes them
1133 to OpenFlow or forwards them.
1138 Set this option to
<code>true
</code> if the Open vSwitch bridge
1139 connects different Ethernet networks and is not configured to
1144 This option affects packets with the following destination MAC
1149 <dt><code>01:
80:c2:
00:
00:
00</code></dt>
1150 <dd>IEEE
802.1D Spanning Tree Protocol (STP).
</dd>
1152 <dt><code>01:
80:c2:
00:
00:
01</code></dt>
1153 <dd>IEEE Pause frame.
</dd>
1155 <dt><code>01:
80:c2:
00:
00:
0<var>x
</var></code></dt>
1156 <dd>Other reserved protocols.
</dd>
1158 <dt><code>00:e0:
2b:
00:
00:
00</code></dt>
1159 <dd>Extreme Discovery Protocol (EDP).
</dd>
1162 <code>00:e0:
2b:
00:
00:
04</code> and
<code>00:e0:
2b:
00:
00:
06</code>
1164 <dd>Ethernet Automatic Protection Switching (EAPS).
</dd>
1166 <dt><code>01:
00:
0c:cc:cc:cc
</code></dt>
1168 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1169 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1173 <dt><code>01:
00:
0c:cc:cc:cd
</code></dt>
1174 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.
</dd>
1176 <dt><code>01:
00:
0c:cd:cd:cd
</code></dt>
1177 <dd>Cisco STP Uplink Fast.
</dd>
1179 <dt><code>01:
00:
0c:
00:
00:
00</code></dt>
1180 <dd>Cisco Inter Switch Link.
</dd>
1182 <dt><code>01:
00:
0c:cc:cc:c
<var>x
</var></code></dt>
1187 <column name=
"other_config" key=
"mac-aging-time"
1188 type='{
"type":
"integer",
"minInteger":
1}'
>
1190 The maximum number of seconds to retain a MAC learning entry for
1191 which no packets have been seen. The default is currently
300
1192 seconds (
5 minutes). The value, if specified, is forced into a
1193 reasonable range, currently
15 to
3600 seconds.
1197 A short MAC aging time allows a network to more quickly detect that a
1198 host is no longer connected to a switch port. However, it also makes
1199 it more likely that packets will be flooded unnecessarily, when they
1200 are addressed to a connected host that rarely transmits packets. To
1201 reduce the incidence of unnecessary flooding, use a MAC aging time
1202 longer than the maximum interval at which a host will ordinarily
1207 <column name=
"other_config" key=
"mac-table-size"
1208 type='{
"type":
"integer",
"minInteger":
1}'
>
1210 The maximum number of MAC addresses to learn. The default is
1211 currently
2048. The value, if specified, is forced into a reasonable
1212 range, currently
10 to
1,
000,
000.
1217 <group title=
"Common Columns">
1218 The overall purpose of these columns is described under
<code>Common
1219 Columns
</code> at the beginning of this document.
1221 <column name=
"other_config"/>
1222 <column name=
"external_ids"/>
1226 <table name=
"Port" table=
"Port or bond configuration.">
1227 <p>A port within a
<ref table=
"Bridge"/>.
</p>
1228 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1229 <ref column=
"interfaces"/> column. Such a port logically
1230 corresponds to a port on a physical Ethernet switch. A port
1231 with more than one interface is a ``bonded port'' (see
1232 <ref group=
"Bonding Configuration"/>).
</p>
1233 <p>Some properties that one might think as belonging to a port are actually
1234 part of the port's
<ref table=
"Interface"/> members.
</p>
1236 <column name=
"name">
1237 Port name. For a non-bonded port, this should be the same as its
1238 interface's name. Port names must otherwise be unique among the names of
1239 ports, interfaces, and bridges on a host. Because port and interfaces
1240 names are usually the same, the restrictions on the
<ref
1241 table=
"Interface" column=
"name"/> column in the
<ref table=
"Interface"/>
1242 table, particularly on length, also apply to port names. Refer to the
1243 documentation for
<ref table=
"Interface"/> names for details.
1246 <column name=
"interfaces">
1247 The port's interfaces. If there is more than one, this is a
1251 <group title=
"VLAN Configuration">
1252 <p>Bridge ports support the following types of VLAN configuration:
</p>
1257 A trunk port carries packets on one or more specified VLANs
1258 specified in the
<ref column=
"trunks"/> column (often, on every
1259 VLAN). A packet that ingresses on a trunk port is in the VLAN
1260 specified in its
802.1Q header, or VLAN
0 if the packet has no
1261 802.1Q header. A packet that egresses through a trunk port will
1262 have an
802.1Q header if it has a nonzero VLAN ID.
1266 Any packet that ingresses on a trunk port tagged with a VLAN that
1267 the port does not trunk is dropped.
1274 An access port carries packets on exactly one VLAN specified in the
1275 <ref column=
"tag"/> column. Packets egressing on an access port
1276 have no
802.1Q header.
1280 Any packet with an
802.1Q header with a nonzero VLAN ID that
1281 ingresses on an access port is dropped, regardless of whether the
1282 VLAN ID in the header is the access port's VLAN ID.
1286 <dt>native-tagged
</dt>
1288 A native-tagged port resembles a trunk port, with the exception that
1289 a packet without an
802.1Q header that ingresses on a native-tagged
1290 port is in the ``native VLAN'' (specified in the
<ref column=
"tag"/>
1294 <dt>native-untagged
</dt>
1296 A native-untagged port resembles a native-tagged port, with the
1297 exception that a packet that egresses on a native-untagged port in
1298 the native VLAN will not have an
802.1Q header.
1302 A packet will only egress through bridge ports that carry the VLAN of
1303 the packet, as described by the rules above.
1306 <column name=
"vlan_mode">
1308 The VLAN mode of the port, as described above. When this column is
1309 empty, a default mode is selected as follows:
1313 If
<ref column=
"tag"/> contains a value, the port is an access
1314 port. The
<ref column=
"trunks"/> column should be empty.
1317 Otherwise, the port is a trunk port. The
<ref column=
"trunks"/>
1318 column value is honored if it is present.
1325 For an access port, the port's implicitly tagged VLAN. For a
1326 native-tagged or native-untagged port, the port's native VLAN. Must
1327 be empty if this is a trunk port.
1331 <column name=
"trunks">
1333 For a trunk, native-tagged, or native-untagged port, the
802.1Q VLAN
1334 or VLANs that this port trunks; if it is empty, then the port trunks
1335 all VLANs. Must be empty if this is an access port.
1338 A native-tagged or native-untagged port always trunks its native
1339 VLAN, regardless of whether
<ref column=
"trunks"/> includes that
1344 <column name=
"other_config" key=
"priority-tags"
1345 type='{
"type":
"boolean"}'
>
1347 An
802.1Q header contains two important pieces of information: a VLAN
1348 ID and a priority. A frame with a zero VLAN ID, called a
1349 ``priority-tagged'' frame, is supposed to be treated the same way as
1350 a frame without an
802.1Q header at all (except for the priority).
1354 However, some network elements ignore any frame that has
802.1Q
1355 header at all, even when the VLAN ID is zero. Therefore, by default
1356 Open vSwitch does not output priority-tagged frames, instead omitting
1357 the
802.1Q header entirely if the VLAN ID is zero. Set this key to
1358 <code>true
</code> to enable priority-tagged frames on a port.
1362 Regardless of this setting, Open vSwitch omits the
802.1Q header on
1363 output if both the VLAN ID and priority would be zero.
1367 All frames output to native-tagged ports have a nonzero VLAN ID, so
1368 this setting is not meaningful on native-tagged ports.
1373 <group title=
"Bonding Configuration">
1374 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1375 allows for load balancing and fail-over.
</p>
1378 The following types of bonding will work with any kind of upstream
1379 switch. On the upstream switch, do not configure the interfaces as a
1384 <dt><code>balance-slb
</code></dt>
1386 Balances flows among slaves based on source MAC address and output
1387 VLAN, with periodic rebalancing as traffic patterns change.
1390 <dt><code>active-backup
</code></dt>
1392 Assigns all flows to one slave, failing over to a backup slave when
1393 the active slave is disabled. This is the only bonding mode in which
1394 interfaces may be plugged into different upstream switches.
1399 The following modes require the upstream switch to support
802.3ad with
1400 successful LACP negotiation. If LACP negotiation fails and
1401 other-config:lacp-fallback-ab is true, then
<code>active-backup
</code>
1406 <dt><code>balance-tcp
</code></dt>
1408 Balances flows among slaves based on L2, L3, and L4 protocol
1409 information such as destination MAC address, IP address, and TCP
1414 <p>These columns apply only to bonded ports. Their values are
1415 otherwise ignored.
</p>
1417 <column name=
"bond_mode">
1418 <p>The type of bonding used for a bonded port. Defaults to
1419 <code>active-backup
</code> if unset.
1423 <column name=
"other_config" key=
"bond-hash-basis"
1424 type='{
"type":
"integer"}'
>
1425 An integer hashed along with flows when choosing output slaves in load
1426 balanced bonds. When changed, all flows will be assigned different
1427 hash values possibly causing slave selection decisions to change. Does
1428 not affect bonding modes which do not employ load balancing such as
1429 <code>active-backup
</code>.
1432 <group title=
"Link Failure Detection">
1434 An important part of link bonding is detecting that links are down so
1435 that they may be disabled. These settings determine how Open vSwitch
1436 detects link failure.
1439 <column name=
"other_config" key=
"bond-detect-mode"
1440 type='{
"type":
"string",
"enum": [
"set", [
"carrier",
"miimon"]]}'
>
1441 The means used to detect link failures. Defaults to
1442 <code>carrier
</code> which uses each interface's carrier to detect
1443 failures. When set to
<code>miimon
</code>, will check for failures
1444 by polling each interface's MII.
1447 <column name=
"other_config" key=
"bond-miimon-interval"
1448 type='{
"type":
"integer"}'
>
1449 The interval, in milliseconds, between successive attempts to poll
1450 each interface's MII. Relevant only when
<ref column=
"other_config"
1451 key=
"bond-detect-mode"/> is
<code>miimon
</code>.
1454 <column name=
"bond_updelay">
1456 The number of milliseconds for which the link must stay up on an
1457 interface before the interface is considered to be up. Specify
1458 <code>0</code> to enable the interface immediately.
1462 This setting is honored only when at least one bonded interface is
1463 already enabled. When no interfaces are enabled, then the first
1464 bond interface to come up is enabled immediately.
1468 <column name=
"bond_downdelay">
1469 The number of milliseconds for which the link must stay down on an
1470 interface before the interface is considered to be down. Specify
1471 <code>0</code> to disable the interface immediately.
1475 <group title=
"LACP Configuration">
1477 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1478 allows switches to automatically detect that they are connected by
1479 multiple links and aggregate across those links. These settings
1480 control LACP behavior.
1483 <column name=
"lacp">
1484 Configures LACP on this port. LACP allows directly connected
1485 switches to negotiate which links may be bonded. LACP may be enabled
1486 on non-bonded ports for the benefit of any switches they may be
1487 connected to.
<code>active
</code> ports are allowed to initiate LACP
1488 negotiations.
<code>passive
</code> ports are allowed to participate
1489 in LACP negotiations initiated by a remote switch, but not allowed to
1490 initiate such negotiations themselves. If LACP is enabled on a port
1491 whose partner switch does not support LACP, the bond will be
1492 disabled, unless other-config:lacp-fallback-ab is set to true.
1493 Defaults to
<code>off
</code> if unset.
1496 <column name=
"other_config" key=
"lacp-system-id">
1497 The LACP system ID of this
<ref table=
"Port"/>. The system ID of a
1498 LACP bond is used to identify itself to its partners. Must be a
1499 nonzero MAC address. Defaults to the bridge Ethernet address if
1503 <column name=
"other_config" key=
"lacp-system-priority"
1504 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
1505 The LACP system priority of this
<ref table=
"Port"/>. In LACP
1506 negotiations, link status decisions are made by the system with the
1507 numerically lower priority.
1510 <column name=
"other_config" key=
"lacp-time"
1511 type='{
"type":
"string",
"enum": [
"set", [
"fast",
"slow"]]}'
>
1513 The LACP timing which should be used on this
<ref table=
"Port"/>.
1514 By default
<code>slow
</code> is used. When configured to be
1515 <code>fast
</code> LACP heartbeats are requested at a rate of once
1516 per second causing connectivity problems to be detected more
1517 quickly. In
<code>slow
</code> mode, heartbeats are requested at a
1518 rate of once every
30 seconds.
1522 <column name=
"other_config" key=
"lacp-fallback-ab"
1523 type='{
"type":
"boolean"}'
>
1525 Determines the behavior of openvswitch bond in LACP mode. If
1526 the partner switch does not support LACP, setting this option
1527 to
<code>true
</code> allows openvswitch to fallback to
1528 active-backup. If the option is set to
<code>false
</code>, the
1529 bond will be disabled. In both the cases, once the partner switch
1530 is configured to LACP mode, the bond will use LACP.
1535 <group title=
"Rebalancing Configuration">
1537 These settings control behavior when a bond is in
1538 <code>balance-slb
</code> or
<code>balance-tcp
</code> mode.
1541 <column name=
"other_config" key=
"bond-rebalance-interval"
1542 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
10000}'
>
1543 For a load balanced bonded port, the number of milliseconds between
1544 successive attempts to rebalance the bond, that is, to move flows
1545 from one interface on the bond to another in an attempt to keep usage
1546 of each interface roughly equal. If zero, load balancing is disabled
1547 on the bond (link failure still cause flows to move). If
1548 less than
1000ms, the rebalance interval will be
1000ms.
1552 <column name=
"bond_fake_iface">
1553 For a bonded port, whether to create a fake internal interface with the
1554 name of the port. Use only for compatibility with legacy software that
1559 <group title=
"Spanning Tree Protocol">
1561 The configuration here is only meaningful, and the status is only
1562 populated, when
802.1D-
1998 Spanning Tree Protocol is enabled on the
1563 port's
<ref column=
"Bridge"/> with its
<ref column=
"stp_enable"/>
1567 <group title=
"STP Configuration">
1568 <column name=
"other_config" key=
"stp-enable"
1569 type='{
"type":
"boolean"}'
>
1570 When STP is enabled on a bridge, it is enabled by default on all of
1571 the bridge's ports except bond, internal, and mirror ports (which do
1572 not work with STP). If this column's value is
<code>false
</code>,
1573 STP is disabled on the port.
1576 <column name=
"other_config" key=
"stp-port-num"
1577 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
255}'
>
1578 The port number used for the lower
8 bits of the port-id. By
1579 default, the numbers will be assigned automatically. If any
1580 port's number is manually configured on a bridge, then they
1584 <column name=
"other_config" key=
"stp-port-priority"
1585 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
255}'
>
1586 The port's relative priority value for determining the root
1587 port (the upper
8 bits of the port-id). A port with a lower
1588 port-id will be chosen as the root port. By default, the
1592 <column name=
"other_config" key=
"stp-path-cost"
1593 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
1594 Spanning tree path cost for the port. A lower number indicates
1595 a faster link. By default, the cost is based on the maximum
1600 <group title=
"STP Status">
1601 <column name=
"status" key=
"stp_port_id">
1602 The port ID used in spanning tree advertisements for this port, as
4
1603 hex digits. Configuring the port ID is described in the
1604 <code>stp-port-num
</code> and
<code>stp-port-priority
</code> keys of
1605 the
<code>other_config
</code> section earlier.
1607 <column name=
"status" key=
"stp_state"
1608 type='{
"type":
"string",
"enum": [
"set",
1609 [
"disabled",
"listening",
"learning",
1610 "forwarding",
"blocking"]]}'
>
1611 STP state of the port.
1613 <column name=
"status" key=
"stp_sec_in_state"
1614 type='{
"type":
"integer",
"minInteger":
0}'
>
1615 The amount of time this port has been in the current STP state, in
1618 <column name=
"status" key=
"stp_role"
1619 type='{
"type":
"string",
"enum": [
"set",
1620 [
"root",
"designated",
"alternate"]]}'
>
1621 STP role of the port.
1626 <group title=
"Rapid Spanning Tree Protocol">
1628 The configuration here is only meaningful, and the status and
1629 statistics are only populated, when
802.1D-
1998 Spanning Tree Protocol
1630 is enabled on the port's
<ref column=
"Bridge"/> with its
<ref
1631 column=
"stp_enable"/> column.
1634 <group title=
"RSTP Configuration">
1635 <column name=
"other_config" key=
"rstp-enable"
1636 type='{
"type":
"boolean"}'
>
1637 When RSTP is enabled on a bridge, it is enabled by default on all of
1638 the bridge's ports except bond, internal, and mirror ports (which do
1639 not work with RSTP). If this column's value is
<code>false
</code>,
1640 RSTP is disabled on the port.
1643 <column name=
"other_config" key=
"rstp-port-priority"
1644 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
240}'
>
1645 The port's relative priority value for determining the root port, in
1646 multiples of
16. By default, the port priority is
0x80 (
128). Any
1647 value in the lower
4 bits is rounded off. The significant upper
4
1648 bits become the upper
4 bits of the port-id. A port with the lowest
1649 port-id is elected as the root.
1652 <column name=
"other_config" key=
"rstp-port-num"
1653 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
1654 The local RSTP port number, used as the lower
12 bits of the port-id.
1655 By default the port numbers are assigned automatically, and typically
1656 may not correspond to the OpenFlow port numbers. A port with the
1657 lowest port-id is elected as the root.
1660 <column name=
"other_config" key=
"rstp-port-path-cost"
1661 type='{
"type":
"integer"}'
>
1662 The port path cost. The Port's contribution, when it is
1663 the Root Port, to the Root Path Cost for the Bridge. By default the
1664 cost is automatically calculated from the port's speed.
1667 <column name=
"other_config" key=
"rstp-port-admin-edge"
1668 type='{
"type":
"boolean"}'
>
1669 The admin edge port parameter for the Port. Default is
1673 <column name=
"other_config" key=
"rstp-port-auto-edge"
1674 type='{
"type":
"boolean"}'
>
1675 The auto edge port parameter for the Port. Default is
1679 <column name=
"other_config" key=
"rstp-port-mcheck"
1680 type='{
"type":
"boolean"}'
>
1682 The mcheck port parameter for the Port. Default is
1683 <code>false
</code>. May be set to force the Port Protocol
1684 Migration state machine to transmit RST BPDUs for a
1685 MigrateTime period, to test whether all STP Bridges on the
1686 attached LAN have been removed and the Port can continue to
1687 transmit RSTP BPDUs. Setting mcheck has no effect if the
1688 Bridge is operating in STP Compatibility mode.
1691 Changing the value from
<code>true
</code> to
1692 <code>false
</code> has no effect, but needs to be done if
1693 this behavior is to be triggered again by subsequently
1694 changing the value from
<code>false
</code> to
1700 <group title=
"RSTP Status">
1701 <column name=
"rstp_status" key=
"rstp_port_id">
1702 The port ID used in spanning tree advertisements for this port, as
4
1703 hex digits. Configuring the port ID is described in the
1704 <code>rstp-port-num
</code> and
<code>rstp-port-priority
</code> keys
1705 of the
<code>other_config
</code> section earlier.
1707 <column name=
"rstp_status" key=
"rstp_port_role"
1708 type='{
"type":
"string",
"enum": [
"set",
1709 [
"Root",
"Designated",
"Alternate",
"Backup",
"Disabled"]]}'
>
1710 RSTP role of the port.
1712 <column name=
"rstp_status" key=
"rstp_port_state"
1713 type='{
"type":
"string",
"enum": [
"set",
1714 [
"Disabled",
"Learning",
"Forwarding",
"Discarding"]]}'
>
1715 RSTP state of the port.
1717 <column name=
"rstp_status" key=
"rstp_designated_bridge_id">
1718 The port's RSTP designated bridge ID, in the same form as
<ref
1719 column=
"rstp_status" key=
"rstp_bridge_id"/> in the
<ref
1720 table=
"Bridge"/> table.
1722 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1723 The port's RSTP designated port ID, as
4 hex digits.
1725 <column name=
"rstp_status" key=
"rstp_designated_path_cost"
1726 type='{
"type":
"integer"}'
>
1727 The port's RSTP designated path cost. Lower is better.
1731 <group title=
"RSTP Statistics">
1732 <column name=
"rstp_statistics" key=
"rstp_tx_count">
1733 Number of RSTP BPDUs transmitted through this port.
1735 <column name=
"rstp_statistics" key=
"rstp_rx_count">
1736 Number of valid RSTP BPDUs received by this port.
1738 <column name=
"rstp_statistics" key=
"rstp_error_count">
1739 Number of invalid RSTP BPDUs received by this port.
1741 <column name=
"rstp_statistics" key=
"rstp_uptime">
1742 The duration covered by the other RSTP statistics, in seconds.
1747 <group title=
"Multicast Snooping">
1748 <column name=
"other_config" key=
"mcast-snooping-flood"
1749 type='{
"type":
"boolean"}'
>
1751 If set to
<code>true
</code>, multicast packets (except Reports) are
1752 unconditionally forwarded to the specific port.
1755 <column name=
"other_config" key=
"mcast-snooping-flood-reports"
1756 type='{
"type":
"boolean"}'
>
1758 If set to
<code>true
</code>, multicast Reports are unconditionally
1759 forwarded to the specific port.
1764 <group title=
"Other Features">
1766 Quality of Service configuration for this port.
1770 The MAC address to use for this port for the purpose of choosing the
1771 bridge's MAC address. This column does not necessarily reflect the
1772 port's actual MAC address, nor will setting it change the port's actual
1776 <column name=
"fake_bridge">
1777 Does this port represent a sub-bridge for its tagged VLAN within the
1778 Bridge? See ovs-vsctl(
8) for more information.
1781 <column name=
"external_ids" key=
"fake-bridge-id-*">
1782 External IDs for a fake bridge (see the
<ref column=
"fake_bridge"/>
1783 column) are defined by prefixing a
<ref table=
"Bridge"/> <ref
1784 table=
"Bridge" column=
"external_ids"/> key with
1785 <code>fake-bridge-
</code>,
1786 e.g.
<code>fake-bridge-xs-network-uuids
</code>.
1789 <column name=
"other_config" key=
"transient"
1790 type='{
"type":
"boolean"}'
>
1792 If set to
<code>true
</code>, the port will be removed when
1793 <code>ovs-ctl start --delete-transient-ports
</code> is used.
1798 <column name=
"bond_active_slave">
1799 For a bonded port, record the mac address of the current active slave.
1802 <group title=
"Port Statistics">
1804 Key-value pairs that report port statistics. The update period
1805 is controlled by
<ref column=
"other_config"
1806 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
1808 <group title=
"Statistics: STP transmit and receive counters">
1809 <column name=
"statistics" key=
"stp_tx_count">
1810 Number of STP BPDUs sent on this port by the spanning
1813 <column name=
"statistics" key=
"stp_rx_count">
1814 Number of STP BPDUs received on this port and accepted by the
1815 spanning tree library.
1817 <column name=
"statistics" key=
"stp_error_count">
1818 Number of bad STP BPDUs received on this port. Bad BPDUs
1819 include runt packets and those with an unexpected protocol ID.
1824 <group title=
"Common Columns">
1825 The overall purpose of these columns is described under
<code>Common
1826 Columns
</code> at the beginning of this document.
1828 <column name=
"other_config"/>
1829 <column name=
"external_ids"/>
1833 <table name=
"Interface" title=
"One physical network device in a Port.">
1834 An interface within a
<ref table=
"Port"/>.
1836 <group title=
"Core Features">
1837 <column name=
"name">
1839 Interface name. Should be alphanumeric. For non-bonded port, this
1840 should be the same as the port name. It must otherwise be unique
1841 among the names of ports, interfaces, and bridges on a host.
1845 The maximum length of an interface name depends on the underlying
1851 The names of interfaces implemented as Linux and BSD network
1852 devices, including interfaces with type
<code>internal
</code>,
1853 <code>tap
</code>, or
<code>system
</code> plus the different types
1854 of tunnel ports, are limited to
15 bytes. Windows limits these
1859 The names of patch ports are not used in the underlying datapath,
1860 so operating system restrictions do not apply. Thus, they may have
1866 Regardless of other restrictions, OpenFlow only supports
15-byte
1867 names, which means that
<code>ovs-ofctl
</code> and OpenFlow
1868 controllers will show names truncated to
15 bytes.
1872 <column name=
"ifindex">
1873 A positive interface index as defined for SNMP MIB-II in RFCs
1213 and
1874 2863, if the interface has one, otherwise
0. The ifindex is useful for
1875 seamless integration with protocols such as SNMP and sFlow.
1878 <column name=
"mac_in_use">
1879 The MAC address in use by this interface.
1883 <p>Ethernet address to set for this interface. If unset then the
1884 default MAC address is used:
</p>
1886 <li>For the local interface, the default is the lowest-numbered MAC
1887 address among the other bridge ports, either the value of the
1888 <ref table=
"Port" column=
"mac"/> in its
<ref table=
"Port"/> record,
1889 if set, or its actual MAC (for bonded ports, the MAC of its slave
1890 whose name is first in alphabetical order). Internal ports and
1891 bridge ports that are used as port mirroring destinations (see the
1892 <ref table=
"Mirror"/> table) are ignored.
</li>
1893 <li>For other internal interfaces, the default MAC is randomly
1895 <li>External interfaces typically have a MAC address associated with
1896 their hardware.
</li>
1898 <p>Some interfaces may not have a software-controllable MAC
1902 <column name=
"error">
1903 If the configuration of the port failed, as indicated by -
1 in
<ref
1904 column=
"ofport"/>, Open vSwitch sets this column to an error
1905 description in human readable form. Otherwise, Open vSwitch clears
1909 <group title=
"OpenFlow Port Number">
1911 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1912 port number for the new port. If the client that adds the port fills
1913 in
<ref column=
"ofport_request"/>, then Open vSwitch tries to use its
1914 value as the OpenFlow port number. Otherwise, or if the requested
1915 port number is already in use or cannot be used for another reason,
1916 Open vSwitch automatically assigns a free port number. Regardless of
1917 how the port number was obtained, Open vSwitch then reports in
<ref
1918 column=
"ofport"/> the port number actually assigned.
1922 Open vSwitch limits the port numbers that it automatically assigns to
1923 the range
1 through
32,
767, inclusive. Controllers therefore have
1924 free use of ports
32,
768 and up.
1927 <column name=
"ofport">
1929 OpenFlow port number for this interface. Open vSwitch sets this
1930 column's value, so other clients should treat it as read-only.
1933 The OpenFlow ``local'' port (
<code>OFPP_LOCAL
</code>) is
65,
534.
1934 The other valid port numbers are in the range
1 to
65,
279,
1935 inclusive. Value -
1 indicates an error adding the interface.
1939 <column name=
"ofport_request"
1940 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65279}'
>
1942 Requested OpenFlow port number for this interface.
1946 A client should ideally set this column's value in the same
1947 database transaction that it uses to create the interface. Open
1948 vSwitch version
2.1 and later will honor a later request for a
1949 specific port number, althuogh it might confuse some controllers:
1950 OpenFlow does not have a way to announce a port number change, so
1951 Open vSwitch represents it over OpenFlow as a port deletion
1952 followed immediately by a port addition.
1956 If
<ref column=
"ofport_request"/> is set or changed to some other
1957 port's automatically assigned port number, Open vSwitch chooses a
1958 new port number for the latter port.
1964 <group title=
"System-Specific Details">
1965 <column name=
"type">
1967 The interface type. The types supported by a particular instance of
1968 Open vSwitch are listed in the
<ref table=
"Open_vSwitch"
1969 column=
"iface_types"/> column in the
<ref table=
"Open_vSwitch"/>
1970 table. The following types are defined:
1974 <dt><code>system
</code></dt>
1975 <dd>An ordinary network device, e.g.
<code>eth0
</code> on Linux.
1976 Sometimes referred to as ``external interfaces'' since they are
1977 generally connected to hardware external to that on which the Open
1978 vSwitch is running. The empty string is a synonym for
1979 <code>system
</code>.
</dd>
1981 <dt><code>internal
</code></dt>
1982 <dd>A simulated network device that sends and receives traffic. An
1983 internal interface whose
<ref column=
"name"/> is the same as its
1984 bridge's
<ref table=
"Open_vSwitch" column=
"name"/> is called the
1985 ``local interface.'' It does not make sense to bond an internal
1986 interface, so the terms ``port'' and ``interface'' are often used
1987 imprecisely for internal interfaces.
</dd>
1989 <dt><code>tap
</code></dt>
1990 <dd>A TUN/TAP device managed by Open vSwitch.
</dd>
1992 <dt><code>geneve
</code></dt>
1994 An Ethernet over Geneve (
<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve
</code>)
1997 A description of how to match and set Geneve options can be found
1998 in the
<code>ovs-ofctl
</code> manual page.
2001 <dt><code>gre
</code></dt>
2003 An Ethernet over RFC
2890 Generic Routing Encapsulation over IPv4/IPv6
2007 <dt><code>ipsec_gre
</code></dt>
2009 An Ethernet over RFC
2890 Generic Routing Encapsulation over IPv4/IPv6
2011 IPsec tunnel ports are deprecated. The support will be completely
2012 removed in next version.
2016 <dt><code>vxlan
</code></dt>
2019 An Ethernet tunnel over the UDP-based VXLAN protocol described in
2023 Open vSwitch uses IANA-assigned UDP destination port
4789. The
2024 source port used for VXLAN traffic varies on a per-flow basis
2025 and is in the ephemeral port range.
2029 <dt><code>lisp
</code></dt>
2032 A layer
3 tunnel over the experimental, UDP-based Locator/ID
2033 Separation Protocol (RFC
6830).
2036 Only IPv4 and IPv6 packets are supported by the protocol, and
2037 they are sent and received without an Ethernet header. Traffic
2038 to/from LISP ports is expected to be configured explicitly, and
2039 the ports are not intended to participate in learning based
2040 switching. As such, they are always excluded from packet
2045 <dt><code>stt
</code></dt>
2047 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
2048 endpoints are in end-systems, as it utilizes the capabilities of
2049 standard network interface cards to improve performance. STT utilizes
2050 a TCP-like header inside the IP header. It is stateless, i.e., there is
2051 no TCP connection state of any kind associated with the tunnel. The
2052 TCP-like header is used to leverage the capabilities of existing
2053 network interface cards, but should not be interpreted as implying
2054 any sort of connection state between endpoints.
2055 Since the STT protocol does not engage in the usual TCP
3-way handshake,
2056 so it will have difficulty traversing stateful firewalls.
2057 The protocol is documented at
2058 https://tools.ietf.org/html/draft-davie-stt
2060 All traffic uses a default destination port of
7471.
2063 <dt><code>patch
</code></dt>
2065 A pair of virtual devices that act as a patch cable.
2068 <dt><code>null
</code></dt>
2069 <dd>An ignored interface. Deprecated and slated for removal in
2075 <group title=
"Tunnel Options">
2077 These options apply to interfaces with
<ref column=
"type"/> of
2078 <code>geneve
</code>,
<code>gre
</code>,
<code>ipsec_gre
</code>,
2079 <code>vxlan
</code>,
<code>lisp
</code> and
<code>stt
</code>.
2083 Each tunnel must be uniquely identified by the combination of
<ref
2084 column=
"type"/>,
<ref column=
"options" key=
"remote_ip"/>,
<ref
2085 column=
"options" key=
"local_ip"/>, and
<ref column=
"options"
2086 key=
"in_key"/>. If two ports are defined that are the same except one
2087 has an optional identifier and the other does not, the more specific
2088 one is matched first.
<ref column=
"options" key=
"in_key"/> is
2089 considered more specific than
<ref column=
"options" key=
"local_ip"/> if
2090 a port defines one and another port defines the other.
2093 <column name=
"options" key=
"remote_ip">
2094 <p>Required. The remote tunnel endpoint, one of:
</p>
2098 An IPv4 or IPv6 address (not a DNS name), e.g.
<code>192.168.0.123</code>.
2099 Only unicast endpoints are supported.
2102 The word
<code>flow
</code>. The tunnel accepts packets from any
2103 remote tunnel endpoint. To process only packets from a specific
2104 remote tunnel endpoint, the flow entries may match on the
2105 <code>tun_src
</code> or
<code>tun_ipv6_src
</code>field. When
2106 sending packets to a
<code>remote_ip=flow
</code> tunnel, the flow
2107 actions must explicitly set the
<code>tun_dst
</code> or
2108 <code>tun_ipv6_dst
</code> field to the IP address of the desired
2109 remote tunnel endpoint, e.g. with a
<code>set_field
</code> action.
2114 The remote tunnel endpoint for any packet received from a tunnel
2115 is available in the
<code>tun_src
</code> field for matching in the
2120 <column name=
"options" key=
"local_ip">
2122 Optional. The tunnel destination IP that received packets must
2123 match. Default is to match all addresses. If specified, may be one
2129 An IPv4/IPv6 address (not a DNS name), e.g.
<code>192.168.12.3</code>.
2132 The word
<code>flow
</code>. The tunnel accepts packets sent to any
2133 of the local IP addresses of the system running OVS. To process
2134 only packets sent to a specific IP address, the flow entries may
2135 match on the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code> field.
2136 When sending packets to a
<code>local_ip=flow
</code> tunnel, the flow
2137 actions may explicitly set the
<code>tun_src
</code> or
<code>tun_ipv6_src
</code>
2138 field to the desired IP address, e.g. with a
<code>set_field
</code> action.
2139 However, while routing the tunneled packet out, the local system may
2140 override the specified address with the local IP address configured for the
2141 outgoing system interface.
2144 This option is valid only for tunnels also configured with the
2145 <code>remote_ip=flow
</code> option.
2151 The tunnel destination IP address for any packet received from a
2152 tunnel is available in the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code>
2153 field for matching in the flow table.
2157 <column name=
"options" key=
"in_key">
2158 <p>Optional. The key that received packets must contain, one of:
</p>
2162 <code>0</code>. The tunnel receives packets with no key or with a
2163 key of
0. This is equivalent to specifying no
<ref column=
"options"
2164 key=
"in_key"/> at all.
2167 A positive
24-bit (for Geneve, VXLAN, and LISP),
32-bit (for GRE)
2168 or
64-bit (for STT) number. The tunnel receives only
2169 packets with the specified key.
2172 The word
<code>flow
</code>. The tunnel accepts packets with any
2173 key. The key will be placed in the
<code>tun_id
</code> field for
2174 matching in the flow table. The
<code>ovs-ofctl
</code> manual page
2175 contains additional information about matching fields in OpenFlow
2184 <column name=
"options" key=
"out_key">
2185 <p>Optional. The key to be set on outgoing packets, one of:
</p>
2189 <code>0</code>. Packets sent through the tunnel will have no key.
2190 This is equivalent to specifying no
<ref column=
"options"
2191 key=
"out_key"/> at all.
2194 A positive
24-bit (for Geneve, VXLAN and LISP),
32-bit (for GRE) or
2195 64-bit (for STT) number. Packets sent through the tunnel
2196 will have the specified key.
2199 The word
<code>flow
</code>. Packets sent through the tunnel will
2200 have the key set using the
<code>set_tunnel
</code> Nicira OpenFlow
2201 vendor extension (
0 is used in the absence of an action). The
2202 <code>ovs-ofctl
</code> manual page contains additional information
2203 about the Nicira OpenFlow vendor extensions.
2208 <column name=
"options" key=
"key">
2209 Optional. Shorthand to set
<code>in_key
</code> and
2210 <code>out_key
</code> at the same time.
2213 <column name=
"options" key=
"tos">
2214 Optional. The value of the ToS bits to be set on the encapsulating
2215 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2216 zero. It may also be the word
<code>inherit
</code>, in which case
2217 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2218 (otherwise it will be
0). The ECN fields are always inherited.
2222 <column name=
"options" key=
"ttl">
2223 Optional. The TTL to be set on the encapsulating packet. It may also
2224 be the word
<code>inherit
</code>, in which case the TTL will be copied
2225 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2226 system default, typically
64). Default is the system default TTL.
2229 <column name=
"options" key=
"df_default"
2230 type='{
"type":
"boolean"}'
>
2231 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2232 outer headers to allow path MTU discovery. Default is enabled; set
2233 to
<code>false
</code> to disable.
2236 <group title=
"Tunnel Options: vxlan only">
2238 <column name=
"options" key=
"exts">
2239 <p>Optional. Comma separated list of optional VXLAN extensions to
2240 enable. The following extensions are supported:
</p>
2244 <code>gbp
</code>: VXLAN-GBP allows to transport the group policy
2245 context of a packet across the VXLAN tunnel to other network
2246 peers. See the field description of
<code>tun_gbp_id
</code> and
2247 <code>tun_gbp_flags
</code> in ovs-ofctl(
8) for additional
2249 (
<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy
</code>)
2256 <group title=
"Tunnel Options: gre, ipsec_gre, geneve, and vxlan">
2258 <code>gre
</code>,
<code>ipsec_gre
</code>,
<code>geneve
</code>, and
2259 <code>vxlan
</code> interfaces support these options.
2262 <column name=
"options" key=
"csum" type='{
"type":
"boolean"}'
>
2264 Optional. Compute encapsulation header (either GRE or UDP)
2265 checksums on outgoing packets. Default is disabled, set to
2266 <code>true
</code> to enable. Checksums present on incoming
2267 packets will be validated regardless of this setting.
2271 When using the upstream Linux kernel module, computation of
2272 checksums for
<code>geneve
</code> and
<code>vxlan
</code> requires
2273 Linux kernel version
4.0 or higher.
<code>gre
</code> supports
2274 checksums for all versions of Open vSwitch that support GRE.
2275 The out of tree kernel module distributed as part of OVS
2276 can compute all tunnel checksums on any kernel version that it
2281 This option is supported for
<code>ipsec_gre
</code>, but not useful
2282 because GRE checksums are weaker than, and redundant with, IPsec
2283 payload authentication.
2288 <group title=
"Tunnel Options: ipsec_gre only">
2290 Only
<code>ipsec_gre
</code> interfaces support these options.
2293 <column name=
"options" key=
"peer_cert">
2294 Required for certificate authentication. A string containing the
2295 peer's certificate in PEM format. Additionally the host's
2296 certificate must be specified with the
<code>certificate
</code>
2300 <column name=
"options" key=
"certificate">
2301 Required for certificate authentication. The name of a PEM file
2302 containing a certificate that will be presented to the peer during
2306 <column name=
"options" key=
"private_key">
2307 Optional for certificate authentication. The name of a PEM file
2308 containing the private key associated with
<code>certificate
</code>.
2309 If
<code>certificate
</code> contains the private key, this option may
2313 <column name=
"options" key=
"psk">
2314 Required for pre-shared key authentication. Specifies a pre-shared
2315 key for authentication that must be identical on both sides of the
2321 <group title=
"Patch Options">
2323 Only
<code>patch
</code> interfaces support these options.
2326 <column name=
"options" key=
"peer">
2327 The
<ref column=
"name"/> of the
<ref table=
"Interface"/> for the other
2328 side of the patch. The named
<ref table=
"Interface"/>'s own
2329 <code>peer
</code> option must specify this
<ref table=
"Interface"/>'s
2330 name. That is, the two patch interfaces must have reversed
<ref
2331 column=
"name"/> and
<code>peer
</code> values.
2335 <group title=
"PMD (Poll Mode Driver) Options">
2337 Only PMD netdevs support these options.
2340 <column name=
"options" key=
"n_rxq"
2341 type='{
"type":
"integer",
"minInteger":
1}'
>
2343 Specifies the maximum number of rx queues to be created for PMD
2344 netdev. If not specified or specified to
0, one rx queue will
2345 be created by default.
2346 Not supported by DPDK vHost interfaces.
2350 <column name=
"other_config" key=
"pmd-rxq-affinity">
2351 <p>Specifies mapping of RX queues of this interface to CPU cores.
</p>
2352 <p>Value should be set in the following form:
</p>
2354 <code>other_config:pmd-rxq-affinity=
<rxq-affinity-list
></code>
2360 <rxq-affinity-list
> ::= NULL |
<non-empty-list
>
2363 <non-empty-list
> ::=
<affinity-pair
> |
2364 <affinity-pair
> ,
<non-empty-list
>
2367 <affinity-pair
> ::=
<queue-id
> :
<core-id
>
2373 <column name=
"options" key=
"vhost-server-path"
2374 type='{
"type":
"string"}'
>
2376 The value specifies the path to the socket associated with a vHost
2377 User client mode device that has been or will be created by QEMU.
2378 Only supported by dpdkvhostuserclient interfaces.
2385 The MTU (maximum transmission unit) is the largest amount of data
2386 that can fit into a single Ethernet frame. The standard Ethernet
2387 MTU is
1500 bytes. Some physical media and many kinds of virtual
2388 interfaces can be configured with higher MTUs.
2392 A client may change an interface MTU by filling in
2393 <ref column=
"mtu_request"/>. Open vSwitch then reports in
2394 <ref column=
"mtu"/> the currently configured value.
2399 The currently configured MTU for the interface.
2403 This column will be empty for an interface that does not
2404 have an MTU as, for example, some kinds of tunnels do not.
2408 Open vSwitch sets this column's value, so other clients should treat
2413 <column name=
"mtu_request"
2414 type='{
"type":
"integer",
"minInteger":
1}'
>
2416 Requested MTU (Maximum Transmission Unit) for the interface. A client
2417 can fill this column to change the MTU of an interface.
2421 If this is not set and if the interface has
<code>internal
</code>
2422 type, Open vSwitch will change the MTU to match the minimum of the
2423 other interfaces in the bridge.
2429 <group title=
"Interface Status">
2431 Status information about interfaces attached to bridges, updated every
2432 5 seconds. Not all interfaces have all of these properties; virtual
2433 interfaces don't have a link speed, for example. Non-applicable
2434 columns will have empty values.
2436 <column name=
"admin_state">
2438 The administrative state of the physical network link.
2442 <column name=
"link_state">
2444 The observed state of the physical network link. This is ordinarily
2445 the link's carrier status. If the interface's
<ref table=
"Port"/> is
2446 a bond configured for miimon monitoring, it is instead the network
2447 link's miimon status.
2451 <column name=
"link_resets">
2453 The number of times Open vSwitch has observed the
2454 <ref column=
"link_state"/> of this
<ref table=
"Interface"/> change.
2458 <column name=
"link_speed">
2460 The negotiated speed of the physical network link.
2461 Valid values are positive integers greater than
0.
2465 <column name=
"duplex">
2467 The duplex mode of the physical network link.
2471 <column name=
"lacp_current">
2472 Boolean value indicating LACP status for this interface. If true, this
2473 interface has current LACP information about its LACP partner. This
2474 information may be used to monitor the health of interfaces in a LACP
2475 enabled port. This column will be empty if LACP is not enabled.
2478 <column name=
"status">
2479 Key-value pairs that report port status. Supported status values are
2480 <ref column=
"type"/>-dependent; some interfaces may not have a valid
2481 <ref column=
"status" key=
"driver_name"/>, for example.
2484 <column name=
"status" key=
"driver_name">
2485 The name of the device driver controlling the network adapter.
2488 <column name=
"status" key=
"driver_version">
2489 The version string of the device driver controlling the network
2493 <column name=
"status" key=
"firmware_version">
2494 The version string of the network adapter's firmware, if available.
2497 <column name=
"status" key=
"source_ip">
2498 The source IP address used for an IPv4/IPv6 tunnel end-point, such as
2502 <column name=
"status" key=
"tunnel_egress_iface">
2503 Egress interface for tunnels. Currently only relevant for tunnels
2504 on Linux systems, this column will show the name of the interface
2505 which is responsible for routing traffic destined for the configured
2506 <ref column=
"options" key=
"remote_ip"/>. This could be an internal
2507 interface such as a bridge port.
2510 <column name=
"status" key=
"tunnel_egress_iface_carrier"
2511 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
2512 Whether carrier is detected on
<ref column=
"status"
2513 key=
"tunnel_egress_iface"/>.
2517 <group title=
"Statistics">
2519 Key-value pairs that report interface statistics. The current
2520 implementation updates these counters periodically. The update period
2521 is controlled by
<ref column=
"other_config"
2522 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
2523 Future implementations may update them when an interface is created,
2524 when they are queried (e.g. using an OVSDB
<code>select
</code>
2525 operation), and just before an interface is deleted due to virtual
2526 interface hot-unplug or VM shutdown, and perhaps at other times, but
2527 not on any regular periodic basis.
2530 These are the same statistics reported by OpenFlow in its
<code>struct
2531 ofp_port_stats
</code> structure. If an interface does not support a
2532 given statistic, then that pair is omitted.
2534 <group title=
"Statistics: Successful transmit and receive counters">
2535 <column name=
"statistics" key=
"rx_packets">
2536 Number of received packets.
2538 <column name=
"statistics" key=
"rx_bytes">
2539 Number of received bytes.
2541 <column name=
"statistics" key=
"tx_packets">
2542 Number of transmitted packets.
2544 <column name=
"statistics" key=
"tx_bytes">
2545 Number of transmitted bytes.
2548 <group title=
"Statistics: Receive errors">
2549 <column name=
"statistics" key=
"rx_dropped">
2550 Number of packets dropped by RX.
2552 <column name=
"statistics" key=
"rx_frame_err">
2553 Number of frame alignment errors.
2555 <column name=
"statistics" key=
"rx_over_err">
2556 Number of packets with RX overrun.
2558 <column name=
"statistics" key=
"rx_crc_err">
2559 Number of CRC errors.
2561 <column name=
"statistics" key=
"rx_errors">
2562 Total number of receive errors, greater than or equal to the sum of
2566 <group title=
"Statistics: Transmit errors">
2567 <column name=
"statistics" key=
"tx_dropped">
2568 Number of packets dropped by TX.
2570 <column name=
"statistics" key=
"collisions">
2571 Number of collisions.
2573 <column name=
"statistics" key=
"tx_errors">
2574 Total number of transmit errors, greater than or equal to the sum of
2580 <group title=
"Ingress Policing">
2582 These settings control ingress policing for packets received on this
2583 interface. On a physical interface, this limits the rate at which
2584 traffic is allowed into the system from the outside; on a virtual
2585 interface (one connected to a virtual machine), this limits the rate at
2586 which the VM is able to transmit.
2589 Policing is a simple form of quality-of-service that simply drops
2590 packets received in excess of the configured rate. Due to its
2591 simplicity, policing is usually less accurate and less effective than
2592 egress QoS (which is configured using the
<ref table=
"QoS"/> and
<ref
2593 table=
"Queue"/> tables).
2596 Policing is currently implemented on Linux and OVS with DPDK. Both
2597 implementations use a simple ``token bucket'' approach:
2601 The size of the bucket corresponds to
<ref
2602 column=
"ingress_policing_burst"/>. Initially the bucket is full.
2605 Whenever a packet is received, its size (converted to tokens) is
2606 compared to the number of tokens currently in the bucket. If the
2607 required number of tokens are available, they are removed and the
2608 packet is forwarded. Otherwise, the packet is dropped.
2611 Whenever it is not full, the bucket is refilled with tokens at the
2612 rate specified by
<ref column=
"ingress_policing_rate"/>.
2616 Policing interacts badly with some network protocols, and especially
2617 with fragmented IP packets. Suppose that there is enough network
2618 activity to keep the bucket nearly empty all the time. Then this token
2619 bucket algorithm will forward a single packet every so often, with the
2620 period depending on packet size and on the configured rate. All of the
2621 fragments of an IP packets are normally transmitted back-to-back, as a
2622 group. In such a situation, therefore, only one of these fragments
2623 will be forwarded and the rest will be dropped. IP does not provide
2624 any way for the intended recipient to ask for only the remaining
2625 fragments. In such a case there are two likely possibilities for what
2626 will happen next: either all of the fragments will eventually be
2627 retransmitted (as TCP will do), in which case the same problem will
2628 recur, or the sender will not realize that its packet has been dropped
2629 and data will simply be lost (as some UDP-based protocols will do).
2630 Either way, it is possible that no forward progress will ever occur.
2632 <column name=
"ingress_policing_rate">
2634 Maximum rate for data received on this interface, in kbps. Data
2635 received faster than this rate is dropped. Set to
<code>0</code>
2636 (the default) to disable policing.
2640 <column name=
"ingress_policing_burst">
2641 <p>Maximum burst size for data received on this interface, in kb. The
2642 default burst size if set to
<code>0</code> is
8000 kbit. This value
2643 has no effect if
<ref column=
"ingress_policing_rate"/>
2644 is
<code>0</code>.
</p>
2646 Specifying a larger burst size lets the algorithm be more forgiving,
2647 which is important for protocols like TCP that react severely to
2648 dropped packets. The burst size should be at least the size of the
2649 interface's MTU. Specifying a value that is numerically at least as
2650 large as
80% of
<ref column=
"ingress_policing_rate"/> helps TCP come
2651 closer to achieving the full rate.
2656 <group title=
"Bidirectional Forwarding Detection (BFD)">
2658 BFD, defined in RFC
5880 and RFC
5881, allows point-to-point
2659 detection of connectivity failures by occasional transmission of
2660 BFD control messages. Open vSwitch implements BFD to serve
2661 as a more popular and standards compliant alternative to CFM.
2665 BFD operates by regularly transmitting BFD control messages at a rate
2666 negotiated independently in each direction. Each endpoint specifies
2667 the rate at which it expects to receive control messages, and the rate
2668 at which it is willing to transmit them. Open vSwitch uses a detection
2669 multiplier of three, meaning that an endpoint signals a connectivity
2670 fault if three consecutive BFD control messages fail to arrive. In the
2671 case of a unidirectional connectivity issue, the system not receiving
2672 BFD control messages signals the problem to its peer in the messages it
2677 The Open vSwitch implementation of BFD aims to comply faithfully
2678 with RFC
5880 requirements. Open vSwitch does not implement the
2679 optional Authentication or ``Echo Mode'' features.
2682 <group title=
"BFD Configuration">
2684 A controller sets up key-value pairs in the
<ref column=
"bfd"/>
2685 column to enable and configure BFD.
2688 <column name=
"bfd" key=
"enable" type='{
"type":
"boolean"}'
>
2689 True to enable BFD on this
<ref table=
"Interface"/>. If not
2690 specified, BFD will not be enabled by default.
2693 <column name=
"bfd" key=
"min_rx"
2694 type='{
"type":
"integer",
"minInteger":
1}'
>
2695 The shortest interval, in milliseconds, at which this BFD session
2696 offers to receive BFD control messages. The remote endpoint may
2697 choose to send messages at a slower rate. Defaults to
2701 <column name=
"bfd" key=
"min_tx"
2702 type='{
"type":
"integer",
"minInteger":
1}'
>
2703 The shortest interval, in milliseconds, at which this BFD session is
2704 willing to transmit BFD control messages. Messages will actually be
2705 transmitted at a slower rate if the remote endpoint is not willing to
2706 receive as quickly as specified. Defaults to
<code>100</code>.
2709 <column name=
"bfd" key=
"decay_min_rx" type='{
"type":
"integer"}'
>
2710 An alternate receive interval, in milliseconds, that must be greater
2711 than or equal to
<ref column=
"bfd" key=
"min_rx"/>. The
2712 implementation switches from
<ref column=
"bfd" key=
"min_rx"/> to
<ref
2713 column=
"bfd" key=
"decay_min_rx"/> when there is no obvious incoming
2714 data traffic at the interface, to reduce the CPU and bandwidth cost
2715 of monitoring an idle interface. This feature may be disabled by
2716 setting a value of
0. This feature is reset whenever
<ref
2717 column=
"bfd" key=
"decay_min_rx"/> or
<ref column=
"bfd" key=
"min_rx"/>
2721 <column name=
"bfd" key=
"forwarding_if_rx" type='{
"type":
"boolean"}'
>
2722 When
<code>true
</code>, traffic received on the
2723 <ref table=
"Interface"/> is used to indicate the capability of packet
2724 I/O. BFD control packets are still transmitted and received. At
2725 least one BFD control packet must be received every
100 *
<ref
2726 column=
"bfd" key=
"min_rx"/> amount of time. Otherwise, even if
2727 traffic are received, the
<ref column=
"bfd" key=
"forwarding"/>
2728 will be
<code>false
</code>.
2731 <column name=
"bfd" key=
"cpath_down" type='{
"type":
"boolean"}'
>
2732 Set to true to notify the remote endpoint that traffic should not be
2733 forwarded to this system for some reason other than a connectivty
2734 failure on the interface being monitored. The typical underlying
2735 reason is ``concatenated path down,'' that is, that connectivity
2736 beyond the local system is down. Defaults to false.
2739 <column name=
"bfd" key=
"check_tnl_key" type='{
"type":
"boolean"}'
>
2740 Set to true to make BFD accept only control messages with a tunnel
2741 key of zero. By default, BFD accepts control messages with any
2745 <column name=
"bfd" key=
"bfd_local_src_mac">
2746 Set to an Ethernet address in the form
2747 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2748 to set the MAC used as source for transmitted BFD packets. The
2749 default is the mac address of the BFD enabled interface.
2752 <column name=
"bfd" key=
"bfd_local_dst_mac">
2753 Set to an Ethernet address in the form
2754 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2755 to set the MAC used as destination for transmitted BFD packets. The
2756 default is
<code>00:
23:
20:
00:
00:
01</code>.
2759 <column name=
"bfd" key=
"bfd_remote_dst_mac">
2760 Set to an Ethernet address in the form
2761 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2762 to set the MAC used for checking the destination of received BFD packets.
2763 Packets with different destination MAC will not be considered as BFD packets.
2764 If not specified the destination MAC address of received BFD packets
2768 <column name=
"bfd" key=
"bfd_src_ip">
2769 Set to an IPv4 address to set the IP address used as source for
2770 transmitted BFD packets. The default is
<code>169.254.1.1</code>.
2773 <column name=
"bfd" key=
"bfd_dst_ip">
2774 Set to an IPv4 address to set the IP address used as destination
2775 for transmitted BFD packets. The default is
<code>169.254.1.0</code>.
2778 <column name=
"bfd" key=
"oam">
2779 Some tunnel protocols (such as Geneve) include a bit in the header
2780 to indicate that the encapsulated packet is an OAM frame. By setting
2781 this to true, BFD packets will be marked as OAM if encapsulated in
2782 one of these tunnels.
2786 <group title=
"BFD Status">
2788 The switch sets key-value pairs in the
<ref column=
"bfd_status"/>
2789 column to report the status of BFD on this interface. When BFD is
2790 not enabled, with
<ref column=
"bfd" key=
"enable"/>, the switch clears
2791 all key-value pairs from
<ref column=
"bfd_status"/>.
2794 <column name=
"bfd_status" key=
"state"
2795 type='{
"type":
"string",
2796 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
2797 Reports the state of the BFD session. The BFD session is fully
2798 healthy and negotiated if
<code>UP
</code>.
2801 <column name=
"bfd_status" key=
"forwarding" type='{
"type":
"boolean"}'
>
2802 Reports whether the BFD session believes this
<ref
2803 table=
"Interface"/> may be used to forward traffic. Typically this
2804 means the local session is signaling
<code>UP
</code>, and the remote
2805 system isn't signaling a problem such as concatenated path down.
2808 <column name=
"bfd_status" key=
"diagnostic">
2809 A diagnostic code specifying the local system's reason for the
2810 last change in session state. The error messages are defined in
2811 section
4.1 of [RFC
5880].
2814 <column name=
"bfd_status" key=
"remote_state"
2815 type='{
"type":
"string",
2816 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
2817 Reports the state of the remote endpoint's BFD session.
2820 <column name=
"bfd_status" key=
"remote_diagnostic">
2821 A diagnostic code specifying the remote system's reason for the
2822 last change in session state. The error messages are defined in
2823 section
4.1 of [RFC
5880].
2826 <column name=
"bfd_status" key=
"flap_count"
2827 type='{
"type":
"integer",
"minInteger":
0}'
>
2828 Counts the number of
<ref column=
"bfd_status" key=
"forwarding" />
2829 flaps since start. A flap is considered as a change of the
2830 <ref column=
"bfd_status" key=
"forwarding" /> value.
2835 <group title=
"Connectivity Fault Management">
2837 802.1ag Connectivity Fault Management (CFM) allows a group of
2838 Maintenance Points (MPs) called a Maintenance Association (MA) to
2839 detect connectivity problems with each other. MPs within a MA should
2840 have complete and exclusive interconnectivity. This is verified by
2841 occasionally broadcasting Continuity Check Messages (CCMs) at a
2842 configurable transmission interval.
2846 According to the
802.1ag specification, each Maintenance Point should
2847 be configured out-of-band with a list of Remote Maintenance Points it
2848 should have connectivity to. Open vSwitch differs from the
2849 specification in this area. It simply assumes the link is faulted if
2850 no Remote Maintenance Points are reachable, and considers it not
2855 When operating over tunnels which have no
<code>in_key
</code>, or an
2856 <code>in_key
</code> of
<code>flow
</code>. CFM will only accept CCMs
2857 with a tunnel key of zero.
2860 <column name=
"cfm_mpid">
2862 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2863 within a Maintenance Association. The MPID is used to identify this
2864 endpoint to other Maintenance Points in the MA. Each end of a link
2865 being monitored should have a different MPID. Must be configured to
2866 enable CFM on this
<ref table=
"Interface"/>.
2869 According to the
802.1ag specification, MPIDs can only range between
2870 [
1,
8191]. However, extended mode (see
<ref column=
"other_config"
2871 key=
"cfm_extended"/>) supports eight byte MPIDs.
2875 <column name=
"cfm_flap_count">
2876 Counts the number of cfm fault flapps since boot. A flap is
2877 considered to be a change of the
<ref column=
"cfm_fault"/> value.
2880 <column name=
"cfm_fault">
2882 Indicates a connectivity fault triggered by an inability to receive
2883 heartbeats from any remote endpoint. When a fault is triggered on
2884 <ref table=
"Interface"/>s participating in bonds, they will be
2888 Faults can be triggered for several reasons. Most importantly they
2889 are triggered when no CCMs are received for a period of
3.5 times the
2890 transmission interval. Faults are also triggered when any CCMs
2891 indicate that a Remote Maintenance Point is not receiving CCMs but
2892 able to send them. Finally, a fault is triggered if a CCM is
2893 received which indicates unexpected configuration. Notably, this
2894 case arises when a CCM is received which advertises the local MPID.
2898 <column name=
"cfm_fault_status" key=
"recv">
2899 Indicates a CFM fault was triggered due to a lack of CCMs received on
2900 the
<ref table=
"Interface"/>.
2903 <column name=
"cfm_fault_status" key=
"rdi">
2904 Indicates a CFM fault was triggered due to the reception of a CCM with
2905 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2906 are not receiving CCMs themselves. This typically indicates a
2907 unidirectional connectivity failure.
2910 <column name=
"cfm_fault_status" key=
"maid">
2911 Indicates a CFM fault was triggered due to the reception of a CCM with
2912 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2913 with an identification number in addition to the MPID called the MAID.
2914 Open vSwitch only supports receiving CCM broadcasts tagged with the
2915 MAID it uses internally.
2918 <column name=
"cfm_fault_status" key=
"loopback">
2919 Indicates a CFM fault was triggered due to the reception of a CCM
2920 advertising the same MPID configured in the
<ref column=
"cfm_mpid"/>
2921 column of this
<ref table=
"Interface"/>. This may indicate a loop in
2925 <column name=
"cfm_fault_status" key=
"overflow">
2926 Indicates a CFM fault was triggered because the CFM module received
2927 CCMs from more remote endpoints than it can keep track of.
2930 <column name=
"cfm_fault_status" key=
"override">
2931 Indicates a CFM fault was manually triggered by an administrator using
2932 an
<code>ovs-appctl
</code> command.
2935 <column name=
"cfm_fault_status" key=
"interval">
2936 Indicates a CFM fault was triggered due to the reception of a CCM
2937 frame having an invalid interval.
2940 <column name=
"cfm_remote_opstate">
2941 <p>When in extended mode, indicates the operational state of the
2942 remote endpoint as either
<code>up
</code> or
<code>down
</code>. See
2943 <ref column=
"other_config" key=
"cfm_opstate"/>.
2947 <column name=
"cfm_health">
2949 Indicates the health of the interface as a percentage of CCM frames
2950 received over
21 <ref column=
"other_config" key=
"cfm_interval"/>s.
2951 The health of an interface is undefined if it is communicating with
2952 more than one
<ref column=
"cfm_remote_mpids"/>. It reduces if
2953 healthy heartbeats are not received at the expected rate, and
2954 gradually improves as healthy heartbeats are received at the desired
2955 rate. Every
21 <ref column=
"other_config" key=
"cfm_interval"/>s, the
2956 health of the interface is refreshed.
2959 As mentioned above, the faults can be triggered for several reasons.
2960 The link health will deteriorate even if heartbeats are received but
2961 they are reported to be unhealthy. An unhealthy heartbeat in this
2962 context is a heartbeat for which either some fault is set or is out
2963 of sequence. The interface health can be
100 only on receiving
2964 healthy heartbeats at the desired rate.
2968 <column name=
"cfm_remote_mpids">
2969 When CFM is properly configured, Open vSwitch will occasionally
2970 receive CCM broadcasts. These broadcasts contain the MPID of the
2971 sending Maintenance Point. The list of MPIDs from which this
2972 <ref table=
"Interface"/> is receiving broadcasts from is regularly
2973 collected and written to this column.
2976 <column name=
"other_config" key=
"cfm_interval"
2977 type='{
"type":
"integer"}'
>
2979 The interval, in milliseconds, between transmissions of CFM
2980 heartbeats. Three missed heartbeat receptions indicate a
2985 In standard operation only intervals of
3,
10,
100,
1,
000,
10,
000,
2986 60,
000, or
600,
000 ms are supported. Other values will be rounded
2987 down to the nearest value on the list. Extended mode (see
<ref
2988 column=
"other_config" key=
"cfm_extended"/>) supports any interval up
2989 to
65,
535 ms. In either mode, the default is
1000 ms.
2992 <p>We do not recommend using intervals less than
100 ms.
</p>
2995 <column name=
"other_config" key=
"cfm_extended"
2996 type='{
"type":
"boolean"}'
>
2997 When
<code>true
</code>, the CFM module operates in extended mode. This
2998 causes it to use a nonstandard destination address to avoid conflicting
2999 with compliant implementations which may be running concurrently on the
3000 network. Furthermore, extended mode increases the accuracy of the
3001 <code>cfm_interval
</code> configuration parameter by breaking wire
3002 compatibility with
802.1ag compliant implementations. And extended
3003 mode allows eight byte MPIDs. Defaults to
<code>false
</code>.
3006 <column name=
"other_config" key=
"cfm_demand" type='{
"type":
"boolean"}'
>
3008 When
<code>true
</code>, and
3009 <ref column=
"other_config" key=
"cfm_extended"/> is true, the CFM
3010 module operates in demand mode. When in demand mode, traffic
3011 received on the
<ref table=
"Interface"/> is used to indicate
3012 liveness. CCMs are still transmitted and received. At least one
3013 CCM must be received every
100 *
<ref column=
"other_config"
3014 key=
"cfm_interval"/> amount of time. Otherwise, even if traffic
3015 are received, the CFM module will raise the connectivity fault.
3019 Demand mode has a couple of caveats:
3022 To ensure that ovs-vswitchd has enough time to pull statistics
3023 from the datapath, the fault detection interval is set to
3024 3.5 * MAX(
<ref column=
"other_config" key=
"cfm_interval"/>,
500)
3029 To avoid ambiguity, demand mode disables itself when there are
3030 multiple remote maintenance points.
3034 If the
<ref table=
"Interface"/> is heavily congested, CCMs
3035 containing the
<ref column=
"other_config" key=
"cfm_opstate"/>
3036 status may be dropped causing changes in the operational state to
3037 be delayed. Similarly, if CCMs containing the RDI bit are not
3038 received, unidirectional link failures may not be detected.
3044 <column name=
"other_config" key=
"cfm_opstate"
3045 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
3046 When
<code>down
</code>, the CFM module marks all CCMs it generates as
3047 operationally down without triggering a fault. This allows remote
3048 maintenance points to choose not to forward traffic to the
3049 <ref table=
"Interface"/> on which this CFM module is running.
3050 Currently, in Open vSwitch, the opdown bit of CCMs affects
3051 <ref table=
"Interface"/>s participating in bonds, and the bundle
3052 OpenFlow action. This setting is ignored when CFM is not in extended
3053 mode. Defaults to
<code>up
</code>.
3056 <column name=
"other_config" key=
"cfm_ccm_vlan"
3057 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
3058 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3059 with the given value. May be the string
<code>random
</code> in which
3060 case each CCM will be tagged with a different randomly generated VLAN.
3063 <column name=
"other_config" key=
"cfm_ccm_pcp"
3064 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
7}'
>
3065 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3066 with the given PCP value, the VLAN ID of the tag is governed by the
3067 value of
<ref column=
"other_config" key=
"cfm_ccm_vlan"/>. If
3068 <ref column=
"other_config" key=
"cfm_ccm_vlan"/> is unset, a VLAN ID of
3074 <group title=
"Bonding Configuration">
3075 <column name=
"other_config" key=
"lacp-port-id"
3076 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3077 The LACP port ID of this
<ref table=
"Interface"/>. Port IDs are
3078 used in LACP negotiations to identify individual ports
3079 participating in a bond.
3082 <column name=
"other_config" key=
"lacp-port-priority"
3083 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3084 The LACP port priority of this
<ref table=
"Interface"/>. In LACP
3085 negotiations
<ref table=
"Interface"/>s with numerically lower
3086 priorities are preferred for aggregation.
3089 <column name=
"other_config" key=
"lacp-aggregation-key"
3090 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3091 The LACP aggregation key of this
<ref table=
"Interface"/>.
<ref
3092 table=
"Interface"/>s with different aggregation keys may not be active
3093 within a given
<ref table=
"Port"/> at the same time.
3097 <group title=
"Virtual Machine Identifiers">
3099 These key-value pairs specifically apply to an interface that
3100 represents a virtual Ethernet interface connected to a virtual
3101 machine. These key-value pairs should not be present for other types
3102 of interfaces. Keys whose names end in
<code>-uuid
</code> have
3103 values that uniquely identify the entity in question. For a Citrix
3104 XenServer hypervisor, these values are UUIDs in RFC
4122 format.
3105 Other hypervisors may use other formats.
3108 <column name=
"external_ids" key=
"attached-mac">
3109 The MAC address programmed into the ``virtual hardware'' for this
3110 interface, in the form
3111 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
3112 For Citrix XenServer, this is the value of the
<code>MAC
</code> field
3113 in the VIF record for this interface.
3116 <column name=
"external_ids" key=
"iface-id">
3117 A system-unique identifier for the interface. On XenServer, this will
3118 commonly be the same as
<ref column=
"external_ids" key=
"xs-vif-uuid"/>.
3121 <column name=
"external_ids" key=
"iface-status"
3122 type='{
"type":
"string",
3123 "enum": [
"set", [
"active",
"inactive"]]}'
>
3125 Hypervisors may sometimes have more than one interface associated
3126 with a given
<ref column=
"external_ids" key=
"iface-id"/>, only one of
3127 which is actually in use at a given time. For example, in some
3128 circumstances XenServer has both a ``tap'' and a ``vif'' interface
3129 for a single
<ref column=
"external_ids" key=
"iface-id"/>, but only
3130 uses one of them at a time. A hypervisor that behaves this way must
3131 mark the currently in use interface
<code>active
</code> and the
3132 others
<code>inactive
</code>. A hypervisor that never has more than
3133 one interface for a given
<ref column=
"external_ids" key=
"iface-id"/>
3134 may mark that interface
<code>active
</code> or omit
<ref
3135 column=
"external_ids" key=
"iface-status"/> entirely.
3139 During VM migration, a given
<ref column=
"external_ids"
3140 key=
"iface-id"/> might transiently be marked
<code>active
</code> on
3141 two different hypervisors. That is,
<code>active
</code> means that
3142 this
<ref column=
"external_ids" key=
"iface-id"/> is the active
3143 instance within a single hypervisor, not in a broader scope.
3144 There is one exception: some hypervisors support ``migration'' from a
3145 given hypervisor to itself (most often for test purposes). During
3146 such a ``migration,'' two instances of a single
<ref
3147 column=
"external_ids" key=
"iface-id"/> might both be briefly marked
3148 <code>active
</code> on a single hypervisor.
3152 <column name=
"external_ids" key=
"xs-vif-uuid">
3153 The virtual interface associated with this interface.
3156 <column name=
"external_ids" key=
"xs-network-uuid">
3157 The virtual network to which this interface is attached.
3160 <column name=
"external_ids" key=
"vm-id">
3161 The VM to which this interface belongs. On XenServer, this will be the
3162 same as
<ref column=
"external_ids" key=
"xs-vm-uuid"/>.
3165 <column name=
"external_ids" key=
"xs-vm-uuid">
3166 The VM to which this interface belongs.
3170 <group title=
"Auto Attach Configuration">
3172 Auto Attach configuration for a particular interface.
3175 <column name=
"lldp" key=
"enable" type='{
"type":
"boolean"}'
>
3176 True to enable LLDP on this
<ref table=
"Interface"/>. If not
3177 specified, LLDP will be disabled by default.
3181 <group title=
"Flow control Configuration">
3183 Ethernet flow control defined in IEEE
802.1Qbb provides link level flow
3184 control using MAC pause frames. Implemented only for interfaces with
3185 type
<code>dpdk
</code>.
3188 <column name=
"options" key=
"rx-flow-ctrl" type='{
"type":
"boolean"}'
>
3189 Set to
<code>true
</code> to enable Rx flow control on physical ports.
3190 By default, Rx flow control is disabled.
3193 <column name=
"options" key=
"tx-flow-ctrl" type='{
"type":
"boolean"}'
>
3194 Set to
<code>true
</code> to enable Tx flow control on physical ports.
3195 By default, Tx flow control is disabled.
3198 <column name=
"options" key=
"flow-ctrl-autoneg"
3199 type='{
"type":
"boolean"}'
>
3200 Set to
<code>true
</code> to enable flow control auto negotiation on
3201 physical ports. By default, auto-neg is disabled.
3205 <group title=
"Common Columns">
3206 The overall purpose of these columns is described under
<code>Common
3207 Columns
</code> at the beginning of this document.
3209 <column name=
"other_config"/>
3210 <column name=
"external_ids"/>
3214 <table name=
"Flow_Table" title=
"OpenFlow table configuration">
3215 <p>Configuration for a particular OpenFlow table.
</p>
3217 <column name=
"name">
3218 The table's name. Set this column to change the name that controllers
3219 will receive when they request table statistics, e.g.
<code>ovs-ofctl
3220 dump-tables
</code>. The name does not affect switch behavior.
3223 <group title=
"Eviction Policy">
3225 Open vSwitch supports limiting the number of flows that may be
3226 installed in a flow table, via the
<ref column=
"flow_limit"/> column.
3227 When adding a flow would exceed this limit, by default Open vSwitch
3228 reports an error, but there are two ways to configure Open vSwitch to
3229 instead delete (``evict'') a flow to make room for the new one:
3234 Set the
<ref column=
"overflow_policy"/> column to
<code>evict
</code>.
3238 Send an OpenFlow
1.4+ ``table mod request'' to enable eviction for
3239 the flow table (e.g.
<code>ovs-ofctl -O OpenFlow14 mod-table br0
0
3240 evict
</code> to enable eviction on flow table
0 of bridge
3246 When a flow must be evicted due to overflow, the flow to evict is
3247 chosen through an approximation of the following algorithm. This
3248 algorithm is used regardless of how eviction was enabled:
3253 Divide the flows in the table into groups based on the values of the
3254 fields or subfields specified in the
<ref column=
"groups"/> column,
3255 so that all of the flows in a given group have the same values for
3256 those fields. If a flow does not specify a given field, that field's
3257 value is treated as
0. If
<ref column=
"groups"/> is empty, then all
3258 of the flows in the flow table are treated as a single group.
3262 Consider the flows in the largest group, that is, the group that
3263 contains the greatest number of flows. If two or more groups all
3264 have the same largest number of flows, consider the flows in all of
3269 If the flows under consideration have different importance values,
3270 eliminate from consideration any flows except those with the lowest
3271 importance. (``Importance,'' a
16-bit integer value attached to each
3272 flow, was introduced in OpenFlow
1.4. Flows inserted with older
3273 versions of OpenFlow always have an importance of
0.)
3277 Among the flows under consideration, choose the flow that expires
3278 soonest for eviction.
3283 The eviction process only considers flows that have an idle timeout
3284 or a hard timeout. That is, eviction never deletes permanent flows.
3285 (Permanent flows do count against
<ref column=
"flow_limit"/>.)
3288 <column name=
"flow_limit">
3289 If set, limits the number of flows that may be added to the table.
3290 Open vSwitch may limit the number of flows in a table for other
3291 reasons, e.g. due to hardware limitations or for resource availability
3292 or performance reasons.
3295 <column name=
"overflow_policy">
3297 Controls the switch's behavior when an OpenFlow flow table
3298 modification request would add flows in excess of
<ref
3299 column=
"flow_limit"/>. The supported values are:
3303 <dt><code>refuse
</code></dt>
3305 Refuse to add the flow or flows. This is also the default policy
3306 when
<ref column=
"overflow_policy"/> is unset.
3309 <dt><code>evict
</code></dt>
3311 Delete a flow chosen according to the algorithm described above.
3316 <column name=
"groups">
3318 When
<ref column=
"overflow_policy"/> is
<code>evict
</code>, this
3319 controls how flows are chosen for eviction when the flow table would
3320 otherwise exceed
<ref column=
"flow_limit"/> flows. Its value is a
3321 set of NXM fields or sub-fields, each of which takes one of the forms
3322 <code><var>field
</var>[]
</code> or
3323 <code><var>field
</var>[
<var>start
</var>..
<var>end
</var>]
</code>,
3324 e.g.
<code>NXM_OF_IN_PORT[]
</code>. Please see
3325 <code>nicira-ext.h
</code> for a complete list of NXM field names.
3329 Open vSwitch ignores any invalid or unknown field specifications.
3333 When eviction is not enabled, via
<ref column=
"overflow_policy"/> or
3334 an OpenFlow
1.4+ ``table mod,'' this column has no effect.
3339 <group title=
"Classifier Optimization">
3340 <column name=
"prefixes">
3342 This string set specifies which fields should be used for
3343 address prefix tracking. Prefix tracking allows the
3344 classifier to skip rules with longer than necessary prefixes,
3345 resulting in better wildcarding for datapath flows.
3348 Prefix tracking may be beneficial when a flow table contains
3349 matches on IP address fields with different prefix lengths.
3350 For example, when a flow table contains IP address matches on
3351 both full addresses and proper prefixes, the full address
3352 matches will typically cause the datapath flow to un-wildcard
3353 the whole address field (depending on flow entry priorities).
3354 In this case each packet with a different address gets handed
3355 to the userspace for flow processing and generates its own
3356 datapath flow. With prefix tracking enabled for the address
3357 field in question packets with addresses matching shorter
3358 prefixes would generate datapath flows where the irrelevant
3359 address bits are wildcarded, allowing the same datapath flow
3360 to handle all the packets within the prefix in question. In
3361 this case many userspace upcalls can be avoided and the
3362 overall performance can be better.
3365 This is a performance optimization only, so packets will
3366 receive the same treatment with or without prefix tracking.
3369 The supported fields are:
<code>tun_id
</code>,
3370 <code>tun_src
</code>,
<code>tun_dst
</code>,
3371 <code>tun_ipv6_src
</code>,
<code>tun_ipv6_dst
</code>,
3372 <code>nw_src
</code>,
<code>nw_dst
</code> (or aliases
3373 <code>ip_src
</code> and
<code>ip_dst
</code>),
3374 <code>ipv6_src
</code>, and
<code>ipv6_dst
</code>. (Using this
3375 feature for
<code>tun_id
</code> would only make sense if the
3376 tunnel IDs have prefix structure similar to IP addresses.)
3380 By default, the
<code>prefixes=ip_dst,ip_src
</code> are used
3381 on each flow table. This instructs the flow classifier to
3382 track the IP destination and source addresses used by the
3383 rules in this specific flow table.
3387 The keyword
<code>none
</code> is recognized as an explicit
3388 override of the default values, causing no prefix fields to be
3393 To set the prefix fields, the flow table record needs to
3398 <dt><code>ovs-vsctl set Bridge br0 flow_tables:
0=@N1 -- --id=@N1 create Flow_Table name=table0
</code></dt>
3400 Creates a flow table record for the OpenFlow table number
0.
3403 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src
</code></dt>
3405 Enables prefix tracking for IP source and destination
3411 There is a maximum number of fields that can be enabled for any
3412 one flow table. Currently this limit is
3.
3417 <group title=
"Common Columns">
3418 The overall purpose of these columns is described under
<code>Common
3419 Columns
</code> at the beginning of this document.
3421 <column name=
"external_ids"/>
3425 <table name=
"QoS" title=
"Quality of Service configuration">
3426 <p>Quality of Service (QoS) configuration for each Port that
3429 <column name=
"type">
3430 <p>The type of QoS to implement. The currently defined types are
3433 <dt><code>linux-htb
</code></dt>
3435 Linux ``hierarchy token bucket'' classifier. See tc-htb(
8) (also at
3436 <code>http://linux.die.net/man/
8/tc-htb
</code>) and the HTB manual
3437 (
<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm
</code>)
3438 for information on how this classifier works and how to configure it.
3441 <dt><code>linux-hfsc
</code></dt>
3443 Linux
"Hierarchical Fair Service Curve" classifier.
3444 See
<code>http://linux-ip.net/articles/hfsc.en/
</code> for
3445 information on how this classifier works.
3448 <dt><code>linux-sfq
</code></dt>
3450 Linux ``Stochastic Fairness Queueing'' classifier. See
3451 <code>tc-sfq
</code>(
8) (also at
3452 <code>http://linux.die.net/man/
8/tc-sfq
</code>) for information on
3453 how this classifier works.
3456 <dt><code>linux-codel
</code></dt>
3458 Linux ``Controlled Delay'' classifier. See
<code>tc-codel
</code>(
8)
3460 <code>http://man7.org/linux/man-pages/man8/tc-codel
.8.html
</code>)
3461 for information on how this classifier works.
3464 <dt><code>linux-fq_codel
</code></dt>
3466 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3467 <code>tc-fq_codel
</code>(
8) (also at
3468 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel
.8.html
</code>)
3469 for information on how this classifier works.
3472 <dt><code>linux-noop
</code></dt>
3474 Linux ``No operation.'' By default, Open vSwitch manages quality of
3475 service on all of its configured ports. This can be helpful, but
3476 sometimes administrators prefer to use other software to manage QoS.
3477 This
<ref column=
"type"/> prevents Open vSwitch from changing the QoS
3478 configuration for a port.
3481 <dt><code>egress-policer
</code></dt>
3483 A DPDK egress policer algorithm using the DPDK
3484 rte_meter library. The rte_meter library provides an implementation
3485 which allows the metering and policing of traffic. The implementation
3486 in OVS essentially creates a single token bucket used to police
3487 traffic. It should be noted that when the rte_meter is configured as
3488 part of QoS there will be a performance overhead as the rte_meter
3489 itself will consume CPU cycles in order to police traffic. These CPU
3490 cycles ordinarily are used for packet proccessing. As such the drop
3491 in performance will be noticed in terms of overall aggregate traffic
3497 <column name=
"queues">
3498 <p>A map from queue numbers to
<ref table=
"Queue"/> records. The
3499 supported range of queue numbers depend on
<ref column=
"type"/>. The
3500 queue numbers are the same as the
<code>queue_id
</code> used in
3501 OpenFlow in
<code>struct ofp_action_enqueue
</code> and other
3505 Queue
0 is the ``default queue.'' It is used by OpenFlow output
3506 actions when no specific queue has been set. When no configuration for
3507 queue
0 is present, it is automatically configured as if a
<ref
3508 table=
"Queue"/> record with empty
<ref table=
"Queue" column=
"dscp"/>
3509 and
<ref table=
"Queue" column=
"other_config"/> columns had been
3511 (Before version
1.6, Open vSwitch would leave queue
0 unconfigured in
3512 this case. With some queuing disciplines, this dropped all packets
3513 destined for the default queue.)
3517 <group title=
"Configuration for linux-htb and linux-hfsc">
3519 The
<code>linux-htb
</code> and
<code>linux-hfsc
</code> classes support
3520 the following key-value pair:
3523 <column name=
"other_config" key=
"max-rate" type='{
"type":
"integer"}'
>
3524 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3525 specified, for physical interfaces, the default is the link rate. For
3526 other interfaces or if the link rate cannot be determined, the default
3527 is currently
100 Mbps.
3531 <group title=
"Configuration for egress-policer QoS">
3533 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3534 <code>egress-policer
</code> provides egress policing for userspace
3535 port types with DPDK.
3537 It has the following key-value pairs defined.
3540 <column name=
"other_config" key=
"cir" type='{
"type":
"integer"}'
>
3541 The Committed Information Rate (CIR) is measured in bytes of IP
3542 packets per second, i.e. it includes the IP header, but not link
3543 specific (e.g. Ethernet) headers. This represents the bytes per second
3544 rate at which the token bucket will be updated. The cir value is
3545 calculated by (pps x packet data size). For example assuming a user
3546 wishes to limit a stream consisting of
64 byte packets to
1 million
3547 packets per second the CIR would be set to to to
46000000. This value
3548 can be broken into '
1,
000,
000 x
46'. Where
1,
000,
000 is the policing
3549 rate for the number of packets per second and
46 represents the size
3550 of the packet data for a
64 byte ip packet.
3552 <column name=
"other_config" key=
"cbs" type='{
"type":
"integer"}'
>
3553 The Committed Burst Size (CBS) is measured in bytes and represents a
3554 token bucket. At a minimum this value should be be set to the expected
3555 largest size packet in the traffic stream. In practice larger values
3556 may be used to increase the size of the token bucket. If a packet can
3557 be transmitted then the cbs will be decremented by the number of
3558 bytes/tokens of the packet. If there are not enough tokens in the cbs
3559 bucket the packet will be dropped.
3563 <group title=
"Common Columns">
3564 The overall purpose of these columns is described under
<code>Common
3565 Columns
</code> at the beginning of this document.
3567 <column name=
"other_config"/>
3568 <column name=
"external_ids"/>
3572 <table name=
"Queue" title=
"QoS output queue.">
3573 <p>A configuration for a port output queue, used in configuring Quality of
3574 Service (QoS) features. May be referenced by
<ref column=
"queues"
3575 table=
"QoS"/> column in
<ref table=
"QoS"/> table.
</p>
3577 <column name=
"dscp">
3578 If set, Open vSwitch will mark all traffic egressing this
3579 <ref table=
"Queue"/> with the given DSCP bits. Traffic egressing the
3580 default
<ref table=
"Queue"/> is only marked if it was explicitly selected
3581 as the
<ref table=
"Queue"/> at the time the packet was output. If unset,
3582 the DSCP bits of traffic egressing this
<ref table=
"Queue"/> will remain
3586 <group title=
"Configuration for linux-htb QoS">
3588 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3589 <code>linux-htb
</code> may use
<code>queue_id
</code>s less than
61440.
3590 It has the following key-value pairs defined.
3593 <column name=
"other_config" key=
"min-rate"
3594 type='{
"type":
"integer",
"minInteger":
1}'
>
3595 Minimum guaranteed bandwidth, in bit/s.
3598 <column name=
"other_config" key=
"max-rate"
3599 type='{
"type":
"integer",
"minInteger":
1}'
>
3600 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3601 queue's rate will not be allowed to exceed the specified value, even
3602 if excess bandwidth is available. If unspecified, defaults to no
3606 <column name=
"other_config" key=
"burst"
3607 type='{
"type":
"integer",
"minInteger":
1}'
>
3608 Burst size, in bits. This is the maximum amount of ``credits'' that a
3609 queue can accumulate while it is idle. Optional. Details of the
3610 <code>linux-htb
</code> implementation require a minimum burst size, so
3611 a too-small
<code>burst
</code> will be silently ignored.
3614 <column name=
"other_config" key=
"priority"
3615 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
3616 A queue with a smaller
<code>priority
</code> will receive all the
3617 excess bandwidth that it can use before a queue with a larger value
3618 receives any. Specific priority values are unimportant; only relative
3619 ordering matters. Defaults to
0 if unspecified.
3623 <group title=
"Configuration for linux-hfsc QoS">
3625 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3626 <code>linux-hfsc
</code> may use
<code>queue_id
</code>s less than
61440.
3627 It has the following key-value pairs defined.
3630 <column name=
"other_config" key=
"min-rate"
3631 type='{
"type":
"integer",
"minInteger":
1}'
>
3632 Minimum guaranteed bandwidth, in bit/s.
3635 <column name=
"other_config" key=
"max-rate"
3636 type='{
"type":
"integer",
"minInteger":
1}'
>
3637 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3638 queue's rate will not be allowed to exceed the specified value, even if
3639 excess bandwidth is available. If unspecified, defaults to no
3644 <group title=
"Common Columns">
3645 The overall purpose of these columns is described under
<code>Common
3646 Columns
</code> at the beginning of this document.
3648 <column name=
"other_config"/>
3649 <column name=
"external_ids"/>
3653 <table name=
"Mirror" title=
"Port mirroring.">
3654 <p>A port mirror within a
<ref table=
"Bridge"/>.
</p>
3655 <p>A port mirror configures a bridge to send selected frames to special
3656 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3657 traffic may also be referred to as SPAN or RSPAN, depending on how
3658 the mirrored traffic is sent.
</p>
3661 When a packet enters an Open vSwitch bridge, it becomes eligible for
3662 mirroring based on its ingress port and VLAN. As the packet travels
3663 through the flow tables, each time it is output to a port, it becomes
3664 eligible for mirroring based on the egress port and VLAN. In Open
3665 vSwitch
2.5 and later, mirroring occurs just after a packet first becomes
3666 eligible, using the packet as it exists at that point; in Open vSwitch
3667 2.4 and earlier, mirroring occurs only after a packet has traversed all
3668 the flow tables, using the original packet as it entered the bridge.
3669 This makes a difference only when the flow table modifies the packet: in
3670 Open vSwitch
2.4, the modifications are never visible to mirrors, whereas
3671 in Open vSwitch
2.5 and later modifications made before the first output
3672 that makes it eligible for mirroring to a particular destination are
3677 A packet that enters an Open vSwitch bridge is mirrored to a particular
3678 destination only once, even if it is eligible for multiple reasons. For
3679 example, a packet would be mirrored to a particular
<ref
3680 column=
"output_port"/> only once, even if it is selected for mirroring to
3681 that port by
<ref column=
"select_dst_port"/> and
<ref
3682 column=
"select_src_port"/> in the same or different
<ref table=
"Mirror"/>
3686 <column name=
"name">
3687 Arbitrary identifier for the
<ref table=
"Mirror"/>.
3690 <group title=
"Selecting Packets for Mirroring">
3692 To be selected for mirroring, a given packet must enter or leave the
3693 bridge through a selected port and it must also be in one of the
3697 <column name=
"select_all">
3698 If true, every packet arriving or departing on any port is
3699 selected for mirroring.
3702 <column name=
"select_dst_port">
3703 Ports on which departing packets are selected for mirroring.
3706 <column name=
"select_src_port">
3707 Ports on which arriving packets are selected for mirroring.
3710 <column name=
"select_vlan">
3711 VLANs on which packets are selected for mirroring. An empty set
3712 selects packets on all VLANs.
3716 <group title=
"Mirroring Destination Configuration">
3718 These columns are mutually exclusive. Exactly one of them must be
3722 <column name=
"output_port">
3723 <p>Output port for selected packets, if nonempty.
</p>
3724 <p>Specifying a port for mirror output reserves that port exclusively
3725 for mirroring. No frames other than those selected for mirroring
3727 will be forwarded to the port, and any frames received on the port
3728 will be discarded.
</p>
3730 The output port may be any kind of port supported by Open vSwitch.
3731 It may be, for example, a physical port (sometimes called SPAN) or a
3736 <column name=
"output_vlan">
3737 <p>Output VLAN for selected packets, if nonempty.
</p>
3738 <p>The frames will be sent out all ports that trunk
3739 <ref column=
"output_vlan"/>, as well as any ports with implicit VLAN
3740 <ref column=
"output_vlan"/>. When a mirrored frame is sent out a
3741 trunk port, the frame's VLAN tag will be set to
3742 <ref column=
"output_vlan"/>, replacing any existing tag; when it is
3743 sent out an implicit VLAN port, the frame will not be tagged. This
3744 type of mirroring is sometimes called RSPAN.
</p>
3746 See the documentation for
3747 <ref column=
"other_config" key=
"forward-bpdu"/> in the
3748 <ref table=
"Interface"/> table for a list of destination MAC
3749 addresses which will not be mirrored to a VLAN to avoid confusing
3750 switches that interpret the protocols that they represent.
3752 <p><em>Please note:
</em> Mirroring to a VLAN can disrupt a network that
3753 contains unmanaged switches. Consider an unmanaged physical switch
3754 with two ports: port
1, connected to an end host, and port
2,
3755 connected to an Open vSwitch configured to mirror received packets
3756 into VLAN
123 on port
2. Suppose that the end host sends a packet on
3757 port
1 that the physical switch forwards to port
2. The Open vSwitch
3758 forwards this packet to its destination and then reflects it back on
3759 port
2 in VLAN
123. This reflected packet causes the unmanaged
3760 physical switch to replace the MAC learning table entry, which
3761 correctly pointed to port
1, with one that incorrectly points to port
3762 2. Afterward, the physical switch will direct packets destined for
3763 the end host to the Open vSwitch on port
2, instead of to the end
3764 host on port
1, disrupting connectivity. If mirroring to a VLAN is
3765 desired in this scenario, then the physical switch must be replaced
3766 by one that learns Ethernet addresses on a per-VLAN basis. In
3767 addition, learning should be disabled on the VLAN containing mirrored
3768 traffic. If this is not done then intermediate switches will learn
3769 the MAC address of each end host from the mirrored traffic. If
3770 packets being sent to that end host are also mirrored, then they will
3771 be dropped since the switch will attempt to send them out the input
3772 port. Disabling learning for the VLAN will cause the switch to
3773 correctly send the packet out all ports configured for that VLAN. If
3774 Open vSwitch is being used as an intermediate switch, learning can be
3775 disabled by adding the mirrored VLAN to
<ref column=
"flood_vlans"/>
3776 in the appropriate
<ref table=
"Bridge"/> table or tables.
</p>
3778 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3779 VLAN and should generally be preferred.
3783 <column name=
"snaplen">
3784 <p>Maximum per-packet number of bytes to mirror.
</p>
3785 <p>A mirrored packet with size larger than
<ref column=
"snaplen"/>
3786 will be truncated in datapath to
<ref column=
"snaplen"/> bytes
3787 before sending to the mirror output port. If omitted, packets
3793 <group title=
"Statistics: Mirror counters">
3795 Key-value pairs that report mirror statistics. The update period
3796 is controlled by
<ref column=
"other_config"
3797 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
3799 <column name=
"statistics" key=
"tx_packets">
3800 Number of packets transmitted through this mirror.
3802 <column name=
"statistics" key=
"tx_bytes">
3803 Number of bytes transmitted through this mirror.
3807 <group title=
"Common Columns">
3808 The overall purpose of these columns is described under
<code>Common
3809 Columns
</code> at the beginning of this document.
3811 <column name=
"external_ids"/>
3815 <table name=
"Controller" title=
"OpenFlow controller configuration.">
3816 <p>An OpenFlow controller.
</p>
3819 Open vSwitch supports two kinds of OpenFlow controllers:
3823 <dt>Primary controllers
</dt>
3826 This is the kind of controller envisioned by the OpenFlow
1.0
3827 specification. Usually, a primary controller implements a network
3828 policy by taking charge of the switch's flow table.
3832 Open vSwitch initiates and maintains persistent connections to
3833 primary controllers, retrying the connection each time it fails or
3834 drops. The
<ref table=
"Bridge" column=
"fail_mode"/> column in the
3835 <ref table=
"Bridge"/> table applies to primary controllers.
3839 Open vSwitch permits a bridge to have any number of primary
3840 controllers. When multiple controllers are configured, Open
3841 vSwitch connects to all of them simultaneously. Because
3842 OpenFlow
1.0 does not specify how multiple controllers
3843 coordinate in interacting with a single switch, more than
3844 one primary controller should be specified only if the
3845 controllers are themselves designed to coordinate with each
3846 other. (The Nicira-defined
<code>NXT_ROLE
</code> OpenFlow
3847 vendor extension may be useful for this.)
3850 <dt>Service controllers
</dt>
3853 These kinds of OpenFlow controller connections are intended for
3854 occasional support and maintenance use, e.g. with
3855 <code>ovs-ofctl
</code>. Usually a service controller connects only
3856 briefly to inspect or modify some of a switch's state.
3860 Open vSwitch listens for incoming connections from service
3861 controllers. The service controllers initiate and, if necessary,
3862 maintain the connections from their end. The
<ref table=
"Bridge"
3863 column=
"fail_mode"/> column in the
<ref table=
"Bridge"/> table does
3864 not apply to service controllers.
3868 Open vSwitch supports configuring any number of service controllers.
3874 The
<ref column=
"target"/> determines the type of controller.
3877 <group title=
"Core Features">
3878 <column name=
"target">
3879 <p>Connection method for controller.
</p>
3881 The following connection methods are currently supported for primary
3885 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
3887 <p>The specified SSL
<var>port
</var> on the host at the
3888 given
<var>ip
</var>, which must be expressed as an IP
3889 address (not a DNS name). The
<ref table=
"Open_vSwitch"
3890 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
3891 table must point to a valid SSL configuration when this form
3893 <p>If
<var>port
</var> is not specified, it defaults to
6653.
</p>
3894 <p>SSL support is an optional feature that is not always built as
3895 part of Open vSwitch.
</p>
3897 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
3900 The specified TCP
<var>port
</var> on the host at the given
3901 <var>ip
</var>, which must be expressed as an IP address (not a
3902 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
3903 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
3904 e.g.
<code>tcp:[::
1]:
6653</code>.
3907 If
<var>port
</var> is not specified, it defaults to
6653.
3912 The following connection methods are currently supported for service
3916 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
3919 Listens for SSL connections on the specified TCP
<var>port
</var>.
3920 If
<var>ip
</var>, which must be expressed as an IP address (not a
3921 DNS name), is specified, then connections are restricted to the
3922 specified local IP address (either IPv4 or IPv6). If
3923 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
3924 e.g.
<code>pssl:
6653:[::
1]
</code>.
3927 If
<var>port
</var> is not specified, it defaults to
3928 6653. If
<var>ip
</var> is not specified then it listens only on
3929 IPv4 (but not IPv6) addresses. The
3930 <ref table=
"Open_vSwitch" column=
"ssl"/>
3931 column in the
<ref table=
"Open_vSwitch"/> table must point to a
3932 valid SSL configuration when this form is used.
3935 If
<var>port
</var> is not specified, it currently to
6653.
3938 SSL support is an optional feature that is not always built as
3939 part of Open vSwitch.
3942 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
3945 Listens for connections on the specified TCP
<var>port
</var>. If
3946 <var>ip
</var>, which must be expressed as an IP address (not a
3947 DNS name), is specified, then connections are restricted to the
3948 specified local IP address (either IPv4 or IPv6). If
3949 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
3950 e.g.
<code>ptcp:
6653:[::
1]
</code>. If
<var>ip
</var> is not
3951 specified then it listens only on IPv4 addresses.
3954 If
<var>port
</var> is not specified, it defaults to
6653.
3958 <p>When multiple controllers are configured for a single bridge, the
3959 <ref column=
"target"/> values must be unique. Duplicate
3960 <ref column=
"target"/> values yield unspecified results.
</p>
3963 <column name=
"connection_mode">
3964 <p>If it is specified, this setting must be one of the following
3965 strings that describes how Open vSwitch contacts this OpenFlow
3966 controller over the network:
</p>
3969 <dt><code>in-band
</code></dt>
3970 <dd>In this mode, this controller's OpenFlow traffic travels over the
3971 bridge associated with the controller. With this setting, Open
3972 vSwitch allows traffic to and from the controller regardless of the
3973 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3974 would never be able to connect to the controller, because it did
3975 not have a flow to enable it.) This is the most common connection
3976 mode because it is not necessary to maintain two independent
3978 <dt><code>out-of-band
</code></dt>
3979 <dd>In this mode, OpenFlow traffic uses a control network separate
3980 from the bridge associated with this controller, that is, the
3981 bridge does not use any of its own network devices to communicate
3982 with the controller. The control network must be configured
3983 separately, before or after
<code>ovs-vswitchd
</code> is started.
3987 <p>If not specified, the default is implementation-specific.
</p>
3991 <group title=
"Controller Failure Detection and Handling">
3992 <column name=
"max_backoff">
3993 Maximum number of milliseconds to wait between connection attempts.
3994 Default is implementation-specific.
3997 <column name=
"inactivity_probe">
3998 Maximum number of milliseconds of idle time on connection to
3999 controller before sending an inactivity probe message. If Open
4000 vSwitch does not communicate with the controller for the specified
4001 number of seconds, it will send a probe. If a response is not
4002 received for the same additional amount of time, Open vSwitch
4003 assumes the connection has been broken and attempts to reconnect.
4004 Default is implementation-specific. A value of
0 disables
4009 <group title=
"Asynchronous Messages">
4011 OpenFlow switches send certain messages to controllers spontanenously,
4012 that is, not in response to any request from the controller. These
4013 messages are called ``asynchronous messages.'' These columns allow
4014 asynchronous messages to be limited or disabled to ensure the best use
4015 of network resources.
4018 <column name=
"enable_async_messages">
4019 The OpenFlow protocol enables asynchronous messages at time of
4020 connection establishment, which means that a controller can receive
4021 asynchronous messages, potentially many of them, even if it turns them
4022 off immediately after connecting. Set this column to
4023 <code>false
</code> to change Open vSwitch behavior to disable, by
4024 default, all asynchronous messages. The controller can use the
4025 <code>NXT_SET_ASYNC_CONFIG
</code> Nicira extension to OpenFlow to turn
4026 on any messages that it does want to receive, if any.
4029 <group title=
"Controller Rate Limiting">
4031 A switch can forward packets to a controller over the OpenFlow
4032 protocol. Forwarding packets this way at too high a rate can
4033 overwhelm a controller, frustrate use of the OpenFlow connection for
4034 other purposes, increase the latency of flow setup, and use an
4035 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
4036 limiting the rate of packet forwarding to a controller.
4040 There are two main reasons in OpenFlow for a packet to be sent to a
4041 controller: either the packet ``misses'' in the flow table, that is,
4042 there is no matching flow, or a flow table action says to send the
4043 packet to the controller. Open vSwitch limits the rate of each kind
4044 of packet separately at the configured rate. Therefore, the actual
4045 rate that packets are sent to the controller can be up to twice the
4046 configured rate, when packets are sent for both reasons.
4050 This feature is specific to forwarding packets over an OpenFlow
4051 connection. It is not general-purpose QoS. See the
<ref
4052 table=
"QoS"/> table for quality of service configuration, and
<ref
4053 column=
"ingress_policing_rate" table=
"Interface"/> in the
<ref
4054 table=
"Interface"/> table for ingress policing configuration.
4057 <column name=
"controller_rate_limit">
4059 The maximum rate at which the switch will forward packets to the
4060 OpenFlow controller, in packets per second. If no value is
4061 specified, rate limiting is disabled.
4065 <column name=
"controller_burst_limit">
4067 When a high rate triggers rate-limiting, Open vSwitch queues
4068 packets to the controller for each port and transmits them to the
4069 controller at the configured rate. This value limits the number of
4070 queued packets. Ports on a bridge share the packet queue fairly.
4074 This value has no effect unless
<ref
4075 column=
"controller_rate_limit"/> is configured. The current
4076 default when this value is not specified is one-quarter of
<ref
4077 column=
"controller_rate_limit"/>, meaning that queuing can delay
4078 forwarding a packet to the controller by up to
250 ms.
4082 <group title=
"Controller Rate Limiting Statistics">
4084 These values report the effects of rate limiting. Their values are
4085 relative to establishment of the most recent OpenFlow connection,
4086 or since rate limiting was enabled, whichever happened more
4087 recently. Each consists of two values, one with
<code>TYPE
</code>
4088 replaced by
<code>miss
</code> for rate limiting flow table misses,
4089 and the other with
<code>TYPE
</code> replaced by
4090 <code>action
</code> for rate limiting packets sent by OpenFlow
4095 These statistics are reported only when controller rate limiting is
4099 <column name=
"status" key=
"packet-in-TYPE-bypassed"
4100 type='{
"type":
"integer",
"minInteger":
0}'
>
4101 Number of packets sent directly to the controller, without queuing,
4102 because the rate did not exceed the configured maximum.
4105 <column name=
"status" key=
"packet-in-TYPE-queued"
4106 type='{
"type":
"integer",
"minInteger":
0}'
>
4107 Number of packets added to the queue to send later.
4110 <column name=
"status" key=
"packet-in-TYPE-dropped"
4111 type='{
"type":
"integer",
"minInteger":
0}'
>
4112 Number of packets added to the queue that were later dropped due to
4113 overflow. This value is less than or equal to
<ref column=
"status"
4114 key=
"packet-in-TYPE-queued"/>.
4117 <column name=
"status" key=
"packet-in-TYPE-backlog"
4118 type='{
"type":
"integer",
"minInteger":
0}'
>
4119 Number of packets currently queued. The other statistics increase
4120 monotonically, but this one fluctuates between
0 and the
<ref
4121 column=
"controller_burst_limit"/> as conditions change.
4127 <group title=
"Additional In-Band Configuration">
4128 <p>These values are considered only in in-band control mode (see
4129 <ref column=
"connection_mode"/>).
</p>
4131 <p>When multiple controllers are configured on a single bridge, there
4132 should be only one set of unique values in these columns. If different
4133 values are set for these columns in different controllers, the effect
4136 <column name=
"local_ip">
4137 The IP address to configure on the local port,
4138 e.g.
<code>192.168.0.123</code>. If this value is unset, then
4139 <ref column=
"local_netmask"/> and
<ref column=
"local_gateway"/> are
4143 <column name=
"local_netmask">
4144 The IP netmask to configure on the local port,
4145 e.g.
<code>255.255.255.0</code>. If
<ref column=
"local_ip"/> is set
4146 but this value is unset, then the default is chosen based on whether
4147 the IP address is class A, B, or C.
4150 <column name=
"local_gateway">
4151 The IP address of the gateway to configure on the local port, as a
4152 string, e.g.
<code>192.168.0.1</code>. Leave this column unset if
4153 this network has no gateway.
4157 <group title=
"Controller Status">
4158 <column name=
"is_connected">
4159 <code>true
</code> if currently connected to this controller,
4160 <code>false
</code> otherwise.
4164 type='{
"type":
"string",
"enum": [
"set", [
"other",
"master",
"slave"]]}'
>
4165 <p>The level of authority this controller has on the associated
4166 bridge. Possible values are:
</p>
4168 <dt><code>other
</code></dt>
4169 <dd>Allows the controller access to all OpenFlow features.
</dd>
4170 <dt><code>master
</code></dt>
4171 <dd>Equivalent to
<code>other
</code>, except that there may be at
4172 most one master controller at a time. When a controller configures
4173 itself as
<code>master
</code>, any existing master is demoted to
4174 the
<code>slave
</code> role.
</dd>
4175 <dt><code>slave
</code></dt>
4176 <dd>Allows the controller read-only access to OpenFlow features.
4177 Attempts to modify the flow table will be rejected with an
4178 error. Slave controllers do not receive OFPT_PACKET_IN or
4179 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
4184 <column name=
"status" key=
"last_error">
4185 A human-readable description of the last error on the connection
4186 to the controller; i.e.
<code>strerror(errno)
</code>. This key
4187 will exist only if an error has occurred.
4190 <column name=
"status" key=
"state"
4191 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4193 The state of the connection to the controller:
4196 <dt><code>VOID
</code></dt>
4197 <dd>Connection is disabled.
</dd>
4199 <dt><code>BACKOFF
</code></dt>
4200 <dd>Attempting to reconnect at an increasing period.
</dd>
4202 <dt><code>CONNECTING
</code></dt>
4203 <dd>Attempting to connect.
</dd>
4205 <dt><code>ACTIVE
</code></dt>
4206 <dd>Connected, remote host responsive.
</dd>
4208 <dt><code>IDLE
</code></dt>
4209 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4212 These values may change in the future. They are provided only for
4217 <column name=
"status" key=
"sec_since_connect"
4218 type='{
"type":
"integer",
"minInteger":
0}'
>
4219 The amount of time since this controller last successfully connected to
4220 the switch (in seconds). Value is empty if controller has never
4221 successfully connected.
4224 <column name=
"status" key=
"sec_since_disconnect"
4225 type='{
"type":
"integer",
"minInteger":
1}'
>
4226 The amount of time since this controller last disconnected from
4227 the switch (in seconds). Value is empty if controller has never
4232 <group title=
"Connection Parameters">
4234 Additional configuration for a connection between the controller
4235 and the Open vSwitch.
4238 <column name=
"other_config" key=
"dscp"
4239 type='{
"type":
"integer"}'
>
4240 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4241 in the Type of Service (TOS) field in the IP header. DSCP provides a
4242 mechanism to classify the network traffic and provide Quality of
4243 Service (QoS) on IP networks.
4245 The DSCP value specified here is used when establishing the connection
4246 between the controller and the Open vSwitch. If no value is specified,
4247 a default value of
48 is chosen. Valid DSCP values must be in the
4253 <group title=
"Common Columns">
4254 The overall purpose of these columns is described under
<code>Common
4255 Columns
</code> at the beginning of this document.
4257 <column name=
"external_ids"/>
4258 <column name=
"other_config"/>
4262 <table name=
"Manager" title=
"OVSDB management connection.">
4264 Configuration for a database connection to an Open vSwitch database
4269 This table primarily configures the Open vSwitch database
4270 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
4271 (
<code>ovs-vswitchd
</code>). The switch does read the table to determine
4272 what connections should be treated as in-band.
4276 The Open vSwitch database server can initiate and maintain active
4277 connections to remote clients. It can also listen for database
4281 <group title=
"Core Features">
4282 <column name=
"target">
4283 <p>Connection method for managers.
</p>
4285 The following connection methods are currently supported:
4288 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4291 The specified SSL
<var>port
</var> on the host at the given
4292 <var>ip
</var>, which must be expressed as an IP address
4293 (not a DNS name). The
<ref table=
"Open_vSwitch"
4294 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
4295 table must point to a valid SSL configuration when this
4299 If
<var>port
</var> is not specified, it defaults to
6640.
4302 SSL support is an optional feature that is not always
4303 built as part of Open vSwitch.
4307 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4310 The specified TCP
<var>port
</var> on the host at the given
4311 <var>ip
</var>, which must be expressed as an IP address (not a
4312 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
4313 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4314 e.g.
<code>tcp:[::
1]:
6640</code>.
4317 If
<var>port
</var> is not specified, it defaults to
6640.
4320 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4323 Listens for SSL connections on the specified TCP
<var>port
</var>.
4324 Specify
0 for
<var>port
</var> to have the kernel automatically
4325 choose an available port. If
<var>ip
</var>, which must be
4326 expressed as an IP address (not a DNS name), is specified, then
4327 connections are restricted to the specified local IP address
4328 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4329 address, wrap in square brackets,
4330 e.g.
<code>pssl:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4331 specified then it listens only on IPv4 (but not IPv6) addresses.
4332 The
<ref table=
"Open_vSwitch" column=
"ssl"/> column in the
<ref
4333 table=
"Open_vSwitch"/> table must point to a valid SSL
4334 configuration when this form is used.
4337 If
<var>port
</var> is not specified, it defaults to
6640.
4340 SSL support is an optional feature that is not always built as
4341 part of Open vSwitch.
4344 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4347 Listens for connections on the specified TCP
<var>port
</var>.
4348 Specify
0 for
<var>port
</var> to have the kernel automatically
4349 choose an available port. If
<var>ip
</var>, which must be
4350 expressed as an IP address (not a DNS name), is specified, then
4351 connections are restricted to the specified local IP address
4352 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4353 address, wrap it in square brackets,
4354 e.g.
<code>ptcp:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4355 specified then it listens only on IPv4 addresses.
4358 If
<var>port
</var> is not specified, it defaults to
6640.
4362 <p>When multiple managers are configured, the
<ref column=
"target"/>
4363 values must be unique. Duplicate
<ref column=
"target"/> values yield
4364 unspecified results.
</p>
4367 <column name=
"connection_mode">
4369 If it is specified, this setting must be one of the following strings
4370 that describes how Open vSwitch contacts this OVSDB client over the
4375 <dt><code>in-band
</code></dt>
4377 In this mode, this connection's traffic travels over a bridge
4378 managed by Open vSwitch. With this setting, Open vSwitch allows
4379 traffic to and from the client regardless of the contents of the
4380 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4381 to connect to the client, because it did not have a flow to enable
4382 it.) This is the most common connection mode because it is not
4383 necessary to maintain two independent networks.
4385 <dt><code>out-of-band
</code></dt>
4387 In this mode, the client's traffic uses a control network separate
4388 from that managed by Open vSwitch, that is, Open vSwitch does not
4389 use any of its own network devices to communicate with the client.
4390 The control network must be configured separately, before or after
4391 <code>ovs-vswitchd
</code> is started.
4396 If not specified, the default is implementation-specific.
4401 <group title=
"Client Failure Detection and Handling">
4402 <column name=
"max_backoff">
4403 Maximum number of milliseconds to wait between connection attempts.
4404 Default is implementation-specific.
4407 <column name=
"inactivity_probe">
4408 Maximum number of milliseconds of idle time on connection to the client
4409 before sending an inactivity probe message. If Open vSwitch does not
4410 communicate with the client for the specified number of seconds, it
4411 will send a probe. If a response is not received for the same
4412 additional amount of time, Open vSwitch assumes the connection has been
4413 broken and attempts to reconnect. Default is implementation-specific.
4414 A value of
0 disables inactivity probes.
4418 <group title=
"Status">
4420 Key-value pair of
<ref column=
"is_connected"/> is always updated.
4421 Other key-value pairs in the status columns may be updated depends
4422 on the
<ref column=
"target"/> type.
4426 When
<ref column=
"target"/> specifies a connection method that
4427 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4428 <code>punix:
</code>), both
<ref column=
"n_connections"/> and
4429 <ref column=
"is_connected"/> may also be updated while the
4430 remaining key-value pairs are omitted.
4434 On the other hand, when
<ref column=
"target"/> specifies an
4435 outbound connection, all key-value pairs may be updated, except
4436 the above-mentioned two key-value pairs associated with inbound
4437 connection targets. They are omitted.
4440 <column name=
"is_connected">
4441 <code>true
</code> if currently connected to this manager,
4442 <code>false
</code> otherwise.
4445 <column name=
"status" key=
"last_error">
4446 A human-readable description of the last error on the connection
4447 to the manager; i.e.
<code>strerror(errno)
</code>. This key
4448 will exist only if an error has occurred.
4451 <column name=
"status" key=
"state"
4452 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4454 The state of the connection to the manager:
4457 <dt><code>VOID
</code></dt>
4458 <dd>Connection is disabled.
</dd>
4460 <dt><code>BACKOFF
</code></dt>
4461 <dd>Attempting to reconnect at an increasing period.
</dd>
4463 <dt><code>CONNECTING
</code></dt>
4464 <dd>Attempting to connect.
</dd>
4466 <dt><code>ACTIVE
</code></dt>
4467 <dd>Connected, remote host responsive.
</dd>
4469 <dt><code>IDLE
</code></dt>
4470 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4473 These values may change in the future. They are provided only for
4478 <column name=
"status" key=
"sec_since_connect"
4479 type='{
"type":
"integer",
"minInteger":
0}'
>
4480 The amount of time since this manager last successfully connected
4481 to the database (in seconds). Value is empty if manager has never
4482 successfully connected.
4485 <column name=
"status" key=
"sec_since_disconnect"
4486 type='{
"type":
"integer",
"minInteger":
0}'
>
4487 The amount of time since this manager last disconnected from the
4488 database (in seconds). Value is empty if manager has never
4492 <column name=
"status" key=
"locks_held">
4493 Space-separated list of the names of OVSDB locks that the connection
4494 holds. Omitted if the connection does not hold any locks.
4497 <column name=
"status" key=
"locks_waiting">
4498 Space-separated list of the names of OVSDB locks that the connection is
4499 currently waiting to acquire. Omitted if the connection is not waiting
4503 <column name=
"status" key=
"locks_lost">
4504 Space-separated list of the names of OVSDB locks that the connection
4505 has had stolen by another OVSDB client. Omitted if no locks have been
4506 stolen from this connection.
4509 <column name=
"status" key=
"n_connections"
4510 type='{
"type":
"integer",
"minInteger":
2}'
>
4511 When
<ref column=
"target"/> specifies a connection method that
4512 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4513 <code>pssl:
</code>) and more than one connection is actually active,
4514 the value is the number of active connections. Otherwise, this
4515 key-value pair is omitted.
4518 <column name=
"status" key=
"bound_port" type='{
"type":
"integer"}'
>
4519 When
<ref column=
"target"/> is
<code>ptcp:
</code> or
4520 <code>pssl:
</code>, this is the TCP port on which the OVSDB server is
4521 listening. (This is particularly useful when
<ref
4522 column=
"target"/> specifies a port of
0, allowing the kernel to
4523 choose any available port.)
4527 <group title=
"Connection Parameters">
4529 Additional configuration for a connection between the manager
4530 and the Open vSwitch Database.
4533 <column name=
"other_config" key=
"dscp"
4534 type='{
"type":
"integer"}'
>
4535 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4536 in the Type of Service (TOS) field in the IP header. DSCP provides a
4537 mechanism to classify the network traffic and provide Quality of
4538 Service (QoS) on IP networks.
4540 The DSCP value specified here is used when establishing the connection
4541 between the manager and the Open vSwitch. If no value is specified, a
4542 default value of
48 is chosen. Valid DSCP values must be in the range
4547 <group title=
"Common Columns">
4548 The overall purpose of these columns is described under
<code>Common
4549 Columns
</code> at the beginning of this document.
4551 <column name=
"external_ids"/>
4552 <column name=
"other_config"/>
4556 <table name=
"NetFlow">
4557 A NetFlow target. NetFlow is a protocol that exports a number of
4558 details about terminating IP flows, such as the principals involved
4561 <column name=
"targets">
4562 NetFlow targets in the form
4563 <code><var>ip
</var>:
<var>port
</var></code>. The
<var>ip
</var>
4564 must be specified numerically, not as a DNS name.
4567 <column name=
"engine_id">
4568 Engine ID to use in NetFlow messages. Defaults to datapath index
4572 <column name=
"engine_type">
4573 Engine type to use in NetFlow messages. Defaults to datapath
4574 index if not specified.
4577 <column name=
"active_timeout">
4579 The interval at which NetFlow records are sent for flows that
4580 are still active, in seconds. A value of
<code>0</code>
4581 requests the default timeout (currently
600 seconds); a value
4582 of
<code>-
1</code> disables active timeouts.
4586 The NetFlow passive timeout, for flows that become inactive,
4587 is not configurable. It will vary depending on the Open
4588 vSwitch version, the forms and contents of the OpenFlow flow
4589 tables, CPU and memory usage, and network activity. A typical
4590 passive timeout is about a second.
4594 <column name=
"add_id_to_interface">
4595 <p>If this column's value is
<code>false
</code>, the ingress and egress
4596 interface fields of NetFlow flow records are derived from OpenFlow port
4597 numbers. When it is
<code>true
</code>, the
7 most significant bits of
4598 these fields will be replaced by the least significant
7 bits of the
4599 engine id. This is useful because many NetFlow collectors do not
4600 expect multiple switches to be sending messages from the same host, so
4601 they do not store the engine information which could be used to
4602 disambiguate the traffic.
</p>
4603 <p>When this option is enabled, a maximum of
508 ports are supported.
</p>
4606 <group title=
"Common Columns">
4607 The overall purpose of these columns is described under
<code>Common
4608 Columns
</code> at the beginning of this document.
4610 <column name=
"external_ids"/>
4615 SSL configuration for an Open_vSwitch.
4617 <column name=
"private_key">
4618 Name of a PEM file containing the private key used as the switch's
4619 identity for SSL connections to the controller.
4622 <column name=
"certificate">
4623 Name of a PEM file containing a certificate, signed by the
4624 certificate authority (CA) used by the controller and manager,
4625 that certifies the switch's private key, identifying a trustworthy
4629 <column name=
"ca_cert">
4630 Name of a PEM file containing the CA certificate used to verify
4631 that the switch is connected to a trustworthy controller.
4634 <column name=
"bootstrap_ca_cert">
4635 If set to
<code>true
</code>, then Open vSwitch will attempt to
4636 obtain the CA certificate from the controller on its first SSL
4637 connection and save it to the named PEM file. If it is successful,
4638 it will immediately drop the connection and reconnect, and from then
4639 on all SSL connections must be authenticated by a certificate signed
4640 by the CA certificate thus obtained.
<em>This option exposes the
4641 SSL connection to a man-in-the-middle attack obtaining the initial
4642 CA certificate.
</em> It may still be useful for bootstrapping.
4645 <group title=
"Common Columns">
4646 The overall purpose of these columns is described under
<code>Common
4647 Columns
</code> at the beginning of this document.
4649 <column name=
"external_ids"/>
4653 <table name=
"sFlow">
4654 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4655 monitoring of switches.
</p>
4657 <column name=
"agent">
4658 Name of the network device whose IP address should be reported as the
4659 ``agent address'' to collectors. If not specified, the agent device is
4660 figured from the first target address and the routing table. If the
4661 routing table does not contain a route to the target, the IP address
4662 defaults to the
<ref table=
"Controller" column=
"local_ip"/> in the
4663 collector's
<ref table=
"Controller"/>. If an agent IP address cannot be
4664 determined any of these ways, sFlow is disabled.
4667 <column name=
"header">
4668 Number of bytes of a sampled packet to send to the collector.
4669 If not specified, the default is
128 bytes.
4672 <column name=
"polling">
4673 Polling rate in seconds to send port statistics to the collector.
4674 If not specified, defaults to
30 seconds.
4677 <column name=
"sampling">
4678 Rate at which packets should be sampled and sent to the collector.
4679 If not specified, defaults to
400, which means one out of
400
4680 packets, on average, will be sent to the collector.
4683 <column name=
"targets">
4684 sFlow targets in the form
4685 <code><var>ip
</var>:
<var>port
</var></code>.
4688 <group title=
"Common Columns">
4689 The overall purpose of these columns is described under
<code>Common
4690 Columns
</code> at the beginning of this document.
4692 <column name=
"external_ids"/>
4696 <table name=
"IPFIX">
4697 <p>Configuration for sending packets to IPFIX collectors.
</p>
4700 IPFIX is a protocol that exports a number of details about flows. The
4701 IPFIX implementation in Open vSwitch samples packets at a configurable
4702 rate, extracts flow information from those packets, optionally caches and
4703 aggregates the flow information, and sends the result to one or more
4708 IPFIX in Open vSwitch can be configured two different ways:
4713 With
<em>per-bridge sampling
</em>, Open vSwitch performs IPFIX sampling
4714 automatically on all packets that pass through a bridge. To configure
4715 per-bridge sampling, create an
<ref table=
"IPFIX"/> record and point a
4716 <ref table=
"Bridge"/> table's
<ref table=
"Bridge" column=
"ipfix"/>
4717 column to it. The
<ref table=
"Flow_Sample_Collector_Set"/> table is
4718 not used for per-bridge sampling.
4723 With
<em>flow-based sampling
</em>,
<code>sample
</code> actions in the
4724 OpenFlow flow table drive IPFIX sampling. See
4725 <code>ovs-ofctl
</code>(
8) for a description of the
4726 <code>sample
</code> action.
4730 Flow-based sampling also requires database configuration: create a
4731 <ref table=
"IPFIX"/> record that describes the IPFIX configuration
4732 and a
<ref table=
"Flow_Sample_Collector_Set"/> record that points to
4733 the
<ref table=
"Bridge"/> whose flow table holds the
4734 <code>sample
</code> actions and to
<ref table=
"IPFIX"/> record. The
4735 <ref table=
"Bridge" column=
"ipfix"/> in the
<ref table=
"Bridge"/>
4736 table is not used for flow-based sampling.
4741 <column name=
"targets">
4742 IPFIX target collectors in the form
4743 <code><var>ip
</var>:
<var>port
</var></code>.
4746 <column name=
"cache_active_timeout">
4747 The maximum period in seconds for which an IPFIX flow record is
4748 cached and aggregated before being sent. If not specified,
4749 defaults to
0. If
0, caching is disabled.
4752 <column name=
"cache_max_flows">
4753 The maximum number of IPFIX flow records that can be cached at a
4754 time. If not specified, defaults to
0. If
0, caching is
4758 <column name=
"other_config" key=
"enable-tunnel-sampling"
4759 type='{
"type":
"boolean"}'
>
4761 Set to
<code>true
</code> to enable sampling and reporting tunnel
4762 header
7-tuples in IPFIX flow records. Tunnel sampling is enabled
4767 The following enterprise entities report the sampled tunnel info:
4771 <dt>tunnelType:
</dt>
4773 <p>ID:
891, and enterprise ID
6876 (VMware).
</p>
4774 <p>type: unsigned
8-bit integer.
</p>
4775 <p>data type semantics: identifier.
</p>
4776 <p>description: Identifier of the layer
2 network overlay network
4777 encapsulation type:
0x01 VxLAN,
0x02 GRE,
0x03 LISP,
0x05 IPsec+GRE,
4782 <p>ID:
892, and enterprise ID
6876 (VMware).
</p>
4783 <p>type: variable-length octetarray.
</p>
4784 <p>data type semantics: identifier.
</p>
4785 <p>description: Key which is used for identifying an individual
4786 traffic flow within a VxLAN (
24-bit VNI), GENEVE (
24-bit VNI),
4787 GRE (
32-bit key), or LISP (
24-bit instance ID) tunnel. The
4788 key is encoded in this octetarray as a
3-,
4-, or
8-byte integer
4789 ID in network byte order.
</p>
4791 <dt>tunnelSourceIPv4Address:
</dt>
4793 <p>ID:
893, and enterprise ID
6876 (VMware).
</p>
4794 <p>type: unsigned
32-bit integer.
</p>
4795 <p>data type semantics: identifier.
</p>
4796 <p>description: The IPv4 source address in the tunnel IP packet
4799 <dt>tunnelDestinationIPv4Address:
</dt>
4801 <p>ID:
894, and enterprise ID
6876 (VMware).
</p>
4802 <p>type: unsigned
32-bit integer.
</p>
4803 <p>data type semantics: identifier.
</p>
4804 <p>description: The IPv4 destination address in the tunnel IP
4807 <dt>tunnelProtocolIdentifier:
</dt>
4809 <p>ID:
895, and enterprise ID
6876 (VMware).
</p>
4810 <p>type: unsigned
8-bit integer.
</p>
4811 <p>data type semantics: identifier.
</p>
4812 <p>description: The value of the protocol number in the tunnel
4813 IP packet header. The protocol number identifies the tunnel IP
4814 packet payload type.
</p>
4816 <dt>tunnelSourceTransportPort:
</dt>
4818 <p>ID:
896, and enterprise ID
6876 (VMware).
</p>
4819 <p>type: unsigned
16-bit integer.
</p>
4820 <p>data type semantics: identifier.
</p>
4821 <p>description: The source port identifier in the tunnel transport
4822 header. For the transport protocols UDP, TCP, and SCTP, this is
4823 the source port number given in the respective header.
</p>
4825 <dt>tunnelDestinationTransportPort:
</dt>
4827 <p>ID:
897, and enterprise ID
6876 (VMware).
</p>
4828 <p>type: unsigned
16-bit integer.
</p>
4829 <p>data type semantics: identifier.
</p>
4830 <p>description: The destination port identifier in the tunnel
4831 transport header. For the transport protocols UDP, TCP, and SCTP,
4832 this is the destination port number given in the respective header.
4838 Before Open vSwitch
2.5.90,
<ref column=
"other_config"
4839 key=
"enable-tunnel-sampling"/> was only supported with per-bridge
4840 sampling, and ignored otherwise. Open vSwitch
2.5.90 and later support
4841 <ref column=
"other_config" key=
"enable-tunnel-sampling"/> for
4842 per-bridge and per-flow sampling.
4846 <column name=
"other_config" key=
"virtual_obs_id"
4847 type='{
"type":
"string"}'
>
4849 A string that accompanies each IPFIX flow record. Its intended use is
4850 for the ``virtual observation ID,'' an identifier of a virtual
4851 observation point that is locally unique in a virtual network. It
4852 describes a location in the virtual network where IP packets can be
4853 observed. The maximum length is
254 bytes. If not specified, the
4854 field is omitted from the IPFIX flow record.
4858 The following enterprise entity reports the specified virtual
4863 <dt>virtualObsID:
</dt>
4865 <p>ID:
898, and enterprise ID
6876 (VMware).
</p>
4866 <p>type: variable-length string.
</p>
4867 <p>data type semantics: identifier.
</p>
4868 <p>description: A virtual observation domain ID that is locally
4869 unique in a virtual network.
4875 This feature was introduced in Open vSwitch
2.5.90.
4879 <group title=
"Per-Bridge Sampling">
4881 These values affect only per-bridge sampling. See above for a
4882 description of the differences between per-bridge and flow-based
4886 <column name=
"sampling">
4887 The rate at which packets should be sampled and sent to each target
4888 collector. If not specified, defaults to
400, which means one out of
4889 400 packets, on average, will be sent to each target collector.
4892 <column name=
"obs_domain_id">
4893 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4894 specified, defaults to
0.
4897 <column name=
"obs_point_id">
4898 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4899 specified, defaults to
0.
4902 <column name=
"other_config" key=
"enable-input-sampling"
4903 type='{
"type":
"boolean"}'
>
4904 By default, Open vSwitch samples and reports flows at bridge port input
4905 in IPFIX flow records. Set this column to
<code>false
</code> to
4906 disable input sampling.
4909 <column name=
"other_config" key=
"enable-output-sampling"
4910 type='{
"type":
"boolean"}'
>
4911 By default, Open vSwitch samples and reports flows at bridge port
4912 output in IPFIX flow records. Set this column to
<code>false
</code> to
4913 disable output sampling.
4917 <group title=
"Common Columns">
4918 The overall purpose of these columns is described under
<code>Common
4919 Columns
</code> at the beginning of this document.
4921 <column name=
"external_ids"/>
4925 <table name=
"Flow_Sample_Collector_Set">
4927 A set of IPFIX collectors of packet samples generated by OpenFlow
4928 <code>sample
</code> actions. This table is used only for IPFIX
4929 flow-based sampling, not for per-bridge sampling (see the
<ref
4930 table=
"IPFIX"/> table for a description of the two forms).
4934 The ID of this collector set, unique among the bridge's
4935 collector sets, to be used as the
<code>collector_set_id
</code>
4936 in OpenFlow
<code>sample
</code> actions.
4939 <column name=
"bridge">
4940 The bridge into which OpenFlow
<code>sample
</code> actions can
4941 be added to send packet samples to this set of IPFIX collectors.
4944 <column name=
"ipfix">
4945 Configuration of the set of IPFIX collectors to send one flow
4946 record per sampled packet to.
4949 <group title=
"Common Columns">
4950 The overall purpose of these columns is described under
<code>Common
4951 Columns
</code> at the beginning of this document.
4953 <column name=
"external_ids"/>
4957 <table name=
"AutoAttach">
4959 Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4960 draft standard describes a compact method of using IEEE
802.1AB Link
4961 Layer Discovery Protocol (LLDP) together with a IEEE
802.1aq Shortest
4962 Path Bridging (SPB) network to automatically attach network devices
4963 to individual services in a SPB network. The intent here is to allow
4964 network applications and devices using OVS to be able to easily take
4965 advantage of features offered by industry standard SPB networks.
4969 Auto Attach (AA) uses LLDP to communicate between a directly connected
4970 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4971 is extended to add two new Type-Length-Value tuples (TLVs). The first
4972 new TLV supports the ongoing discovery of directly connected AA
4973 correspondents. Auto Attach operates by regularly transmitting AA
4974 discovery TLVs between the AA client and AA server. By exchanging these
4975 discovery messages, both the AAC and AAS learn the system name and
4976 system description of their peer. In the OVS context, OVS operates as
4977 the AA client and the AA server resides on a switch at the edge of the
4982 Once AA discovery has been completed the AAC then uses the second new TLV
4983 to deliver identifier mappings from the AAC to the AAS. A primary feature
4984 of Auto Attach is to facilitate the mapping of VLANs defined outside the
4985 SPB network onto service ids (ISIDs) defined within the SPM network. By
4986 doing so individual external VLANs can be mapped onto specific SPB
4987 network services. These VLAN id to ISID mappings can be configured and
4988 managed locally using new options added to the ovs-vsctl command.
4992 The Auto Attach OVS feature does not provide a full implementation of
4993 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
4994 standard and support for the AA TLV extensions is provided. LLDP
4995 protocol support in OVS can be enabled or disabled on a port by port
4996 basis. LLDP support is disabled by default.
4999 <column name=
"system_name">
5000 The system_name string is exported in LLDP messages. It should uniquely
5001 identify the bridge in the network.
5004 <column name=
"system_description">
5005 The system_description string is exported in LLDP messages. It should
5006 describe the type of software and hardware.
5009 <column name=
"mappings">
5010 A mapping from SPB network Individual Service Identifier (ISID) to VLAN