1 <?xml version=
"1.0" encoding=
"utf-8"?>
2 <database name=
"ovs-vswitchd.conf.db" title=
"Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table=
"Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the
<ref
9 table=
"Open_vSwitch"/> table. Records that are not reachable from
10 the
<ref table=
"Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns
</h2>
18 Most tables contain two special columns, named
<code>other_config
</code>
19 and
<code>external_ids
</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config
</code>: map of string-string pairs
</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have
<code>other_config
</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids
</code>: map of string-string pairs
</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name=
"Open_vSwitch" title=
"Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the
<ref table=
"Open_vSwitch"/> table.
54 <group title=
"Configuration">
55 <column name=
"bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name=
"external_ids" key=
"system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column=
"external_ids" key=
"xs-system-uuid"/>.
70 <column name=
"external_ids" key=
"xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by
<code>xe host-list
</code>.
75 <column name=
"external_ids" key=
"hostname">
76 The hostname for the host running Open vSwitch. This is a fully
77 qualified domain name since version
2.6.2.
80 <column name=
"other_config" key=
"stats-update-interval"
81 type='{
"type":
"integer",
"minInteger":
5000}'
>
83 Interval for updating statistics to the database, in milliseconds.
84 This option will affect the update of the
<code>statistics
</code>
85 column in the following tables:
<code>Port
</code>,
<code>Interface
86 </code>,
<code>Mirror
</code>.
89 Default value is
5000 ms.
92 Getting statistics more frequently can be achieved via OpenFlow.
96 <column name=
"other_config" key=
"flow-restore-wait"
97 type='{
"type":
"boolean"}'
>
99 When
<code>ovs-vswitchd
</code> starts up, it has an empty flow table
100 and therefore it handles all arriving packets in its default fashion
101 according to its configuration, by dropping them or sending them to
102 an OpenFlow controller or switching them as a standalone switch.
103 This behavior is ordinarily desirable. However, if
104 <code>ovs-vswitchd
</code> is restarting as part of a ``hot-upgrade,''
105 then this leads to a relatively long period during which packets are
109 This option allows for improvement. When
<code>ovs-vswitchd
</code>
110 starts with this value set as
<code>true
</code>, it will neither
111 flush or expire previously set datapath flows nor will it send and
112 receive any packets to or from the datapath. When this value is
113 later set to
<code>false
</code>,
<code>ovs-vswitchd
</code> will
114 start receiving packets from the datapath and re-setup the flows.
117 Thus, with this option, the procedure for a hot-upgrade of
118 <code>ovs-vswitchd
</code> becomes roughly the following:
122 Stop
<code>ovs-vswitchd
</code>.
125 Set
<ref column=
"other_config" key=
"flow-restore-wait"/>
126 to
<code>true
</code>.
129 Start
<code>ovs-vswitchd
</code>.
132 Use
<code>ovs-ofctl
</code> (or some other program, such as an
133 OpenFlow controller) to restore the OpenFlow flow table
134 to the desired state.
137 Set
<ref column=
"other_config" key=
"flow-restore-wait"/>
138 to
<code>false
</code> (or remove it entirely from the database).
142 The
<code>ovs-ctl
</code>'s ``restart'' and ``force-reload-kmod''
143 functions use the above config option during hot upgrades.
147 <column name=
"other_config" key=
"flow-limit"
148 type='{
"type":
"integer",
"minInteger":
0}'
>
151 number of flows allowed in the datapath flow table. Internally OVS
152 will choose a flow limit which will likely be lower than this number,
153 based on real time network conditions. Tweaking this value is
154 discouraged unless you know exactly what you're doing.
157 The default is
200000.
161 <column name=
"other_config" key=
"max-idle"
162 type='{
"type":
"integer",
"minInteger":
500}'
>
164 The maximum time (in ms) that idle flows will remain cached in the
165 datapath. Internally OVS will check the validity and activity for
166 datapath flows regularly and may expire flows quicker than this
167 number, based on real time network conditions. Tweaking this
168 value is discouraged unless you know exactly what you're doing.
171 The default is
10000.
175 <column name=
"other_config" key=
"dpdk-init"
176 type='{
"type":
"boolean"}'
>
178 Set this value to
<code>true
</code> to enable runtime support for
179 DPDK ports. The vswitch must have compile-time support for DPDK as
183 The default value is
<code>false
</code>. Changing this value requires
184 restarting the daemon
187 If this value is
<code>false
</code> at startup, any dpdk ports which
188 are configured in the bridge will fail due to memory errors.
192 <column name=
"other_config" key=
"dpdk-lcore-mask"
193 type='{
"type":
"integer",
"minInteger":
1}'
>
195 Specifies the CPU cores where dpdk lcore threads should be spawned.
196 The DPDK lcore threads are used for DPDK library tasks, such as
197 library internal message processing, logging, etc. Value should be in
198 the form of a hex string (so '
0x123') similar to the 'taskset' mask
202 The lowest order bit corresponds to the first CPU core. A set bit
203 means the corresponding core is available and an lcore thread will be
204 created and pinned to it. If the input does not cover all cores,
205 those uncovered cores are considered not set.
208 For performance reasons, it is best to set this to a single core on
209 the system, rather than allow lcore threads to float.
212 If not specified, the value will be determined by choosing the lowest
213 CPU core from initial cpu affinity list. Otherwise, the value will be
214 passed directly to the DPDK library.
218 <column name=
"other_config" key=
"pmd-cpu-mask">
220 Specifies CPU mask for setting the cpu affinity of PMD (Poll
221 Mode Driver) threads. Value should be in the form of hex string,
222 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
226 The lowest order bit corresponds to the first CPU core. A set bit
227 means the corresponding core is available and a pmd thread will be
228 created and pinned to it. If the input does not cover all cores,
229 those uncovered cores are considered not set.
232 If not specified, one pmd thread will be created for each numa node
233 and pinned to any available core on the numa node by default.
237 <column name=
"other_config" key=
"dpdk-alloc-mem"
238 type='{
"type":
"integer",
"minInteger":
0}'
>
240 Specifies the amount of memory to preallocate from the hugepage pool,
241 regardless of socket. It is recommended that dpdk-socket-mem is used
245 If not specified, the value is
0. Changing this value requires
246 restarting the daemon.
250 <column name=
"other_config" key=
"dpdk-socket-mem"
251 type='{
"type":
"string"}'
>
253 Specifies the amount of memory to preallocate from the hugepage pool,
254 on a per-socket basis.
257 The specifier is a comma-separated string, in ascending order of CPU
258 socket (ex:
1024,
2048,
4096,
8192 would set socket
0 to preallocate
259 1024MB, socket
1 to preallocate
2048MB, etc.)
262 If not specified, the default value is
1024,
0. Changing this value
263 requires restarting the daemon.
267 <column name=
"other_config" key=
"dpdk-hugepage-dir"
268 type='{
"type":
"string"}'
>
270 Specifies the path to the hugetlbfs mount point.
273 If not specified, this will be guessed by the DPDK library (default
274 is /dev/hugepages). Changing this value requires restarting the
279 <column name=
"other_config" key=
"dpdk-extra"
280 type='{
"type":
"string"}'
>
282 Specifies additional eal command line arguments for DPDK.
285 The default is empty. Changing this value requires restarting the
290 <column name=
"other_config" key=
"vhost-sock-dir"
291 type='{
"type":
"string"}'
>
293 Specifies the path to the vhost-user unix domain socket files. This
294 path must exist and be a subdirectory tree of the Open vSwitch
298 Defaults to the working directory of the application. Changing this
299 value requires restarting the daemon.
303 <column name=
"other_config" key=
"n-handler-threads"
304 type='{
"type":
"integer",
"minInteger":
1}'
>
306 Specifies the number of threads for software datapaths to use for
307 handling new flows. The default the number of online CPU cores minus
308 the number of revalidators.
311 This configuration is per datapath. If you have more than one
312 software datapath (e.g. some
<code>system
</code> bridges and some
313 <code>netdev
</code> bridges), then the total number of threads is
314 <code>n-handler-threads
</code> times the number of software
319 <column name=
"other_config" key=
"n-revalidator-threads"
320 type='{
"type":
"integer",
"minInteger":
1}'
>
322 Specifies the number of threads for software datapaths to use for
323 revalidating flows in the datapath. Typically, there is a direct
324 correlation between the number of revalidator threads, and the number
325 of flows allowed in the datapath. The default is the number of cpu
326 cores divided by four plus one. If
<code>n-handler-threads
</code> is
327 set, the default changes to the number of cpu cores minus the number
331 This configuration is per datapath. If you have more than one
332 software datapath (e.g. some
<code>system
</code> bridges and some
333 <code>netdev
</code> bridges), then the total number of threads is
334 <code>n-handler-threads
</code> times the number of software
340 <group title=
"Status">
341 <column name=
"next_cfg">
342 Sequence number for client to increment. When a client modifies
343 any part of the database configuration and wishes to wait for
344 Open vSwitch to finish applying the changes, it may increment
345 this sequence number.
348 <column name=
"cur_cfg">
349 Sequence number that Open vSwitch sets to the current value of
350 <ref column=
"next_cfg"/> after it finishes applying a set of
351 configuration changes.
354 <group title=
"Statistics">
356 The
<code>statistics
</code> column contains key-value pairs that
357 report statistics about a system running an Open vSwitch. These are
358 updated periodically (currently, every
5 seconds). Key-value pairs
359 that cannot be determined or that do not apply to a platform are
363 <column name=
"other_config" key=
"enable-statistics"
364 type='{
"type":
"boolean"}'
>
365 Statistics are disabled by default to avoid overhead in the common
366 case when statistics gathering is not useful. Set this value to
367 <code>true
</code> to enable populating the
<ref column=
"statistics"/>
368 column or to
<code>false
</code> to explicitly disable it.
371 <column name=
"statistics" key=
"cpu"
372 type='{
"type":
"integer",
"minInteger":
1}'
>
374 Number of CPU processors, threads, or cores currently online and
375 available to the operating system on which Open vSwitch is running,
376 as an integer. This may be less than the number installed, if some
377 are not online or if they are not available to the operating
381 Open vSwitch userspace processes are not multithreaded, but the
382 Linux kernel-based datapath is.
386 <column name=
"statistics" key=
"load_average">
387 A comma-separated list of three floating-point numbers,
388 representing the system load average over the last
1,
5, and
15
389 minutes, respectively.
392 <column name=
"statistics" key=
"memory">
394 A comma-separated list of integers, each of which represents a
395 quantity of memory in kilobytes that describes the operating
396 system on which Open vSwitch is running. In respective order,
401 <li>Total amount of RAM allocated to the OS.
</li>
402 <li>RAM allocated to the OS that is in use.
</li>
403 <li>RAM that can be flushed out to disk or otherwise discarded
404 if that space is needed for another purpose. This number is
405 necessarily less than or equal to the previous value.
</li>
406 <li>Total disk space allocated for swap.
</li>
407 <li>Swap space currently in use.
</li>
411 On Linux, all five values can be determined and are included. On
412 other operating systems, only the first two values can be
413 determined, so the list will only have two values.
417 <column name=
"statistics" key=
"process_NAME">
419 One such key-value pair, with
<code>NAME
</code> replaced by
420 a process name, will exist for each running Open vSwitch
421 daemon process, with
<var>name
</var> replaced by the
422 daemon's name (e.g.
<code>process_ovs-vswitchd
</code>). The
423 value is a comma-separated list of integers. The integers
424 represent the following, with memory measured in kilobytes
425 and durations in milliseconds:
429 <li>The process's virtual memory size.
</li>
430 <li>The process's resident set size.
</li>
431 <li>The amount of user and system CPU time consumed by the
433 <li>The number of times that the process has crashed and been
434 automatically restarted by the monitor.
</li>
435 <li>The duration since the process was started.
</li>
436 <li>The duration for which the process has been running.
</li>
440 The interpretation of some of these values depends on whether the
441 process was started with the
<option>--monitor
</option>. If it
442 was not, then the crash count will always be
0 and the two
443 durations will always be the same. If
<option>--monitor
</option>
444 was given, then the crash count may be positive; if it is, the
445 latter duration is the amount of time since the most recent crash
450 There will be one key-value pair for each file in Open vSwitch's
451 ``run directory'' (usually
<code>/var/run/openvswitch
</code>)
452 whose name ends in
<code>.pid
</code>, whose contents are a
453 process ID, and which is locked by a running process. The
454 <var>name
</var> is taken from the pidfile's name.
458 Currently Open vSwitch is only able to obtain all of the above
459 detail on Linux systems. On other systems, the same key-value
460 pairs will be present but the values will always be the empty
465 <column name=
"statistics" key=
"file_systems">
467 A space-separated list of information on local, writable file
468 systems. Each item in the list describes one file system and
469 consists in turn of a comma-separated list of the following:
473 <li>Mount point, e.g.
<code>/
</code> or
<code>/var/log
</code>.
474 Any spaces or commas in the mount point are replaced by
476 <li>Total size, in kilobytes, as an integer.
</li>
477 <li>Amount of storage in use, in kilobytes, as an integer.
</li>
481 This key-value pair is omitted if there are no local, writable
482 file systems or if Open vSwitch cannot obtain the needed
489 <group title=
"Version Reporting">
491 These columns report the types and versions of the hardware and
492 software running Open vSwitch. We recommend in general that software
493 should test whether specific features are supported instead of relying
494 on version number checks. These values are primarily intended for
495 reporting to human administrators.
498 <column name=
"ovs_version">
499 The Open vSwitch version number, e.g.
<code>1.1.0</code>.
502 <column name=
"db_version">
504 The database schema version number, e.g.
<code>1.2.3</code>. See
505 ovsdb-tool(
1) for an explanation of the numbering scheme.
509 The schema version is part of the database schema, so it can also be
510 retrieved by fetching the schema using the Open vSwitch database
515 <column name=
"system_type">
517 An identifier for the type of system on top of which Open vSwitch
518 runs, e.g.
<code>XenServer
</code> or
<code>KVM
</code>.
521 System integrators are responsible for choosing and setting an
522 appropriate value for this column.
526 <column name=
"system_version">
528 The version of the system identified by
<ref column=
"system_type"/>,
529 e.g.
<code>5.6.100-
39265p
</code> on XenServer
5.6.100 build
39265.
532 System integrators are responsible for choosing and setting an
533 appropriate value for this column.
539 <group title=
"Capabilities">
541 These columns report capabilities of the Open vSwitch instance.
543 <column name=
"datapath_types">
545 This column reports the different dpifs registered with the system.
546 These are the values that this instance supports in the
<ref
547 column=
"datapath_type" table=
"Bridge"/> column of the
<ref
548 table=
"Bridge"/> table.
551 <column name=
"iface_types">
553 This column reports the different netdevs registered with the system.
554 These are the values that this instance supports in the
<ref
555 column=
"type" table=
"Interface"/> column of the
<ref
556 table=
"Interface"/> table.
561 <group title=
"Database Configuration">
563 These columns primarily configure the Open vSwitch database
564 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
565 (
<code>ovs-vswitchd
</code>). The OVSDB database also uses the
<ref
566 column=
"ssl"/> settings.
570 The Open vSwitch switch does read the database configuration to
571 determine remote IP addresses to which in-band control should apply.
574 <column name=
"manager_options">
575 Database clients to which the Open vSwitch database server should
576 connect or to which it should listen, along with options for how these
577 connection should be configured. See the
<ref table=
"Manager"/> table
578 for more information.
582 <group title=
"Common Columns">
583 The overall purpose of these columns is described under
<code>Common
584 Columns
</code> at the beginning of this document.
586 <column name=
"other_config"/>
587 <column name=
"external_ids"/>
591 <table name=
"Bridge">
593 Configuration for a bridge within an
594 <ref table=
"Open_vSwitch"/>.
597 A
<ref table=
"Bridge"/> record represents an Ethernet switch with one or
598 more ``ports,'' which are the
<ref table=
"Port"/> records pointed to by
599 the
<ref table=
"Bridge"/>'s
<ref column=
"ports"/> column.
602 <group title=
"Core Features">
605 Bridge identifier. Must be unique among the names of ports,
606 interfaces, and bridges on a host.
610 The name must be alphanumeric and must not contain forward or
611 backward slashes. The name of a bridge is also the name of an
<ref
612 table=
"Interface"/> (and a
<ref table=
"Port"/>) within the bridge, so
613 the restrictions on the
<ref table=
"Interface" column=
"name"/> column
614 in the
<ref table=
"Interface"/> table, particularly on length, also
615 apply to bridge names. Refer to the documentation for
<ref
616 table=
"Interface"/> names for details.
620 <column name=
"ports">
621 Ports included in the bridge.
624 <column name=
"mirrors">
625 Port mirroring configuration.
628 <column name=
"netflow">
629 NetFlow configuration.
632 <column name=
"sflow">
633 sFlow(R) configuration.
636 <column name=
"ipfix">
640 <column name=
"flood_vlans">
642 VLAN IDs of VLANs on which MAC address learning should be disabled,
643 so that packets are flooded instead of being sent to specific ports
644 that are believed to contain packets' destination MACs. This should
645 ordinarily be used to disable MAC learning on VLANs used for
646 mirroring (RSPAN VLANs). It may also be useful for debugging.
649 SLB bonding (see the
<ref table=
"Port" column=
"bond_mode"/> column in
650 the
<ref table=
"Port"/> table) is incompatible with
651 <code>flood_vlans
</code>. Consider using another bonding mode or
652 a different type of mirror instead.
656 <column name=
"auto_attach">
657 Auto Attach configuration.
661 <group title=
"OpenFlow Configuration">
662 <column name=
"controller">
664 OpenFlow controller set. If unset, then no OpenFlow controllers
669 If there are primary controllers, removing all of them clears the
670 flow table. If there are no primary controllers, adding one also
671 clears the flow table. Other changes to the set of controllers, such
672 as adding or removing a service controller, adding another primary
673 controller to supplement an existing primary controller, or removing
674 only one of two primary controllers, have no effect on the flow
679 <column name=
"flow_tables">
680 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
681 table ID to configuration for that table.
684 <column name=
"fail_mode">
685 <p>When a controller is configured, it is, ordinarily, responsible
686 for setting up all flows on the switch. Thus, if the connection to
687 the controller fails, no new network connections can be set up.
688 If the connection to the controller stays down long enough,
689 no packets can pass through the switch at all. This setting
690 determines the switch's response to such a situation. It may be set
691 to one of the following:
693 <dt><code>standalone
</code></dt>
694 <dd>If no message is received from the controller for three
695 times the inactivity probe interval
696 (see
<ref column=
"inactivity_probe"/>), then Open vSwitch
697 will take over responsibility for setting up flows. In
698 this mode, Open vSwitch causes the bridge to act like an
699 ordinary MAC-learning switch. Open vSwitch will continue
700 to retry connecting to the controller in the background
701 and, when the connection succeeds, it will discontinue its
702 standalone behavior.
</dd>
703 <dt><code>secure
</code></dt>
704 <dd>Open vSwitch will not set up flows on its own when the
705 controller connection fails or when no controllers are
706 defined. The bridge will continue to retry connecting to
707 any defined controllers forever.
</dd>
711 The default is
<code>standalone
</code> if the value is unset, but
712 future versions of Open vSwitch may change the default.
715 The
<code>standalone
</code> mode can create forwarding loops on a
716 bridge that has more than one uplink port unless STP is enabled. To
717 avoid loops on such a bridge, configure
<code>secure
</code> mode or
718 enable STP (see
<ref column=
"stp_enable"/>).
720 <p>When more than one controller is configured,
721 <ref column=
"fail_mode"/> is considered only when none of the
722 configured controllers can be contacted.
</p>
724 Changing
<ref column=
"fail_mode"/> when no primary controllers are
725 configured clears the flow table.
729 <column name=
"datapath_id">
730 Reports the OpenFlow datapath ID in use. Exactly
16 hex digits.
731 (Setting this column has no useful effect. Set
<ref
732 column=
"other-config" key=
"datapath-id"/> instead.)
735 <column name=
"datapath_version">
737 Reports the version number of the Open vSwitch datapath in use.
738 This allows management software to detect and report discrepancies
739 between Open vSwitch userspace and datapath versions. (The
<ref
740 column=
"ovs_version" table=
"Open_vSwitch"/> column in the
<ref
741 table=
"Open_vSwitch"/> reports the Open vSwitch userspace version.)
742 The version reported depends on the datapath in use:
747 When the kernel module included in the Open vSwitch source tree is
748 used, this column reports the Open vSwitch version from which the
753 When the kernel module that is part of the upstream Linux kernel is
754 used, this column reports
<code><unknown
></code>.
758 When the datapath is built into the
<code>ovs-vswitchd
</code>
759 binary, this column reports
<code><built-in
></code>. A
760 built-in datapath is by definition the same version as the rest of
761 the Open VSwitch userspace.
765 Other datapaths (such as the Hyper-V kernel datapath) currently
766 report
<code><unknown
></code>.
771 A version discrepancy between
<code>ovs-vswitchd
</code> and the
772 datapath in use is not normally cause for alarm. The Open vSwitch
773 kernel datapaths for Linux and Hyper-V, in particular, are designed
774 for maximum inter-version compatibility: any userspace version works
775 with with any kernel version. Some reasons do exist to insist on
776 particular user/kernel pairings. First, newer kernel versions add
777 new features, that can only be used by new-enough userspace, e.g.
778 VXLAN tunneling requires certain minimal userspace and kernel
779 versions. Second, as an extension to the first reason, some newer
780 kernel versions add new features for enhancing performance that only
781 new-enough userspace versions can take advantage of.
785 <column name=
"other_config" key=
"datapath-id">
786 Exactly
16 hex digits to set the OpenFlow datapath ID to a specific
787 value. May not be all-zero.
790 <column name=
"other_config" key=
"dp-desc">
791 Human readable description of datapath. It it a maximum
256
792 byte-long free-form string to describe the datapath for
793 debugging purposes, e.g.
<code>switch3 in room
3120</code>.
796 <column name=
"other_config" key=
"disable-in-band"
797 type='{
"type":
"boolean"}'
>
798 If set to
<code>true
</code>, disable in-band control on the bridge
799 regardless of controller and manager settings.
802 <column name=
"other_config" key=
"in-band-queue"
803 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
804 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
805 that will be used by flows set up by in-band control on this bridge.
806 If unset, or if the port used by an in-band control flow does not have
807 QoS configured, or if the port does not have a queue with the specified
808 ID, the default queue is used instead.
811 <column name=
"protocols">
813 List of OpenFlow protocols that may be used when negotiating
814 a connection with a controller. OpenFlow
1.0,
1.1,
1.2, and
815 1.3 are enabled by default if this column is empty.
819 OpenFlow
1.4,
1.5, and
1.6 are not enabled by default because their
820 implementations are missing features. In addition, the OpenFlow
1.6
821 specification is still under development and thus subject to change.
826 <group title=
"Spanning Tree Configuration">
828 The IEEE
802.1D Spanning Tree Protocol (STP) is a network protocol
829 that ensures loop-free topologies. It allows redundant links to
830 be included in the network to provide automatic backup paths if
831 the active links fails.
835 These settings configure the slower-to-converge but still widely
836 supported version of Spanning Tree Protocol, sometimes known as
837 802.1D-
1998. Open vSwitch also supports the newer Rapid Spanning Tree
838 Protocol (RSTP), documented later in the section titled
<code>Rapid
839 Spanning Tree Configuration
</code>.
842 <group title=
"STP Configuration">
843 <column name=
"stp_enable" type='{
"type":
"boolean"}'
>
845 Enable spanning tree on the bridge. By default, STP is disabled
846 on bridges. Bond, internal, and mirror ports are not supported
847 and will not participate in the spanning tree.
851 STP and RSTP are mutually exclusive. If both are enabled, RSTP
856 <column name=
"other_config" key=
"stp-system-id">
857 The bridge's STP identifier (the lower
48 bits of the bridge-id)
859 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
860 By default, the identifier is the MAC address of the bridge.
863 <column name=
"other_config" key=
"stp-priority"
864 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
865 The bridge's relative priority value for determining the root
866 bridge (the upper
16 bits of the bridge-id). A bridge with the
867 lowest bridge-id is elected the root. By default, the priority
871 <column name=
"other_config" key=
"stp-hello-time"
872 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
873 The interval between transmissions of hello messages by
874 designated ports, in seconds. By default the hello interval is
878 <column name=
"other_config" key=
"stp-max-age"
879 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
880 The maximum age of the information transmitted by the bridge
881 when it is the root bridge, in seconds. By default, the maximum
885 <column name=
"other_config" key=
"stp-forward-delay"
886 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
887 The delay to wait between transitioning root and designated
888 ports to
<code>forwarding
</code>, in seconds. By default, the
889 forwarding delay is
15 seconds.
892 <column name=
"other_config" key=
"mcast-snooping-aging-time"
893 type='{
"type":
"integer",
"minInteger":
1}'
>
895 The maximum number of seconds to retain a multicast snooping entry for
896 which no packets have been seen. The default is currently
300
897 seconds (
5 minutes). The value, if specified, is forced into a
898 reasonable range, currently
15 to
3600 seconds.
902 <column name=
"other_config" key=
"mcast-snooping-table-size"
903 type='{
"type":
"integer",
"minInteger":
1}'
>
905 The maximum number of multicast snooping addresses to learn. The
906 default is currently
2048. The value, if specified, is forced into
907 a reasonable range, currently
10 to
1,
000,
000.
910 <column name=
"other_config" key=
"mcast-snooping-disable-flood-unregistered"
911 type='{
"type":
"boolean"}'
>
913 If set to
<code>false
</code>, unregistered multicast packets are forwarded
915 If set to
<code>true
</code>, unregistered multicast packets are forwarded
916 to ports connected to multicast routers.
921 <group title=
"STP Status">
923 These key-value pairs report the status of
802.1D-
1998. They are
924 present only if STP is enabled (via the
<ref column=
"stp_enable"/>
927 <column name=
"status" key=
"stp_bridge_id">
928 The bridge ID used in spanning tree advertisements, in the form
929 <var>xxxx
</var>.
<var>yyyyyyyyyyyy
</var> where the
<var>x
</var>s are
930 the STP priority, the
<var>y
</var>s are the STP system ID, and each
931 <var>x
</var> and
<var>y
</var> is a hex digit.
933 <column name=
"status" key=
"stp_designated_root">
934 The designated root for this spanning tree, in the same form as
<ref
935 column=
"status" key=
"stp_bridge_id"/>. If this bridge is the root,
936 this will have the same value as
<ref column=
"status"
937 key=
"stp_bridge_id"/>, otherwise it will differ.
939 <column name=
"status" key=
"stp_root_path_cost">
940 The path cost of reaching the designated bridge. A lower number is
941 better. The value is
0 if this bridge is the root, otherwise it is
947 <group title=
"Rapid Spanning Tree">
949 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
950 that ensures loop-free topologies. RSTP superseded STP with the
951 publication of
802.1D-
2004. Compared to STP, RSTP converges more
952 quickly and recovers more quickly from failures.
955 <group title=
"RSTP Configuration">
956 <column name=
"rstp_enable" type='{
"type":
"boolean"}'
>
958 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
959 on bridges. Bond, internal, and mirror ports are not supported
960 and will not participate in the spanning tree.
964 STP and RSTP are mutually exclusive. If both are enabled, RSTP
969 <column name=
"other_config" key=
"rstp-address">
970 The bridge's RSTP address (the lower
48 bits of the bridge-id)
972 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
973 By default, the address is the MAC address of the bridge.
976 <column name=
"other_config" key=
"rstp-priority"
977 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
61440}'
>
978 The bridge's relative priority value for determining the root
979 bridge (the upper
16 bits of the bridge-id). A bridge with the
980 lowest bridge-id is elected the root. By default, the priority
981 is
0x8000 (
32768). This value needs to be a multiple of
4096,
982 otherwise it's rounded to the nearest inferior one.
985 <column name=
"other_config" key=
"rstp-ageing-time"
986 type='{
"type":
"integer",
"minInteger":
10,
"maxInteger":
1000000}'
>
987 The Ageing Time parameter for the Bridge. The default value
991 <column name=
"other_config" key=
"rstp-force-protocol-version"
992 type='{
"type":
"integer"}'
>
993 The Force Protocol Version parameter for the Bridge. This
994 can take the value
0 (STP Compatibility mode) or
2
995 (the default, normal operation).
998 <column name=
"other_config" key=
"rstp-max-age"
999 type='{
"type":
"integer",
"minInteger":
6,
"maxInteger":
40}'
>
1000 The maximum age of the information transmitted by the Bridge
1001 when it is the Root Bridge. The default value is
20.
1004 <column name=
"other_config" key=
"rstp-forward-delay"
1005 type='{
"type":
"integer",
"minInteger":
4,
"maxInteger":
30}'
>
1006 The delay used by STP Bridges to transition Root and Designated
1007 Ports to Forwarding. The default value is
15.
1010 <column name=
"other_config" key=
"rstp-transmit-hold-count"
1011 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
10}'
>
1012 The Transmit Hold Count used by the Port Transmit state machine
1013 to limit transmission rate. The default value is
6.
1017 <group title=
"RSTP Status">
1019 These key-value pairs report the status of
802.1D-
2004. They are
1020 present only if RSTP is enabled (via the
<ref column=
"rstp_enable"/>
1023 <column name=
"rstp_status" key=
"rstp_bridge_id">
1024 The bridge ID used in rapid spanning tree advertisements, in the form
1025 <var>x
</var>.
<var>yyy
</var>.
<var>zzzzzzzzzzzz
</var> where
1026 <var>x
</var> is the RSTP priority, the
<var>y
</var>s are a locally
1027 assigned system ID extension, the
<var>z
</var>s are the STP system
1028 ID, and each
<var>x
</var>,
<var>y
</var>, or
<var>z
</var> is a hex
1031 <column name=
"rstp_status" key=
"rstp_root_id">
1032 The root of this spanning tree, in the same form as
<ref
1033 column=
"rstp_status" key=
"rstp_bridge_id"/>. If this bridge is the
1034 root, this will have the same value as
<ref column=
"rstp_status"
1035 key=
"rstp_bridge_id"/>, otherwise it will differ.
1037 <column name=
"rstp_status" key=
"rstp_root_path_cost"
1038 type='{
"type":
"integer",
"minInteger":
0}'
>
1039 The path cost of reaching the root. A lower number is better. The
1040 value is
0 if this bridge is the root, otherwise it is higher.
1042 <column name=
"rstp_status" key=
"rstp_designated_id">
1043 The RSTP designated ID, in the same form as
<ref column=
"rstp_status"
1044 key=
"rstp_bridge_id"/>.
1046 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1047 The RSTP designated port ID, as a
4-digit hex number.
1049 <column name=
"rstp_status" key=
"rstp_bridge_port_id">
1050 The RSTP bridge port ID, as a
4-digit hex number.
1055 <group title=
"Multicast Snooping Configuration">
1056 Multicast snooping (RFC
4541) monitors the Internet Group Management
1057 Protocol (IGMP) and Multicast Listener Discovery traffic between hosts
1058 and multicast routers. The switch uses what IGMP and MLD snooping
1059 learns to forward multicast traffic only to interfaces that are connected
1060 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
1061 MLDv1 and MLDv2 protocols.
1063 <column name=
"mcast_snooping_enable">
1064 Enable multicast snooping on the bridge. For now, the default
1069 <group title=
"Other Features">
1070 <column name=
"datapath_type">
1071 Name of datapath provider. The kernel datapath has type
1072 <code>system
</code>. The userspace datapath has type
1073 <code>netdev
</code>. A manager may refer to the
<ref
1074 table=
"Open_vSwitch" column=
"datapath_types"/> column of the
<ref
1075 table=
"Open_vSwitch"/> table for a list of the types accepted by this
1076 Open vSwitch instance.
1079 <column name=
"external_ids" key=
"bridge-id">
1080 A unique identifier of the bridge. On Citrix XenServer this will
1081 commonly be the same as
1082 <ref column=
"external_ids" key=
"xs-network-uuids"/>.
1085 <column name=
"external_ids" key=
"xs-network-uuids">
1086 Semicolon-delimited set of universally unique identifier(s) for the
1087 network with which this bridge is associated on a Citrix XenServer
1088 host. The network identifiers are RFC
4122 UUIDs as displayed by,
1089 e.g.,
<code>xe network-list
</code>.
1092 <column name=
"other_config" key=
"hwaddr">
1093 An Ethernet address in the form
1094 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
1095 to set the hardware address of the local port and influence the
1099 <column name=
"other_config" key=
"forward-bpdu"
1100 type='{
"type":
"boolean"}'
>
1103 Controls forwarding of BPDUs and other network control frames when
1104 NORMAL action is invoked. When this option is
<code>false
</code> or
1105 unset, frames with reserved Ethernet addresses (see table below) will
1106 not be forwarded. When this option is
<code>true
</code>, such frames
1107 will not be treated specially.
1111 The above general rule has the following exceptions:
1116 If STP is enabled on the bridge (see the
<ref column=
"stp_enable"
1117 table=
"Bridge"/> column in the
<ref table=
"Bridge"/> table), the
1118 bridge processes all received STP packets and never passes them to
1119 OpenFlow or forwards them. This is true even if STP is disabled on
1124 If LLDP is enabled on an interface (see the
<ref column=
"lldp"
1125 table=
"Interface"/> column in the
<ref table=
"Interface"/> table),
1126 the interface processes received LLDP packets and never passes them
1127 to OpenFlow or forwards them.
1132 Set this option to
<code>true
</code> if the Open vSwitch bridge
1133 connects different Ethernet networks and is not configured to
1138 This option affects packets with the following destination MAC
1143 <dt><code>01:
80:c2:
00:
00:
00</code></dt>
1144 <dd>IEEE
802.1D Spanning Tree Protocol (STP).
</dd>
1146 <dt><code>01:
80:c2:
00:
00:
01</code></dt>
1147 <dd>IEEE Pause frame.
</dd>
1149 <dt><code>01:
80:c2:
00:
00:
0<var>x
</var></code></dt>
1150 <dd>Other reserved protocols.
</dd>
1152 <dt><code>00:e0:
2b:
00:
00:
00</code></dt>
1153 <dd>Extreme Discovery Protocol (EDP).
</dd>
1156 <code>00:e0:
2b:
00:
00:
04</code> and
<code>00:e0:
2b:
00:
00:
06</code>
1158 <dd>Ethernet Automatic Protection Switching (EAPS).
</dd>
1160 <dt><code>01:
00:
0c:cc:cc:cc
</code></dt>
1162 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1163 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1167 <dt><code>01:
00:
0c:cc:cc:cd
</code></dt>
1168 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.
</dd>
1170 <dt><code>01:
00:
0c:cd:cd:cd
</code></dt>
1171 <dd>Cisco STP Uplink Fast.
</dd>
1173 <dt><code>01:
00:
0c:
00:
00:
00</code></dt>
1174 <dd>Cisco Inter Switch Link.
</dd>
1176 <dt><code>01:
00:
0c:cc:cc:c
<var>x
</var></code></dt>
1181 <column name=
"other_config" key=
"mac-aging-time"
1182 type='{
"type":
"integer",
"minInteger":
1}'
>
1184 The maximum number of seconds to retain a MAC learning entry for
1185 which no packets have been seen. The default is currently
300
1186 seconds (
5 minutes). The value, if specified, is forced into a
1187 reasonable range, currently
15 to
3600 seconds.
1191 A short MAC aging time allows a network to more quickly detect that a
1192 host is no longer connected to a switch port. However, it also makes
1193 it more likely that packets will be flooded unnecessarily, when they
1194 are addressed to a connected host that rarely transmits packets. To
1195 reduce the incidence of unnecessary flooding, use a MAC aging time
1196 longer than the maximum interval at which a host will ordinarily
1201 <column name=
"other_config" key=
"mac-table-size"
1202 type='{
"type":
"integer",
"minInteger":
1}'
>
1204 The maximum number of MAC addresses to learn. The default is
1205 currently
2048. The value, if specified, is forced into a reasonable
1206 range, currently
10 to
1,
000,
000.
1211 <group title=
"Common Columns">
1212 The overall purpose of these columns is described under
<code>Common
1213 Columns
</code> at the beginning of this document.
1215 <column name=
"other_config"/>
1216 <column name=
"external_ids"/>
1220 <table name=
"Port" table=
"Port or bond configuration.">
1221 <p>A port within a
<ref table=
"Bridge"/>.
</p>
1222 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1223 <ref column=
"interfaces"/> column. Such a port logically
1224 corresponds to a port on a physical Ethernet switch. A port
1225 with more than one interface is a ``bonded port'' (see
1226 <ref group=
"Bonding Configuration"/>).
</p>
1227 <p>Some properties that one might think as belonging to a port are actually
1228 part of the port's
<ref table=
"Interface"/> members.
</p>
1230 <column name=
"name">
1231 Port name. For a non-bonded port, this should be the same as its
1232 interface's name. Port names must otherwise be unique among the names of
1233 ports, interfaces, and bridges on a host. Because port and interfaces
1234 names are usually the same, the restrictions on the
<ref
1235 table=
"Interface" column=
"name"/> column in the
<ref table=
"Interface"/>
1236 table, particularly on length, also apply to port names. Refer to the
1237 documentation for
<ref table=
"Interface"/> names for details.
1240 <column name=
"interfaces">
1241 The port's interfaces. If there is more than one, this is a
1245 <group title=
"VLAN Configuration">
1246 <p>Bridge ports support the following types of VLAN configuration:
</p>
1251 A trunk port carries packets on one or more specified VLANs
1252 specified in the
<ref column=
"trunks"/> column (often, on every
1253 VLAN). A packet that ingresses on a trunk port is in the VLAN
1254 specified in its
802.1Q header, or VLAN
0 if the packet has no
1255 802.1Q header. A packet that egresses through a trunk port will
1256 have an
802.1Q header if it has a nonzero VLAN ID.
1260 Any packet that ingresses on a trunk port tagged with a VLAN that
1261 the port does not trunk is dropped.
1268 An access port carries packets on exactly one VLAN specified in the
1269 <ref column=
"tag"/> column. Packets egressing on an access port
1270 have no
802.1Q header.
1274 Any packet with an
802.1Q header with a nonzero VLAN ID that
1275 ingresses on an access port is dropped, regardless of whether the
1276 VLAN ID in the header is the access port's VLAN ID.
1280 <dt>native-tagged
</dt>
1282 A native-tagged port resembles a trunk port, with the exception that
1283 a packet without an
802.1Q header that ingresses on a native-tagged
1284 port is in the ``native VLAN'' (specified in the
<ref column=
"tag"/>
1288 <dt>native-untagged
</dt>
1290 A native-untagged port resembles a native-tagged port, with the
1291 exception that a packet that egresses on a native-untagged port in
1292 the native VLAN will not have an
802.1Q header.
1296 A packet will only egress through bridge ports that carry the VLAN of
1297 the packet, as described by the rules above.
1300 <column name=
"vlan_mode">
1302 The VLAN mode of the port, as described above. When this column is
1303 empty, a default mode is selected as follows:
1307 If
<ref column=
"tag"/> contains a value, the port is an access
1308 port. The
<ref column=
"trunks"/> column should be empty.
1311 Otherwise, the port is a trunk port. The
<ref column=
"trunks"/>
1312 column value is honored if it is present.
1319 For an access port, the port's implicitly tagged VLAN. For a
1320 native-tagged or native-untagged port, the port's native VLAN. Must
1321 be empty if this is a trunk port.
1325 <column name=
"trunks">
1327 For a trunk, native-tagged, or native-untagged port, the
802.1Q VLAN
1328 or VLANs that this port trunks; if it is empty, then the port trunks
1329 all VLANs. Must be empty if this is an access port.
1332 A native-tagged or native-untagged port always trunks its native
1333 VLAN, regardless of whether
<ref column=
"trunks"/> includes that
1338 <column name=
"other_config" key=
"priority-tags"
1339 type='{
"type":
"boolean"}'
>
1341 An
802.1Q header contains two important pieces of information: a VLAN
1342 ID and a priority. A frame with a zero VLAN ID, called a
1343 ``priority-tagged'' frame, is supposed to be treated the same way as
1344 a frame without an
802.1Q header at all (except for the priority).
1348 However, some network elements ignore any frame that has
802.1Q
1349 header at all, even when the VLAN ID is zero. Therefore, by default
1350 Open vSwitch does not output priority-tagged frames, instead omitting
1351 the
802.1Q header entirely if the VLAN ID is zero. Set this key to
1352 <code>true
</code> to enable priority-tagged frames on a port.
1356 Regardless of this setting, Open vSwitch omits the
802.1Q header on
1357 output if both the VLAN ID and priority would be zero.
1361 All frames output to native-tagged ports have a nonzero VLAN ID, so
1362 this setting is not meaningful on native-tagged ports.
1367 <group title=
"Bonding Configuration">
1368 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1369 allows for load balancing and fail-over.
</p>
1372 The following types of bonding will work with any kind of upstream
1373 switch. On the upstream switch, do not configure the interfaces as a
1378 <dt><code>balance-slb
</code></dt>
1380 Balances flows among slaves based on source MAC address and output
1381 VLAN, with periodic rebalancing as traffic patterns change.
1384 <dt><code>active-backup
</code></dt>
1386 Assigns all flows to one slave, failing over to a backup slave when
1387 the active slave is disabled. This is the only bonding mode in which
1388 interfaces may be plugged into different upstream switches.
1393 The following modes require the upstream switch to support
802.3ad with
1394 successful LACP negotiation. If LACP negotiation fails and
1395 other-config:lacp-fallback-ab is true, then
<code>active-backup
</code>
1400 <dt><code>balance-tcp
</code></dt>
1402 Balances flows among slaves based on L2, L3, and L4 protocol
1403 information such as destination MAC address, IP address, and TCP
1408 <p>These columns apply only to bonded ports. Their values are
1409 otherwise ignored.
</p>
1411 <column name=
"bond_mode">
1412 <p>The type of bonding used for a bonded port. Defaults to
1413 <code>active-backup
</code> if unset.
1417 <column name=
"other_config" key=
"bond-hash-basis"
1418 type='{
"type":
"integer"}'
>
1419 An integer hashed along with flows when choosing output slaves in load
1420 balanced bonds. When changed, all flows will be assigned different
1421 hash values possibly causing slave selection decisions to change. Does
1422 not affect bonding modes which do not employ load balancing such as
1423 <code>active-backup
</code>.
1426 <group title=
"Link Failure Detection">
1428 An important part of link bonding is detecting that links are down so
1429 that they may be disabled. These settings determine how Open vSwitch
1430 detects link failure.
1433 <column name=
"other_config" key=
"bond-detect-mode"
1434 type='{
"type":
"string",
"enum": [
"set", [
"carrier",
"miimon"]]}'
>
1435 The means used to detect link failures. Defaults to
1436 <code>carrier
</code> which uses each interface's carrier to detect
1437 failures. When set to
<code>miimon
</code>, will check for failures
1438 by polling each interface's MII.
1441 <column name=
"other_config" key=
"bond-miimon-interval"
1442 type='{
"type":
"integer"}'
>
1443 The interval, in milliseconds, between successive attempts to poll
1444 each interface's MII. Relevant only when
<ref column=
"other_config"
1445 key=
"bond-detect-mode"/> is
<code>miimon
</code>.
1448 <column name=
"bond_updelay">
1450 The number of milliseconds for which the link must stay up on an
1451 interface before the interface is considered to be up. Specify
1452 <code>0</code> to enable the interface immediately.
1456 This setting is honored only when at least one bonded interface is
1457 already enabled. When no interfaces are enabled, then the first
1458 bond interface to come up is enabled immediately.
1462 <column name=
"bond_downdelay">
1463 The number of milliseconds for which the link must stay down on an
1464 interface before the interface is considered to be down. Specify
1465 <code>0</code> to disable the interface immediately.
1469 <group title=
"LACP Configuration">
1471 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1472 allows switches to automatically detect that they are connected by
1473 multiple links and aggregate across those links. These settings
1474 control LACP behavior.
1477 <column name=
"lacp">
1478 Configures LACP on this port. LACP allows directly connected
1479 switches to negotiate which links may be bonded. LACP may be enabled
1480 on non-bonded ports for the benefit of any switches they may be
1481 connected to.
<code>active
</code> ports are allowed to initiate LACP
1482 negotiations.
<code>passive
</code> ports are allowed to participate
1483 in LACP negotiations initiated by a remote switch, but not allowed to
1484 initiate such negotiations themselves. If LACP is enabled on a port
1485 whose partner switch does not support LACP, the bond will be
1486 disabled, unless other-config:lacp-fallback-ab is set to true.
1487 Defaults to
<code>off
</code> if unset.
1490 <column name=
"other_config" key=
"lacp-system-id">
1491 The LACP system ID of this
<ref table=
"Port"/>. The system ID of a
1492 LACP bond is used to identify itself to its partners. Must be a
1493 nonzero MAC address. Defaults to the bridge Ethernet address if
1497 <column name=
"other_config" key=
"lacp-system-priority"
1498 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
1499 The LACP system priority of this
<ref table=
"Port"/>. In LACP
1500 negotiations, link status decisions are made by the system with the
1501 numerically lower priority.
1504 <column name=
"other_config" key=
"lacp-time"
1505 type='{
"type":
"string",
"enum": [
"set", [
"fast",
"slow"]]}'
>
1507 The LACP timing which should be used on this
<ref table=
"Port"/>.
1508 By default
<code>slow
</code> is used. When configured to be
1509 <code>fast
</code> LACP heartbeats are requested at a rate of once
1510 per second causing connectivity problems to be detected more
1511 quickly. In
<code>slow
</code> mode, heartbeats are requested at a
1512 rate of once every
30 seconds.
1516 <column name=
"other_config" key=
"lacp-fallback-ab"
1517 type='{
"type":
"boolean"}'
>
1519 Determines the behavior of openvswitch bond in LACP mode. If
1520 the partner switch does not support LACP, setting this option
1521 to
<code>true
</code> allows openvswitch to fallback to
1522 active-backup. If the option is set to
<code>false
</code>, the
1523 bond will be disabled. In both the cases, once the partner switch
1524 is configured to LACP mode, the bond will use LACP.
1529 <group title=
"Rebalancing Configuration">
1531 These settings control behavior when a bond is in
1532 <code>balance-slb
</code> or
<code>balance-tcp
</code> mode.
1535 <column name=
"other_config" key=
"bond-rebalance-interval"
1536 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
10000}'
>
1537 For a load balanced bonded port, the number of milliseconds between
1538 successive attempts to rebalance the bond, that is, to move flows
1539 from one interface on the bond to another in an attempt to keep usage
1540 of each interface roughly equal. If zero, load balancing is disabled
1541 on the bond (link failure still cause flows to move). If
1542 less than
1000ms, the rebalance interval will be
1000ms.
1546 <column name=
"bond_fake_iface">
1547 For a bonded port, whether to create a fake internal interface with the
1548 name of the port. Use only for compatibility with legacy software that
1553 <group title=
"Spanning Tree Protocol">
1555 The configuration here is only meaningful, and the status is only
1556 populated, when
802.1D-
1998 Spanning Tree Protocol is enabled on the
1557 port's
<ref column=
"Bridge"/> with its
<ref column=
"stp_enable"/>
1561 <group title=
"STP Configuration">
1562 <column name=
"other_config" key=
"stp-enable"
1563 type='{
"type":
"boolean"}'
>
1564 When STP is enabled on a bridge, it is enabled by default on all of
1565 the bridge's ports except bond, internal, and mirror ports (which do
1566 not work with STP). If this column's value is
<code>false
</code>,
1567 STP is disabled on the port.
1570 <column name=
"other_config" key=
"stp-port-num"
1571 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
255}'
>
1572 The port number used for the lower
8 bits of the port-id. By
1573 default, the numbers will be assigned automatically. If any
1574 port's number is manually configured on a bridge, then they
1578 <column name=
"other_config" key=
"stp-port-priority"
1579 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
255}'
>
1580 The port's relative priority value for determining the root
1581 port (the upper
8 bits of the port-id). A port with a lower
1582 port-id will be chosen as the root port. By default, the
1586 <column name=
"other_config" key=
"stp-path-cost"
1587 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
65535}'
>
1588 Spanning tree path cost for the port. A lower number indicates
1589 a faster link. By default, the cost is based on the maximum
1594 <group title=
"STP Status">
1595 <column name=
"status" key=
"stp_port_id">
1596 The port ID used in spanning tree advertisements for this port, as
4
1597 hex digits. Configuring the port ID is described in the
1598 <code>stp-port-num
</code> and
<code>stp-port-priority
</code> keys of
1599 the
<code>other_config
</code> section earlier.
1601 <column name=
"status" key=
"stp_state"
1602 type='{
"type":
"string",
"enum": [
"set",
1603 [
"disabled",
"listening",
"learning",
1604 "forwarding",
"blocking"]]}'
>
1605 STP state of the port.
1607 <column name=
"status" key=
"stp_sec_in_state"
1608 type='{
"type":
"integer",
"minInteger":
0}'
>
1609 The amount of time this port has been in the current STP state, in
1612 <column name=
"status" key=
"stp_role"
1613 type='{
"type":
"string",
"enum": [
"set",
1614 [
"root",
"designated",
"alternate"]]}'
>
1615 STP role of the port.
1620 <group title=
"Rapid Spanning Tree Protocol">
1622 The configuration here is only meaningful, and the status and
1623 statistics are only populated, when
802.1D-
1998 Spanning Tree Protocol
1624 is enabled on the port's
<ref column=
"Bridge"/> with its
<ref
1625 column=
"stp_enable"/> column.
1628 <group title=
"RSTP Configuration">
1629 <column name=
"other_config" key=
"rstp-enable"
1630 type='{
"type":
"boolean"}'
>
1631 When RSTP is enabled on a bridge, it is enabled by default on all of
1632 the bridge's ports except bond, internal, and mirror ports (which do
1633 not work with RSTP). If this column's value is
<code>false
</code>,
1634 RSTP is disabled on the port.
1637 <column name=
"other_config" key=
"rstp-port-priority"
1638 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
240}'
>
1639 The port's relative priority value for determining the root port, in
1640 multiples of
16. By default, the port priority is
0x80 (
128). Any
1641 value in the lower
4 bits is rounded off. The significant upper
4
1642 bits become the upper
4 bits of the port-id. A port with the lowest
1643 port-id is elected as the root.
1646 <column name=
"other_config" key=
"rstp-port-num"
1647 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
1648 The local RSTP port number, used as the lower
12 bits of the port-id.
1649 By default the port numbers are assigned automatically, and typically
1650 may not correspond to the OpenFlow port numbers. A port with the
1651 lowest port-id is elected as the root.
1654 <column name=
"other_config" key=
"rstp-port-path-cost"
1655 type='{
"type":
"integer"}'
>
1656 The port path cost. The Port's contribution, when it is
1657 the Root Port, to the Root Path Cost for the Bridge. By default the
1658 cost is automatically calculated from the port's speed.
1661 <column name=
"other_config" key=
"rstp-port-admin-edge"
1662 type='{
"type":
"boolean"}'
>
1663 The admin edge port parameter for the Port. Default is
1667 <column name=
"other_config" key=
"rstp-port-auto-edge"
1668 type='{
"type":
"boolean"}'
>
1669 The auto edge port parameter for the Port. Default is
1673 <column name=
"other_config" key=
"rstp-port-mcheck"
1674 type='{
"type":
"boolean"}'
>
1676 The mcheck port parameter for the Port. Default is
1677 <code>false
</code>. May be set to force the Port Protocol
1678 Migration state machine to transmit RST BPDUs for a
1679 MigrateTime period, to test whether all STP Bridges on the
1680 attached LAN have been removed and the Port can continue to
1681 transmit RSTP BPDUs. Setting mcheck has no effect if the
1682 Bridge is operating in STP Compatibility mode.
1685 Changing the value from
<code>true
</code> to
1686 <code>false
</code> has no effect, but needs to be done if
1687 this behavior is to be triggered again by subsequently
1688 changing the value from
<code>false
</code> to
1694 <group title=
"RSTP Status">
1695 <column name=
"rstp_status" key=
"rstp_port_id">
1696 The port ID used in spanning tree advertisements for this port, as
4
1697 hex digits. Configuring the port ID is described in the
1698 <code>rstp-port-num
</code> and
<code>rstp-port-priority
</code> keys
1699 of the
<code>other_config
</code> section earlier.
1701 <column name=
"rstp_status" key=
"rstp_port_role"
1702 type='{
"type":
"string",
"enum": [
"set",
1703 [
"Root",
"Designated",
"Alternate",
"Backup",
"Disabled"]]}'
>
1704 RSTP role of the port.
1706 <column name=
"rstp_status" key=
"rstp_port_state"
1707 type='{
"type":
"string",
"enum": [
"set",
1708 [
"Disabled",
"Learning",
"Forwarding",
"Discarding"]]}'
>
1709 RSTP state of the port.
1711 <column name=
"rstp_status" key=
"rstp_designated_bridge_id">
1712 The port's RSTP designated bridge ID, in the same form as
<ref
1713 column=
"rstp_status" key=
"rstp_bridge_id"/> in the
<ref
1714 table=
"Bridge"/> table.
1716 <column name=
"rstp_status" key=
"rstp_designated_port_id">
1717 The port's RSTP designated port ID, as
4 hex digits.
1719 <column name=
"rstp_status" key=
"rstp_designated_path_cost"
1720 type='{
"type":
"integer"}'
>
1721 The port's RSTP designated path cost. Lower is better.
1725 <group title=
"RSTP Statistics">
1726 <column name=
"rstp_statistics" key=
"rstp_tx_count">
1727 Number of RSTP BPDUs transmitted through this port.
1729 <column name=
"rstp_statistics" key=
"rstp_rx_count">
1730 Number of valid RSTP BPDUs received by this port.
1732 <column name=
"rstp_statistics" key=
"rstp_error_count">
1733 Number of invalid RSTP BPDUs received by this port.
1735 <column name=
"rstp_statistics" key=
"rstp_uptime">
1736 The duration covered by the other RSTP statistics, in seconds.
1741 <group title=
"Multicast Snooping">
1742 <column name=
"other_config" key=
"mcast-snooping-flood"
1743 type='{
"type":
"boolean"}'
>
1745 If set to
<code>true
</code>, multicast packets (except Reports) are
1746 unconditionally forwarded to the specific port.
1749 <column name=
"other_config" key=
"mcast-snooping-flood-reports"
1750 type='{
"type":
"boolean"}'
>
1752 If set to
<code>true
</code>, multicast Reports are unconditionally
1753 forwarded to the specific port.
1758 <group title=
"Other Features">
1760 Quality of Service configuration for this port.
1764 The MAC address to use for this port for the purpose of choosing the
1765 bridge's MAC address. This column does not necessarily reflect the
1766 port's actual MAC address, nor will setting it change the port's actual
1770 <column name=
"fake_bridge">
1771 Does this port represent a sub-bridge for its tagged VLAN within the
1772 Bridge? See ovs-vsctl(
8) for more information.
1775 <column name=
"protected" type='{
"type":
"boolean"}'
>
1776 The protected ports feature allows certain ports to be designated as
1777 protected. Traffic between protected ports is blocked. Protected
1778 ports can send traffic to unprotected ports. Unprotected ports can
1779 send traffic to any port.
1783 <column name=
"external_ids" key=
"fake-bridge-id-*">
1784 External IDs for a fake bridge (see the
<ref column=
"fake_bridge"/>
1785 column) are defined by prefixing a
<ref table=
"Bridge"/> <ref
1786 table=
"Bridge" column=
"external_ids"/> key with
1787 <code>fake-bridge-
</code>,
1788 e.g.
<code>fake-bridge-xs-network-uuids
</code>.
1791 <column name=
"other_config" key=
"transient"
1792 type='{
"type":
"boolean"}'
>
1794 If set to
<code>true
</code>, the port will be removed when
1795 <code>ovs-ctl start --delete-transient-ports
</code> is used.
1800 <column name=
"bond_active_slave">
1801 For a bonded port, record the mac address of the current active slave.
1804 <group title=
"Port Statistics">
1806 Key-value pairs that report port statistics. The update period
1807 is controlled by
<ref column=
"other_config"
1808 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
1810 <group title=
"Statistics: STP transmit and receive counters">
1811 <column name=
"statistics" key=
"stp_tx_count">
1812 Number of STP BPDUs sent on this port by the spanning
1815 <column name=
"statistics" key=
"stp_rx_count">
1816 Number of STP BPDUs received on this port and accepted by the
1817 spanning tree library.
1819 <column name=
"statistics" key=
"stp_error_count">
1820 Number of bad STP BPDUs received on this port. Bad BPDUs
1821 include runt packets and those with an unexpected protocol ID.
1826 <group title=
"Common Columns">
1827 The overall purpose of these columns is described under
<code>Common
1828 Columns
</code> at the beginning of this document.
1830 <column name=
"other_config"/>
1831 <column name=
"external_ids"/>
1835 <table name=
"Interface" title=
"One physical network device in a Port.">
1836 An interface within a
<ref table=
"Port"/>.
1838 <group title=
"Core Features">
1839 <column name=
"name">
1841 Interface name. Should be alphanumeric. For non-bonded port, this
1842 should be the same as the port name. It must otherwise be unique
1843 among the names of ports, interfaces, and bridges on a host.
1847 The maximum length of an interface name depends on the underlying
1853 The names of interfaces implemented as Linux and BSD network
1854 devices, including interfaces with type
<code>internal
</code>,
1855 <code>tap
</code>, or
<code>system
</code> plus the different types
1856 of tunnel ports, are limited to
15 bytes. Windows limits these
1861 The names of patch ports are not used in the underlying datapath,
1862 so operating system restrictions do not apply. Thus, they may have
1868 Regardless of other restrictions, OpenFlow only supports
15-byte
1869 names, which means that
<code>ovs-ofctl
</code> and OpenFlow
1870 controllers will show names truncated to
15 bytes.
1874 <column name=
"ifindex">
1875 A positive interface index as defined for SNMP MIB-II in RFCs
1213 and
1876 2863, if the interface has one, otherwise
0. The ifindex is useful for
1877 seamless integration with protocols such as SNMP and sFlow.
1880 <column name=
"mac_in_use">
1881 The MAC address in use by this interface.
1885 <p>Ethernet address to set for this interface. If unset then the
1886 default MAC address is used:
</p>
1888 <li>For the local interface, the default is the lowest-numbered MAC
1889 address among the other bridge ports, either the value of the
1890 <ref table=
"Port" column=
"mac"/> in its
<ref table=
"Port"/> record,
1891 if set, or its actual MAC (for bonded ports, the MAC of its slave
1892 whose name is first in alphabetical order). Internal ports and
1893 bridge ports that are used as port mirroring destinations (see the
1894 <ref table=
"Mirror"/> table) are ignored.
</li>
1895 <li>For other internal interfaces, the default MAC is randomly
1897 <li>External interfaces typically have a MAC address associated with
1898 their hardware.
</li>
1900 <p>Some interfaces may not have a software-controllable MAC
1904 <column name=
"error">
1905 If the configuration of the port failed, as indicated by -
1 in
<ref
1906 column=
"ofport"/>, Open vSwitch sets this column to an error
1907 description in human readable form. Otherwise, Open vSwitch clears
1911 <group title=
"OpenFlow Port Number">
1913 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1914 port number for the new port. If the client that adds the port fills
1915 in
<ref column=
"ofport_request"/>, then Open vSwitch tries to use its
1916 value as the OpenFlow port number. Otherwise, or if the requested
1917 port number is already in use or cannot be used for another reason,
1918 Open vSwitch automatically assigns a free port number. Regardless of
1919 how the port number was obtained, Open vSwitch then reports in
<ref
1920 column=
"ofport"/> the port number actually assigned.
1924 Open vSwitch limits the port numbers that it automatically assigns to
1925 the range
1 through
32,
767, inclusive. Controllers therefore have
1926 free use of ports
32,
768 and up.
1929 <column name=
"ofport">
1931 OpenFlow port number for this interface. Open vSwitch sets this
1932 column's value, so other clients should treat it as read-only.
1935 The OpenFlow ``local'' port (
<code>OFPP_LOCAL
</code>) is
65,
534.
1936 The other valid port numbers are in the range
1 to
65,
279,
1937 inclusive. Value -
1 indicates an error adding the interface.
1941 <column name=
"ofport_request"
1942 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65279}'
>
1944 Requested OpenFlow port number for this interface.
1948 A client should ideally set this column's value in the same
1949 database transaction that it uses to create the interface. Open
1950 vSwitch version
2.1 and later will honor a later request for a
1951 specific port number, althuogh it might confuse some controllers:
1952 OpenFlow does not have a way to announce a port number change, so
1953 Open vSwitch represents it over OpenFlow as a port deletion
1954 followed immediately by a port addition.
1958 If
<ref column=
"ofport_request"/> is set or changed to some other
1959 port's automatically assigned port number, Open vSwitch chooses a
1960 new port number for the latter port.
1966 <group title=
"System-Specific Details">
1967 <column name=
"type">
1969 The interface type. The types supported by a particular instance of
1970 Open vSwitch are listed in the
<ref table=
"Open_vSwitch"
1971 column=
"iface_types"/> column in the
<ref table=
"Open_vSwitch"/>
1972 table. The following types are defined:
1976 <dt><code>system
</code></dt>
1977 <dd>An ordinary network device, e.g.
<code>eth0
</code> on Linux.
1978 Sometimes referred to as ``external interfaces'' since they are
1979 generally connected to hardware external to that on which the Open
1980 vSwitch is running. The empty string is a synonym for
1981 <code>system
</code>.
</dd>
1983 <dt><code>internal
</code></dt>
1984 <dd>A simulated network device that sends and receives traffic. An
1985 internal interface whose
<ref column=
"name"/> is the same as its
1986 bridge's
<ref table=
"Open_vSwitch" column=
"name"/> is called the
1987 ``local interface.'' It does not make sense to bond an internal
1988 interface, so the terms ``port'' and ``interface'' are often used
1989 imprecisely for internal interfaces.
</dd>
1991 <dt><code>tap
</code></dt>
1992 <dd>A TUN/TAP device managed by Open vSwitch.
</dd>
1994 <dt><code>geneve
</code></dt>
1996 An Ethernet over Geneve (
<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve
</code>)
1999 A description of how to match and set Geneve options can be found
2000 in the
<code>ovs-ofctl
</code> manual page.
2003 <dt><code>gre
</code></dt>
2005 An Ethernet over RFC
2890 Generic Routing Encapsulation over IPv4/IPv6
2009 <dt><code>vxlan
</code></dt>
2012 An Ethernet tunnel over the UDP-based VXLAN protocol described in
2016 Open vSwitch uses IANA-assigned UDP destination port
4789. The
2017 source port used for VXLAN traffic varies on a per-flow basis
2018 and is in the ephemeral port range.
2022 <dt><code>lisp
</code></dt>
2025 A layer
3 tunnel over the experimental, UDP-based Locator/ID
2026 Separation Protocol (RFC
6830).
2029 Only IPv4 and IPv6 packets are supported by the protocol, and
2030 they are sent and received without an Ethernet header. Traffic
2031 to/from LISP ports is expected to be configured explicitly, and
2032 the ports are not intended to participate in learning based
2033 switching. As such, they are always excluded from packet
2038 <dt><code>stt
</code></dt>
2040 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
2041 endpoints are in end-systems, as it utilizes the capabilities of
2042 standard network interface cards to improve performance. STT utilizes
2043 a TCP-like header inside the IP header. It is stateless, i.e., there is
2044 no TCP connection state of any kind associated with the tunnel. The
2045 TCP-like header is used to leverage the capabilities of existing
2046 network interface cards, but should not be interpreted as implying
2047 any sort of connection state between endpoints.
2048 Since the STT protocol does not engage in the usual TCP
3-way handshake,
2049 so it will have difficulty traversing stateful firewalls.
2050 The protocol is documented at
2051 https://tools.ietf.org/html/draft-davie-stt
2053 All traffic uses a default destination port of
7471.
2056 <dt><code>patch
</code></dt>
2058 A pair of virtual devices that act as a patch cable.
2061 <dt><code>null
</code></dt>
2062 <dd>An ignored interface. Deprecated and slated for removal in
2068 <group title=
"Tunnel Options">
2070 These options apply to interfaces with
<ref column=
"type"/> of
2071 <code>geneve
</code>,
<code>gre
</code>,
<code>vxlan
</code>,
2072 <code>lisp
</code> and
<code>stt
</code>.
2076 Each tunnel must be uniquely identified by the combination of
<ref
2077 column=
"type"/>,
<ref column=
"options" key=
"remote_ip"/>,
<ref
2078 column=
"options" key=
"local_ip"/>, and
<ref column=
"options"
2079 key=
"in_key"/>. If two ports are defined that are the same except one
2080 has an optional identifier and the other does not, the more specific
2081 one is matched first.
<ref column=
"options" key=
"in_key"/> is
2082 considered more specific than
<ref column=
"options" key=
"local_ip"/> if
2083 a port defines one and another port defines the other.
2086 <column name=
"options" key=
"remote_ip">
2087 <p>Required. The remote tunnel endpoint, one of:
</p>
2091 An IPv4 or IPv6 address (not a DNS name), e.g.
<code>192.168.0.123</code>.
2092 Only unicast endpoints are supported.
2095 The word
<code>flow
</code>. The tunnel accepts packets from any
2096 remote tunnel endpoint. To process only packets from a specific
2097 remote tunnel endpoint, the flow entries may match on the
2098 <code>tun_src
</code> or
<code>tun_ipv6_src
</code>field. When
2099 sending packets to a
<code>remote_ip=flow
</code> tunnel, the flow
2100 actions must explicitly set the
<code>tun_dst
</code> or
2101 <code>tun_ipv6_dst
</code> field to the IP address of the desired
2102 remote tunnel endpoint, e.g. with a
<code>set_field
</code> action.
2107 The remote tunnel endpoint for any packet received from a tunnel
2108 is available in the
<code>tun_src
</code> field for matching in the
2113 <column name=
"options" key=
"local_ip">
2115 Optional. The tunnel destination IP that received packets must
2116 match. Default is to match all addresses. If specified, may be one
2122 An IPv4/IPv6 address (not a DNS name), e.g.
<code>192.168.12.3</code>.
2125 The word
<code>flow
</code>. The tunnel accepts packets sent to any
2126 of the local IP addresses of the system running OVS. To process
2127 only packets sent to a specific IP address, the flow entries may
2128 match on the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code> field.
2129 When sending packets to a
<code>local_ip=flow
</code> tunnel, the flow
2130 actions may explicitly set the
<code>tun_src
</code> or
<code>tun_ipv6_src
</code>
2131 field to the desired IP address, e.g. with a
<code>set_field
</code> action.
2132 However, while routing the tunneled packet out, the local system may
2133 override the specified address with the local IP address configured for the
2134 outgoing system interface.
2137 This option is valid only for tunnels also configured with the
2138 <code>remote_ip=flow
</code> option.
2144 The tunnel destination IP address for any packet received from a
2145 tunnel is available in the
<code>tun_dst
</code> or
<code>tun_ipv6_dst
</code>
2146 field for matching in the flow table.
2150 <column name=
"options" key=
"in_key">
2151 <p>Optional. The key that received packets must contain, one of:
</p>
2155 <code>0</code>. The tunnel receives packets with no key or with a
2156 key of
0. This is equivalent to specifying no
<ref column=
"options"
2157 key=
"in_key"/> at all.
2160 A positive
24-bit (for Geneve, VXLAN, and LISP),
32-bit (for GRE)
2161 or
64-bit (for STT) number. The tunnel receives only
2162 packets with the specified key.
2165 The word
<code>flow
</code>. The tunnel accepts packets with any
2166 key. The key will be placed in the
<code>tun_id
</code> field for
2167 matching in the flow table. The
<code>ovs-ofctl
</code> manual page
2168 contains additional information about matching fields in OpenFlow
2177 <column name=
"options" key=
"out_key">
2178 <p>Optional. The key to be set on outgoing packets, one of:
</p>
2182 <code>0</code>. Packets sent through the tunnel will have no key.
2183 This is equivalent to specifying no
<ref column=
"options"
2184 key=
"out_key"/> at all.
2187 A positive
24-bit (for Geneve, VXLAN and LISP),
32-bit (for GRE) or
2188 64-bit (for STT) number. Packets sent through the tunnel
2189 will have the specified key.
2192 The word
<code>flow
</code>. Packets sent through the tunnel will
2193 have the key set using the
<code>set_tunnel
</code> Nicira OpenFlow
2194 vendor extension (
0 is used in the absence of an action). The
2195 <code>ovs-ofctl
</code> manual page contains additional information
2196 about the Nicira OpenFlow vendor extensions.
2201 <column name=
"options" key=
"key">
2202 Optional. Shorthand to set
<code>in_key
</code> and
2203 <code>out_key
</code> at the same time.
2206 <column name=
"options" key=
"tos">
2207 Optional. The value of the ToS bits to be set on the encapsulating
2208 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2209 zero. It may also be the word
<code>inherit
</code>, in which case
2210 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2211 (otherwise it will be
0). The ECN fields are always inherited.
2215 <column name=
"options" key=
"ttl">
2216 Optional. The TTL to be set on the encapsulating packet. It may also
2217 be the word
<code>inherit
</code>, in which case the TTL will be copied
2218 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2219 system default, typically
64). Default is the system default TTL.
2222 <column name=
"options" key=
"df_default"
2223 type='{
"type":
"boolean"}'
>
2224 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2225 outer headers to allow path MTU discovery. Default is enabled; set
2226 to
<code>false
</code> to disable.
2229 <column name=
"options" key=
"egress_pkt_mark">
2230 Optional. The pkt_mark to be set on the encapsulating packet. This
2231 option sets packet mark for the tunnel endpoint for all tunnel packets
2232 including tunnel monitoring.
2235 <group title=
"Tunnel Options: vxlan only">
2237 <column name=
"options" key=
"exts">
2238 <p>Optional. Comma separated list of optional VXLAN extensions to
2239 enable. The following extensions are supported:
</p>
2243 <code>gbp
</code>: VXLAN-GBP allows to transport the group policy
2244 context of a packet across the VXLAN tunnel to other network
2245 peers. See the description of
<code>tun_gbp_id
</code> and
2246 <code>tun_gbp_flags
</code> in
<code>ovs-fields
</code>(
7) for
2247 additional information.
2248 (
<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy
</code>)
2255 <group title=
"Tunnel Options: gre, geneve, and vxlan">
2257 <code>gre
</code>,
<code>geneve
</code>, and
2258 <code>vxlan
</code> interfaces support these options.
2261 <column name=
"options" key=
"csum" type='{
"type":
"boolean"}'
>
2263 Optional. Compute encapsulation header (either GRE or UDP)
2264 checksums on outgoing packets. Default is disabled, set to
2265 <code>true
</code> to enable. Checksums present on incoming
2266 packets will be validated regardless of this setting.
2270 When using the upstream Linux kernel module, computation of
2271 checksums for
<code>geneve
</code> and
<code>vxlan
</code> requires
2272 Linux kernel version
4.0 or higher.
<code>gre
</code> supports
2273 checksums for all versions of Open vSwitch that support GRE.
2274 The out of tree kernel module distributed as part of OVS
2275 can compute all tunnel checksums on any kernel version that it
2283 <group title=
"Patch Options">
2285 Only
<code>patch
</code> interfaces support these options.
2288 <column name=
"options" key=
"peer">
2289 The
<ref column=
"name"/> of the
<ref table=
"Interface"/> for the other
2290 side of the patch. The named
<ref table=
"Interface"/>'s own
2291 <code>peer
</code> option must specify this
<ref table=
"Interface"/>'s
2292 name. That is, the two patch interfaces must have reversed
<ref
2293 column=
"name"/> and
<code>peer
</code> values.
2297 <group title=
"PMD (Poll Mode Driver) Options">
2299 Only PMD netdevs support these options.
2302 <column name=
"options" key=
"n_rxq"
2303 type='{
"type":
"integer",
"minInteger":
1}'
>
2305 Specifies the maximum number of rx queues to be created for PMD
2306 netdev. If not specified or specified to
0, one rx queue will
2307 be created by default.
2308 Not supported by DPDK vHost interfaces.
2312 <column name=
"options" key=
"dpdk-devargs"
2313 type='{
"type":
"string"}'
>
2315 Specifies the PCI address associated with the port for physical
2316 devices, or the virtual driver to be used for the port when a virtual
2317 PMD is intended to be used. For the latter, the argument string
2318 typically takes the form of eth_
<driver_name
><x
> where
2319 'driver_name' is a valid virtual DPDK PMD driver name and where 'x'
2320 lies in the range of
0 to RTE_MAX_ETHPORTS-
1.
2321 Only supported by the dpdk port type.
2325 <column name=
"other_config" key=
"pmd-rxq-affinity">
2326 <p>Specifies mapping of RX queues of this interface to CPU cores.
</p>
2327 <p>Value should be set in the following form:
</p>
2329 <code>other_config:pmd-rxq-affinity=
<rxq-affinity-list
></code>
2335 <rxq-affinity-list
> ::= NULL |
<non-empty-list
>
2338 <non-empty-list
> ::=
<affinity-pair
> |
2339 <affinity-pair
> ,
<non-empty-list
>
2342 <affinity-pair
> ::=
<queue-id
> :
<core-id
>
2348 <column name=
"options" key=
"vhost-server-path"
2349 type='{
"type":
"string"}'
>
2351 The value specifies the path to the socket associated with a vHost
2352 User client mode device that has been or will be created by QEMU.
2353 Only supported by dpdkvhostuserclient interfaces.
2357 <column name=
"options" key=
"n_rxq_desc"
2358 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4096}'
>
2360 Specifies the rx queue size (number rx descriptors) for dpdk ports.
2361 The value must be a power of
2, less than
4096 and supported
2362 by the hardware of the device being configured.
2363 If not specified or an incorrect value is specified,
2048 rx
2364 descriptors will be used by default.
2368 <column name=
"options" key=
"n_txq_desc"
2369 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4096}'
>
2371 Specifies the tx queue size (number tx descriptors) for dpdk ports.
2372 The value must be a power of
2, less than
4096 and supported
2373 by the hardware of the device being configured.
2374 If not specified or an incorrect value is specified,
2048 tx
2375 descriptors will be used by default.
2382 The MTU (maximum transmission unit) is the largest amount of data
2383 that can fit into a single Ethernet frame. The standard Ethernet
2384 MTU is
1500 bytes. Some physical media and many kinds of virtual
2385 interfaces can be configured with higher MTUs.
2389 A client may change an interface MTU by filling in
2390 <ref column=
"mtu_request"/>. Open vSwitch then reports in
2391 <ref column=
"mtu"/> the currently configured value.
2396 The currently configured MTU for the interface.
2400 This column will be empty for an interface that does not
2401 have an MTU as, for example, some kinds of tunnels do not.
2405 Open vSwitch sets this column's value, so other clients should treat
2410 <column name=
"mtu_request"
2411 type='{
"type":
"integer",
"minInteger":
1}'
>
2413 Requested MTU (Maximum Transmission Unit) for the interface. A client
2414 can fill this column to change the MTU of an interface.
2418 RFC
791 requires every internet module to be able to forward a
2419 datagram of
68 octets without further fragmentation. The maximum
2420 size of an IP packet is
65535 bytes.
2424 If this is not set and if the interface has
<code>internal
</code>
2425 type, Open vSwitch will change the MTU to match the minimum of the
2426 other interfaces in the bridge.
2432 <group title=
"Interface Status">
2434 Status information about interfaces attached to bridges, updated every
2435 5 seconds. Not all interfaces have all of these properties; virtual
2436 interfaces don't have a link speed, for example. Non-applicable
2437 columns will have empty values.
2439 <column name=
"admin_state">
2441 The administrative state of the physical network link.
2445 <column name=
"link_state">
2447 The observed state of the physical network link. This is ordinarily
2448 the link's carrier status. If the interface's
<ref table=
"Port"/> is
2449 a bond configured for miimon monitoring, it is instead the network
2450 link's miimon status.
2454 <column name=
"link_resets">
2456 The number of times Open vSwitch has observed the
2457 <ref column=
"link_state"/> of this
<ref table=
"Interface"/> change.
2461 <column name=
"link_speed">
2463 The negotiated speed of the physical network link.
2464 Valid values are positive integers greater than
0.
2468 <column name=
"duplex">
2470 The duplex mode of the physical network link.
2474 <column name=
"lacp_current">
2475 Boolean value indicating LACP status for this interface. If true, this
2476 interface has current LACP information about its LACP partner. This
2477 information may be used to monitor the health of interfaces in a LACP
2478 enabled port. This column will be empty if LACP is not enabled.
2481 <column name=
"status">
2482 Key-value pairs that report port status. Supported status values are
2483 <ref column=
"type"/>-dependent; some interfaces may not have a valid
2484 <ref column=
"status" key=
"driver_name"/>, for example.
2487 <column name=
"status" key=
"driver_name">
2488 The name of the device driver controlling the network adapter.
2491 <column name=
"status" key=
"driver_version">
2492 The version string of the device driver controlling the network
2496 <column name=
"status" key=
"firmware_version">
2497 The version string of the network adapter's firmware, if available.
2500 <column name=
"status" key=
"source_ip">
2501 The source IP address used for an IPv4/IPv6 tunnel end-point, such as
2505 <column name=
"status" key=
"tunnel_egress_iface">
2506 Egress interface for tunnels. Currently only relevant for tunnels
2507 on Linux systems, this column will show the name of the interface
2508 which is responsible for routing traffic destined for the configured
2509 <ref column=
"options" key=
"remote_ip"/>. This could be an internal
2510 interface such as a bridge port.
2513 <column name=
"status" key=
"tunnel_egress_iface_carrier"
2514 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
2515 Whether carrier is detected on
<ref column=
"status"
2516 key=
"tunnel_egress_iface"/>.
2520 <group title=
"Statistics">
2522 Key-value pairs that report interface statistics. The current
2523 implementation updates these counters periodically. The update period
2524 is controlled by
<ref column=
"other_config"
2525 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
2526 Future implementations may update them when an interface is created,
2527 when they are queried (e.g. using an OVSDB
<code>select
</code>
2528 operation), and just before an interface is deleted due to virtual
2529 interface hot-unplug or VM shutdown, and perhaps at other times, but
2530 not on any regular periodic basis.
2533 These are the same statistics reported by OpenFlow in its
<code>struct
2534 ofp_port_stats
</code> structure. If an interface does not support a
2535 given statistic, then that pair is omitted.
2537 <group title=
"Statistics: Successful transmit and receive counters">
2538 <column name=
"statistics" key=
"rx_packets">
2539 Number of received packets.
2541 <column name=
"statistics" key=
"rx_bytes">
2542 Number of received bytes.
2544 <column name=
"statistics" key=
"tx_packets">
2545 Number of transmitted packets.
2547 <column name=
"statistics" key=
"tx_bytes">
2548 Number of transmitted bytes.
2551 <group title=
"Statistics: Receive errors">
2552 <column name=
"statistics" key=
"rx_dropped">
2553 Number of packets dropped by RX.
2555 <column name=
"statistics" key=
"rx_frame_err">
2556 Number of frame alignment errors.
2558 <column name=
"statistics" key=
"rx_over_err">
2559 Number of packets with RX overrun.
2561 <column name=
"statistics" key=
"rx_crc_err">
2562 Number of CRC errors.
2564 <column name=
"statistics" key=
"rx_errors">
2565 Total number of receive errors, greater than or equal to the sum of
2569 <group title=
"Statistics: Transmit errors">
2570 <column name=
"statistics" key=
"tx_dropped">
2571 Number of packets dropped by TX.
2573 <column name=
"statistics" key=
"collisions">
2574 Number of collisions.
2576 <column name=
"statistics" key=
"tx_errors">
2577 Total number of transmit errors, greater than or equal to the sum of
2583 <group title=
"Ingress Policing">
2585 These settings control ingress policing for packets received on this
2586 interface. On a physical interface, this limits the rate at which
2587 traffic is allowed into the system from the outside; on a virtual
2588 interface (one connected to a virtual machine), this limits the rate at
2589 which the VM is able to transmit.
2592 Policing is a simple form of quality-of-service that simply drops
2593 packets received in excess of the configured rate. Due to its
2594 simplicity, policing is usually less accurate and less effective than
2595 egress QoS (which is configured using the
<ref table=
"QoS"/> and
<ref
2596 table=
"Queue"/> tables).
2599 Policing is currently implemented on Linux and OVS with DPDK. Both
2600 implementations use a simple ``token bucket'' approach:
2604 The size of the bucket corresponds to
<ref
2605 column=
"ingress_policing_burst"/>. Initially the bucket is full.
2608 Whenever a packet is received, its size (converted to tokens) is
2609 compared to the number of tokens currently in the bucket. If the
2610 required number of tokens are available, they are removed and the
2611 packet is forwarded. Otherwise, the packet is dropped.
2614 Whenever it is not full, the bucket is refilled with tokens at the
2615 rate specified by
<ref column=
"ingress_policing_rate"/>.
2619 Policing interacts badly with some network protocols, and especially
2620 with fragmented IP packets. Suppose that there is enough network
2621 activity to keep the bucket nearly empty all the time. Then this token
2622 bucket algorithm will forward a single packet every so often, with the
2623 period depending on packet size and on the configured rate. All of the
2624 fragments of an IP packets are normally transmitted back-to-back, as a
2625 group. In such a situation, therefore, only one of these fragments
2626 will be forwarded and the rest will be dropped. IP does not provide
2627 any way for the intended recipient to ask for only the remaining
2628 fragments. In such a case there are two likely possibilities for what
2629 will happen next: either all of the fragments will eventually be
2630 retransmitted (as TCP will do), in which case the same problem will
2631 recur, or the sender will not realize that its packet has been dropped
2632 and data will simply be lost (as some UDP-based protocols will do).
2633 Either way, it is possible that no forward progress will ever occur.
2635 <column name=
"ingress_policing_rate">
2637 Maximum rate for data received on this interface, in kbps. Data
2638 received faster than this rate is dropped. Set to
<code>0</code>
2639 (the default) to disable policing.
2643 <column name=
"ingress_policing_burst">
2644 <p>Maximum burst size for data received on this interface, in kb. The
2645 default burst size if set to
<code>0</code> is
8000 kbit. This value
2646 has no effect if
<ref column=
"ingress_policing_rate"/>
2647 is
<code>0</code>.
</p>
2649 Specifying a larger burst size lets the algorithm be more forgiving,
2650 which is important for protocols like TCP that react severely to
2651 dropped packets. The burst size should be at least the size of the
2652 interface's MTU. Specifying a value that is numerically at least as
2653 large as
80% of
<ref column=
"ingress_policing_rate"/> helps TCP come
2654 closer to achieving the full rate.
2659 <group title=
"Bidirectional Forwarding Detection (BFD)">
2661 BFD, defined in RFC
5880 and RFC
5881, allows point-to-point
2662 detection of connectivity failures by occasional transmission of
2663 BFD control messages. Open vSwitch implements BFD to serve
2664 as a more popular and standards compliant alternative to CFM.
2668 BFD operates by regularly transmitting BFD control messages at a rate
2669 negotiated independently in each direction. Each endpoint specifies
2670 the rate at which it expects to receive control messages, and the rate
2671 at which it is willing to transmit them. Open vSwitch uses a detection
2672 multiplier of three, meaning that an endpoint signals a connectivity
2673 fault if three consecutive BFD control messages fail to arrive. In the
2674 case of a unidirectional connectivity issue, the system not receiving
2675 BFD control messages signals the problem to its peer in the messages it
2680 The Open vSwitch implementation of BFD aims to comply faithfully
2681 with RFC
5880 requirements. Open vSwitch does not implement the
2682 optional Authentication or ``Echo Mode'' features.
2685 <group title=
"BFD Configuration">
2687 A controller sets up key-value pairs in the
<ref column=
"bfd"/>
2688 column to enable and configure BFD.
2691 <column name=
"bfd" key=
"enable" type='{
"type":
"boolean"}'
>
2692 True to enable BFD on this
<ref table=
"Interface"/>. If not
2693 specified, BFD will not be enabled by default.
2696 <column name=
"bfd" key=
"min_rx"
2697 type='{
"type":
"integer",
"minInteger":
1}'
>
2698 The shortest interval, in milliseconds, at which this BFD session
2699 offers to receive BFD control messages. The remote endpoint may
2700 choose to send messages at a slower rate. Defaults to
2704 <column name=
"bfd" key=
"min_tx"
2705 type='{
"type":
"integer",
"minInteger":
1}'
>
2706 The shortest interval, in milliseconds, at which this BFD session is
2707 willing to transmit BFD control messages. Messages will actually be
2708 transmitted at a slower rate if the remote endpoint is not willing to
2709 receive as quickly as specified. Defaults to
<code>100</code>.
2712 <column name=
"bfd" key=
"decay_min_rx" type='{
"type":
"integer"}'
>
2713 An alternate receive interval, in milliseconds, that must be greater
2714 than or equal to
<ref column=
"bfd" key=
"min_rx"/>. The
2715 implementation switches from
<ref column=
"bfd" key=
"min_rx"/> to
<ref
2716 column=
"bfd" key=
"decay_min_rx"/> when there is no obvious incoming
2717 data traffic at the interface, to reduce the CPU and bandwidth cost
2718 of monitoring an idle interface. This feature may be disabled by
2719 setting a value of
0. This feature is reset whenever
<ref
2720 column=
"bfd" key=
"decay_min_rx"/> or
<ref column=
"bfd" key=
"min_rx"/>
2724 <column name=
"bfd" key=
"forwarding_if_rx" type='{
"type":
"boolean"}'
>
2725 When
<code>true
</code>, traffic received on the
2726 <ref table=
"Interface"/> is used to indicate the capability of packet
2727 I/O. BFD control packets are still transmitted and received. At
2728 least one BFD control packet must be received every
100 *
<ref
2729 column=
"bfd" key=
"min_rx"/> amount of time. Otherwise, even if
2730 traffic are received, the
<ref column=
"bfd" key=
"forwarding"/>
2731 will be
<code>false
</code>.
2734 <column name=
"bfd" key=
"cpath_down" type='{
"type":
"boolean"}'
>
2735 Set to true to notify the remote endpoint that traffic should not be
2736 forwarded to this system for some reason other than a connectivty
2737 failure on the interface being monitored. The typical underlying
2738 reason is ``concatenated path down,'' that is, that connectivity
2739 beyond the local system is down. Defaults to false.
2742 <column name=
"bfd" key=
"check_tnl_key" type='{
"type":
"boolean"}'
>
2743 Set to true to make BFD accept only control messages with a tunnel
2744 key of zero. By default, BFD accepts control messages with any
2748 <column name=
"bfd" key=
"bfd_local_src_mac">
2749 Set to an Ethernet address in the form
2750 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2751 to set the MAC used as source for transmitted BFD packets. The
2752 default is the mac address of the BFD enabled interface.
2755 <column name=
"bfd" key=
"bfd_local_dst_mac">
2756 Set to an Ethernet address in the form
2757 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2758 to set the MAC used as destination for transmitted BFD packets. The
2759 default is
<code>00:
23:
20:
00:
00:
01</code>.
2762 <column name=
"bfd" key=
"bfd_remote_dst_mac">
2763 Set to an Ethernet address in the form
2764 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>
2765 to set the MAC used for checking the destination of received BFD packets.
2766 Packets with different destination MAC will not be considered as BFD packets.
2767 If not specified the destination MAC address of received BFD packets
2771 <column name=
"bfd" key=
"bfd_src_ip">
2772 Set to an IPv4 address to set the IP address used as source for
2773 transmitted BFD packets. The default is
<code>169.254.1.1</code>.
2776 <column name=
"bfd" key=
"bfd_dst_ip">
2777 Set to an IPv4 address to set the IP address used as destination
2778 for transmitted BFD packets. The default is
<code>169.254.1.0</code>.
2781 <column name=
"bfd" key=
"oam">
2782 Some tunnel protocols (such as Geneve) include a bit in the header
2783 to indicate that the encapsulated packet is an OAM frame. By setting
2784 this to true, BFD packets will be marked as OAM if encapsulated in
2785 one of these tunnels.
2789 <group title=
"BFD Status">
2791 The switch sets key-value pairs in the
<ref column=
"bfd_status"/>
2792 column to report the status of BFD on this interface. When BFD is
2793 not enabled, with
<ref column=
"bfd" key=
"enable"/>, the switch clears
2794 all key-value pairs from
<ref column=
"bfd_status"/>.
2797 <column name=
"bfd_status" key=
"state"
2798 type='{
"type":
"string",
2799 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
2800 Reports the state of the BFD session. The BFD session is fully
2801 healthy and negotiated if
<code>UP
</code>.
2804 <column name=
"bfd_status" key=
"forwarding" type='{
"type":
"boolean"}'
>
2805 Reports whether the BFD session believes this
<ref
2806 table=
"Interface"/> may be used to forward traffic. Typically this
2807 means the local session is signaling
<code>UP
</code>, and the remote
2808 system isn't signaling a problem such as concatenated path down.
2811 <column name=
"bfd_status" key=
"diagnostic">
2812 A diagnostic code specifying the local system's reason for the
2813 last change in session state. The error messages are defined in
2814 section
4.1 of [RFC
5880].
2817 <column name=
"bfd_status" key=
"remote_state"
2818 type='{
"type":
"string",
2819 "enum": [
"set", [
"admin_down",
"down",
"init",
"up"]]}'
>
2820 Reports the state of the remote endpoint's BFD session.
2823 <column name=
"bfd_status" key=
"remote_diagnostic">
2824 A diagnostic code specifying the remote system's reason for the
2825 last change in session state. The error messages are defined in
2826 section
4.1 of [RFC
5880].
2829 <column name=
"bfd_status" key=
"flap_count"
2830 type='{
"type":
"integer",
"minInteger":
0}'
>
2831 Counts the number of
<ref column=
"bfd_status" key=
"forwarding" />
2832 flaps since start. A flap is considered as a change of the
2833 <ref column=
"bfd_status" key=
"forwarding" /> value.
2838 <group title=
"Connectivity Fault Management">
2840 802.1ag Connectivity Fault Management (CFM) allows a group of
2841 Maintenance Points (MPs) called a Maintenance Association (MA) to
2842 detect connectivity problems with each other. MPs within a MA should
2843 have complete and exclusive interconnectivity. This is verified by
2844 occasionally broadcasting Continuity Check Messages (CCMs) at a
2845 configurable transmission interval.
2849 According to the
802.1ag specification, each Maintenance Point should
2850 be configured out-of-band with a list of Remote Maintenance Points it
2851 should have connectivity to. Open vSwitch differs from the
2852 specification in this area. It simply assumes the link is faulted if
2853 no Remote Maintenance Points are reachable, and considers it not
2858 When operating over tunnels which have no
<code>in_key
</code>, or an
2859 <code>in_key
</code> of
<code>flow
</code>. CFM will only accept CCMs
2860 with a tunnel key of zero.
2863 <column name=
"cfm_mpid">
2865 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2866 within a Maintenance Association. The MPID is used to identify this
2867 endpoint to other Maintenance Points in the MA. Each end of a link
2868 being monitored should have a different MPID. Must be configured to
2869 enable CFM on this
<ref table=
"Interface"/>.
2872 According to the
802.1ag specification, MPIDs can only range between
2873 [
1,
8191]. However, extended mode (see
<ref column=
"other_config"
2874 key=
"cfm_extended"/>) supports eight byte MPIDs.
2878 <column name=
"cfm_flap_count">
2879 Counts the number of cfm fault flapps since boot. A flap is
2880 considered to be a change of the
<ref column=
"cfm_fault"/> value.
2883 <column name=
"cfm_fault">
2885 Indicates a connectivity fault triggered by an inability to receive
2886 heartbeats from any remote endpoint. When a fault is triggered on
2887 <ref table=
"Interface"/>s participating in bonds, they will be
2891 Faults can be triggered for several reasons. Most importantly they
2892 are triggered when no CCMs are received for a period of
3.5 times the
2893 transmission interval. Faults are also triggered when any CCMs
2894 indicate that a Remote Maintenance Point is not receiving CCMs but
2895 able to send them. Finally, a fault is triggered if a CCM is
2896 received which indicates unexpected configuration. Notably, this
2897 case arises when a CCM is received which advertises the local MPID.
2901 <column name=
"cfm_fault_status" key=
"recv">
2902 Indicates a CFM fault was triggered due to a lack of CCMs received on
2903 the
<ref table=
"Interface"/>.
2906 <column name=
"cfm_fault_status" key=
"rdi">
2907 Indicates a CFM fault was triggered due to the reception of a CCM with
2908 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2909 are not receiving CCMs themselves. This typically indicates a
2910 unidirectional connectivity failure.
2913 <column name=
"cfm_fault_status" key=
"maid">
2914 Indicates a CFM fault was triggered due to the reception of a CCM with
2915 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2916 with an identification number in addition to the MPID called the MAID.
2917 Open vSwitch only supports receiving CCM broadcasts tagged with the
2918 MAID it uses internally.
2921 <column name=
"cfm_fault_status" key=
"loopback">
2922 Indicates a CFM fault was triggered due to the reception of a CCM
2923 advertising the same MPID configured in the
<ref column=
"cfm_mpid"/>
2924 column of this
<ref table=
"Interface"/>. This may indicate a loop in
2928 <column name=
"cfm_fault_status" key=
"overflow">
2929 Indicates a CFM fault was triggered because the CFM module received
2930 CCMs from more remote endpoints than it can keep track of.
2933 <column name=
"cfm_fault_status" key=
"override">
2934 Indicates a CFM fault was manually triggered by an administrator using
2935 an
<code>ovs-appctl
</code> command.
2938 <column name=
"cfm_fault_status" key=
"interval">
2939 Indicates a CFM fault was triggered due to the reception of a CCM
2940 frame having an invalid interval.
2943 <column name=
"cfm_remote_opstate">
2944 <p>When in extended mode, indicates the operational state of the
2945 remote endpoint as either
<code>up
</code> or
<code>down
</code>. See
2946 <ref column=
"other_config" key=
"cfm_opstate"/>.
2950 <column name=
"cfm_health">
2952 Indicates the health of the interface as a percentage of CCM frames
2953 received over
21 <ref column=
"other_config" key=
"cfm_interval"/>s.
2954 The health of an interface is undefined if it is communicating with
2955 more than one
<ref column=
"cfm_remote_mpids"/>. It reduces if
2956 healthy heartbeats are not received at the expected rate, and
2957 gradually improves as healthy heartbeats are received at the desired
2958 rate. Every
21 <ref column=
"other_config" key=
"cfm_interval"/>s, the
2959 health of the interface is refreshed.
2962 As mentioned above, the faults can be triggered for several reasons.
2963 The link health will deteriorate even if heartbeats are received but
2964 they are reported to be unhealthy. An unhealthy heartbeat in this
2965 context is a heartbeat for which either some fault is set or is out
2966 of sequence. The interface health can be
100 only on receiving
2967 healthy heartbeats at the desired rate.
2971 <column name=
"cfm_remote_mpids">
2972 When CFM is properly configured, Open vSwitch will occasionally
2973 receive CCM broadcasts. These broadcasts contain the MPID of the
2974 sending Maintenance Point. The list of MPIDs from which this
2975 <ref table=
"Interface"/> is receiving broadcasts from is regularly
2976 collected and written to this column.
2979 <column name=
"other_config" key=
"cfm_interval"
2980 type='{
"type":
"integer"}'
>
2982 The interval, in milliseconds, between transmissions of CFM
2983 heartbeats. Three missed heartbeat receptions indicate a
2988 In standard operation only intervals of
3,
10,
100,
1,
000,
10,
000,
2989 60,
000, or
600,
000 ms are supported. Other values will be rounded
2990 down to the nearest value on the list. Extended mode (see
<ref
2991 column=
"other_config" key=
"cfm_extended"/>) supports any interval up
2992 to
65,
535 ms. In either mode, the default is
1000 ms.
2995 <p>We do not recommend using intervals less than
100 ms.
</p>
2998 <column name=
"other_config" key=
"cfm_extended"
2999 type='{
"type":
"boolean"}'
>
3000 When
<code>true
</code>, the CFM module operates in extended mode. This
3001 causes it to use a nonstandard destination address to avoid conflicting
3002 with compliant implementations which may be running concurrently on the
3003 network. Furthermore, extended mode increases the accuracy of the
3004 <code>cfm_interval
</code> configuration parameter by breaking wire
3005 compatibility with
802.1ag compliant implementations. And extended
3006 mode allows eight byte MPIDs. Defaults to
<code>false
</code>.
3009 <column name=
"other_config" key=
"cfm_demand" type='{
"type":
"boolean"}'
>
3011 When
<code>true
</code>, and
3012 <ref column=
"other_config" key=
"cfm_extended"/> is true, the CFM
3013 module operates in demand mode. When in demand mode, traffic
3014 received on the
<ref table=
"Interface"/> is used to indicate
3015 liveness. CCMs are still transmitted and received. At least one
3016 CCM must be received every
100 *
<ref column=
"other_config"
3017 key=
"cfm_interval"/> amount of time. Otherwise, even if traffic
3018 are received, the CFM module will raise the connectivity fault.
3022 Demand mode has a couple of caveats:
3025 To ensure that ovs-vswitchd has enough time to pull statistics
3026 from the datapath, the fault detection interval is set to
3027 3.5 * MAX(
<ref column=
"other_config" key=
"cfm_interval"/>,
500)
3032 To avoid ambiguity, demand mode disables itself when there are
3033 multiple remote maintenance points.
3037 If the
<ref table=
"Interface"/> is heavily congested, CCMs
3038 containing the
<ref column=
"other_config" key=
"cfm_opstate"/>
3039 status may be dropped causing changes in the operational state to
3040 be delayed. Similarly, if CCMs containing the RDI bit are not
3041 received, unidirectional link failures may not be detected.
3047 <column name=
"other_config" key=
"cfm_opstate"
3048 type='{
"type":
"string",
"enum": [
"set", [
"down",
"up"]]}'
>
3049 When
<code>down
</code>, the CFM module marks all CCMs it generates as
3050 operationally down without triggering a fault. This allows remote
3051 maintenance points to choose not to forward traffic to the
3052 <ref table=
"Interface"/> on which this CFM module is running.
3053 Currently, in Open vSwitch, the opdown bit of CCMs affects
3054 <ref table=
"Interface"/>s participating in bonds, and the bundle
3055 OpenFlow action. This setting is ignored when CFM is not in extended
3056 mode. Defaults to
<code>up
</code>.
3059 <column name=
"other_config" key=
"cfm_ccm_vlan"
3060 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
4095}'
>
3061 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3062 with the given value. May be the string
<code>random
</code> in which
3063 case each CCM will be tagged with a different randomly generated VLAN.
3066 <column name=
"other_config" key=
"cfm_ccm_pcp"
3067 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
7}'
>
3068 When set, the CFM module will apply a VLAN tag to all CCMs it generates
3069 with the given PCP value, the VLAN ID of the tag is governed by the
3070 value of
<ref column=
"other_config" key=
"cfm_ccm_vlan"/>. If
3071 <ref column=
"other_config" key=
"cfm_ccm_vlan"/> is unset, a VLAN ID of
3077 <group title=
"Bonding Configuration">
3078 <column name=
"other_config" key=
"lacp-port-id"
3079 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3080 The LACP port ID of this
<ref table=
"Interface"/>. Port IDs are
3081 used in LACP negotiations to identify individual ports
3082 participating in a bond.
3085 <column name=
"other_config" key=
"lacp-port-priority"
3086 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3087 The LACP port priority of this
<ref table=
"Interface"/>. In LACP
3088 negotiations
<ref table=
"Interface"/>s with numerically lower
3089 priorities are preferred for aggregation.
3092 <column name=
"other_config" key=
"lacp-aggregation-key"
3093 type='{
"type":
"integer",
"minInteger":
1,
"maxInteger":
65535}'
>
3094 The LACP aggregation key of this
<ref table=
"Interface"/>.
<ref
3095 table=
"Interface"/>s with different aggregation keys may not be active
3096 within a given
<ref table=
"Port"/> at the same time.
3100 <group title=
"Virtual Machine Identifiers">
3102 These key-value pairs specifically apply to an interface that
3103 represents a virtual Ethernet interface connected to a virtual
3104 machine. These key-value pairs should not be present for other types
3105 of interfaces. Keys whose names end in
<code>-uuid
</code> have
3106 values that uniquely identify the entity in question. For a Citrix
3107 XenServer hypervisor, these values are UUIDs in RFC
4122 format.
3108 Other hypervisors may use other formats.
3111 <column name=
"external_ids" key=
"attached-mac">
3112 The MAC address programmed into the ``virtual hardware'' for this
3113 interface, in the form
3114 <var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>:
<var>xx
</var>.
3115 For Citrix XenServer, this is the value of the
<code>MAC
</code> field
3116 in the VIF record for this interface.
3119 <column name=
"external_ids" key=
"iface-id">
3120 A system-unique identifier for the interface. On XenServer, this will
3121 commonly be the same as
<ref column=
"external_ids" key=
"xs-vif-uuid"/>.
3124 <column name=
"external_ids" key=
"iface-status"
3125 type='{
"type":
"string",
3126 "enum": [
"set", [
"active",
"inactive"]]}'
>
3128 Hypervisors may sometimes have more than one interface associated
3129 with a given
<ref column=
"external_ids" key=
"iface-id"/>, only one of
3130 which is actually in use at a given time. For example, in some
3131 circumstances XenServer has both a ``tap'' and a ``vif'' interface
3132 for a single
<ref column=
"external_ids" key=
"iface-id"/>, but only
3133 uses one of them at a time. A hypervisor that behaves this way must
3134 mark the currently in use interface
<code>active
</code> and the
3135 others
<code>inactive
</code>. A hypervisor that never has more than
3136 one interface for a given
<ref column=
"external_ids" key=
"iface-id"/>
3137 may mark that interface
<code>active
</code> or omit
<ref
3138 column=
"external_ids" key=
"iface-status"/> entirely.
3142 During VM migration, a given
<ref column=
"external_ids"
3143 key=
"iface-id"/> might transiently be marked
<code>active
</code> on
3144 two different hypervisors. That is,
<code>active
</code> means that
3145 this
<ref column=
"external_ids" key=
"iface-id"/> is the active
3146 instance within a single hypervisor, not in a broader scope.
3147 There is one exception: some hypervisors support ``migration'' from a
3148 given hypervisor to itself (most often for test purposes). During
3149 such a ``migration,'' two instances of a single
<ref
3150 column=
"external_ids" key=
"iface-id"/> might both be briefly marked
3151 <code>active
</code> on a single hypervisor.
3155 <column name=
"external_ids" key=
"xs-vif-uuid">
3156 The virtual interface associated with this interface.
3159 <column name=
"external_ids" key=
"xs-network-uuid">
3160 The virtual network to which this interface is attached.
3163 <column name=
"external_ids" key=
"vm-id">
3164 The VM to which this interface belongs. On XenServer, this will be the
3165 same as
<ref column=
"external_ids" key=
"xs-vm-uuid"/>.
3168 <column name=
"external_ids" key=
"xs-vm-uuid">
3169 The VM to which this interface belongs.
3173 <group title=
"Auto Attach Configuration">
3175 Auto Attach configuration for a particular interface.
3178 <column name=
"lldp" key=
"enable" type='{
"type":
"boolean"}'
>
3179 True to enable LLDP on this
<ref table=
"Interface"/>. If not
3180 specified, LLDP will be disabled by default.
3184 <group title=
"Flow control Configuration">
3186 Ethernet flow control defined in IEEE
802.1Qbb provides link level flow
3187 control using MAC pause frames. Implemented only for interfaces with
3188 type
<code>dpdk
</code>.
3191 <column name=
"options" key=
"rx-flow-ctrl" type='{
"type":
"boolean"}'
>
3192 Set to
<code>true
</code> to enable Rx flow control on physical ports.
3193 By default, Rx flow control is disabled.
3196 <column name=
"options" key=
"tx-flow-ctrl" type='{
"type":
"boolean"}'
>
3197 Set to
<code>true
</code> to enable Tx flow control on physical ports.
3198 By default, Tx flow control is disabled.
3201 <column name=
"options" key=
"flow-ctrl-autoneg"
3202 type='{
"type":
"boolean"}'
>
3203 Set to
<code>true
</code> to enable flow control auto negotiation on
3204 physical ports. By default, auto-neg is disabled.
3208 <group title=
"Rx Checksum Offload Configuration">
3210 The checksum validation on the incoming packets are performed on NIC
3211 using Rx checksum offload feature. Implemented only for
<code>dpdk
3212 </code>physical interfaces.
3215 <column name=
"options" key=
"rx-checksum-offload"
3216 type='{
"type":
"boolean"}'
>
3217 Set to
<code>false
</code> to disble Rx checksum offloading on
<code>
3218 dpdk
</code>physical ports. By default, Rx checksum offload is enabled.
3222 <group title=
"Common Columns">
3223 The overall purpose of these columns is described under
<code>Common
3224 Columns
</code> at the beginning of this document.
3226 <column name=
"other_config"/>
3227 <column name=
"external_ids"/>
3231 <table name=
"Flow_Table" title=
"OpenFlow table configuration">
3232 <p>Configuration for a particular OpenFlow table.
</p>
3234 <column name=
"name">
3235 The table's name. Set this column to change the name that controllers
3236 will receive when they request table statistics, e.g.
<code>ovs-ofctl
3237 dump-tables
</code>. The name does not affect switch behavior.
3240 <group title=
"Eviction Policy">
3242 Open vSwitch supports limiting the number of flows that may be
3243 installed in a flow table, via the
<ref column=
"flow_limit"/> column.
3244 When adding a flow would exceed this limit, by default Open vSwitch
3245 reports an error, but there are two ways to configure Open vSwitch to
3246 instead delete (``evict'') a flow to make room for the new one:
3251 Set the
<ref column=
"overflow_policy"/> column to
<code>evict
</code>.
3255 Send an OpenFlow
1.4+ ``table mod request'' to enable eviction for
3256 the flow table (e.g.
<code>ovs-ofctl -O OpenFlow14 mod-table br0
0
3257 evict
</code> to enable eviction on flow table
0 of bridge
3263 When a flow must be evicted due to overflow, the flow to evict is
3264 chosen through an approximation of the following algorithm. This
3265 algorithm is used regardless of how eviction was enabled:
3270 Divide the flows in the table into groups based on the values of the
3271 fields or subfields specified in the
<ref column=
"groups"/> column,
3272 so that all of the flows in a given group have the same values for
3273 those fields. If a flow does not specify a given field, that field's
3274 value is treated as
0. If
<ref column=
"groups"/> is empty, then all
3275 of the flows in the flow table are treated as a single group.
3279 Consider the flows in the largest group, that is, the group that
3280 contains the greatest number of flows. If two or more groups all
3281 have the same largest number of flows, consider the flows in all of
3286 If the flows under consideration have different importance values,
3287 eliminate from consideration any flows except those with the lowest
3288 importance. (``Importance,'' a
16-bit integer value attached to each
3289 flow, was introduced in OpenFlow
1.4. Flows inserted with older
3290 versions of OpenFlow always have an importance of
0.)
3294 Among the flows under consideration, choose the flow that expires
3295 soonest for eviction.
3300 The eviction process only considers flows that have an idle timeout
3301 or a hard timeout. That is, eviction never deletes permanent flows.
3302 (Permanent flows do count against
<ref column=
"flow_limit"/>.)
3305 <column name=
"flow_limit">
3306 If set, limits the number of flows that may be added to the table.
3307 Open vSwitch may limit the number of flows in a table for other
3308 reasons, e.g. due to hardware limitations or for resource availability
3309 or performance reasons.
3312 <column name=
"overflow_policy">
3314 Controls the switch's behavior when an OpenFlow flow table
3315 modification request would add flows in excess of
<ref
3316 column=
"flow_limit"/>. The supported values are:
3320 <dt><code>refuse
</code></dt>
3322 Refuse to add the flow or flows. This is also the default policy
3323 when
<ref column=
"overflow_policy"/> is unset.
3326 <dt><code>evict
</code></dt>
3328 Delete a flow chosen according to the algorithm described above.
3333 <column name=
"groups">
3335 When
<ref column=
"overflow_policy"/> is
<code>evict
</code>, this
3336 controls how flows are chosen for eviction when the flow table would
3337 otherwise exceed
<ref column=
"flow_limit"/> flows. Its value is a
3338 set of NXM fields or sub-fields, each of which takes one of the forms
3339 <code><var>field
</var>[]
</code> or
3340 <code><var>field
</var>[
<var>start
</var>..
<var>end
</var>]
</code>,
3341 e.g.
<code>NXM_OF_IN_PORT[]
</code>. Please see
3342 <code>meta-flow.h
</code> for a complete list of NXM field names.
3346 Open vSwitch ignores any invalid or unknown field specifications.
3350 When eviction is not enabled, via
<ref column=
"overflow_policy"/> or
3351 an OpenFlow
1.4+ ``table mod,'' this column has no effect.
3356 <group title=
"Classifier Optimization">
3357 <column name=
"prefixes">
3359 This string set specifies which fields should be used for
3360 address prefix tracking. Prefix tracking allows the
3361 classifier to skip rules with longer than necessary prefixes,
3362 resulting in better wildcarding for datapath flows.
3365 Prefix tracking may be beneficial when a flow table contains
3366 matches on IP address fields with different prefix lengths.
3367 For example, when a flow table contains IP address matches on
3368 both full addresses and proper prefixes, the full address
3369 matches will typically cause the datapath flow to un-wildcard
3370 the whole address field (depending on flow entry priorities).
3371 In this case each packet with a different address gets handed
3372 to the userspace for flow processing and generates its own
3373 datapath flow. With prefix tracking enabled for the address
3374 field in question packets with addresses matching shorter
3375 prefixes would generate datapath flows where the irrelevant
3376 address bits are wildcarded, allowing the same datapath flow
3377 to handle all the packets within the prefix in question. In
3378 this case many userspace upcalls can be avoided and the
3379 overall performance can be better.
3382 This is a performance optimization only, so packets will
3383 receive the same treatment with or without prefix tracking.
3386 The supported fields are:
<code>tun_id
</code>,
3387 <code>tun_src
</code>,
<code>tun_dst
</code>,
3388 <code>tun_ipv6_src
</code>,
<code>tun_ipv6_dst
</code>,
3389 <code>nw_src
</code>,
<code>nw_dst
</code> (or aliases
3390 <code>ip_src
</code> and
<code>ip_dst
</code>),
3391 <code>ipv6_src
</code>, and
<code>ipv6_dst
</code>. (Using this
3392 feature for
<code>tun_id
</code> would only make sense if the
3393 tunnel IDs have prefix structure similar to IP addresses.)
3397 By default, the
<code>prefixes=ip_dst,ip_src
</code> are used
3398 on each flow table. This instructs the flow classifier to
3399 track the IP destination and source addresses used by the
3400 rules in this specific flow table.
3404 The keyword
<code>none
</code> is recognized as an explicit
3405 override of the default values, causing no prefix fields to be
3410 To set the prefix fields, the flow table record needs to
3415 <dt><code>ovs-vsctl set Bridge br0 flow_tables:
0=@N1 -- --id=@N1 create Flow_Table name=table0
</code></dt>
3417 Creates a flow table record for the OpenFlow table number
0.
3420 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src
</code></dt>
3422 Enables prefix tracking for IP source and destination
3428 There is a maximum number of fields that can be enabled for any
3429 one flow table. Currently this limit is
3.
3434 <group title=
"Common Columns">
3435 The overall purpose of these columns is described under
<code>Common
3436 Columns
</code> at the beginning of this document.
3438 <column name=
"external_ids"/>
3442 <table name=
"QoS" title=
"Quality of Service configuration">
3443 <p>Quality of Service (QoS) configuration for each Port that
3446 <column name=
"type">
3447 <p>The type of QoS to implement. The currently defined types are
3450 <dt><code>linux-htb
</code></dt>
3452 Linux ``hierarchy token bucket'' classifier. See tc-htb(
8) (also at
3453 <code>http://linux.die.net/man/
8/tc-htb
</code>) and the HTB manual
3454 (
<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm
</code>)
3455 for information on how this classifier works and how to configure it.
3458 <dt><code>linux-hfsc
</code></dt>
3460 Linux
"Hierarchical Fair Service Curve" classifier.
3461 See
<code>http://linux-ip.net/articles/hfsc.en/
</code> for
3462 information on how this classifier works.
3465 <dt><code>linux-sfq
</code></dt>
3467 Linux ``Stochastic Fairness Queueing'' classifier. See
3468 <code>tc-sfq
</code>(
8) (also at
3469 <code>http://linux.die.net/man/
8/tc-sfq
</code>) for information on
3470 how this classifier works.
3473 <dt><code>linux-codel
</code></dt>
3475 Linux ``Controlled Delay'' classifier. See
<code>tc-codel
</code>(
8)
3477 <code>http://man7.org/linux/man-pages/man8/tc-codel
.8.html
</code>)
3478 for information on how this classifier works.
3481 <dt><code>linux-fq_codel
</code></dt>
3483 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3484 <code>tc-fq_codel
</code>(
8) (also at
3485 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel
.8.html
</code>)
3486 for information on how this classifier works.
3489 <dt><code>linux-noop
</code></dt>
3491 Linux ``No operation.'' By default, Open vSwitch manages quality of
3492 service on all of its configured ports. This can be helpful, but
3493 sometimes administrators prefer to use other software to manage QoS.
3494 This
<ref column=
"type"/> prevents Open vSwitch from changing the QoS
3495 configuration for a port.
3498 <dt><code>egress-policer
</code></dt>
3500 A DPDK egress policer algorithm using the DPDK
3501 rte_meter library. The rte_meter library provides an implementation
3502 which allows the metering and policing of traffic. The implementation
3503 in OVS essentially creates a single token bucket used to police
3504 traffic. It should be noted that when the rte_meter is configured as
3505 part of QoS there will be a performance overhead as the rte_meter
3506 itself will consume CPU cycles in order to police traffic. These CPU
3507 cycles ordinarily are used for packet proccessing. As such the drop
3508 in performance will be noticed in terms of overall aggregate traffic
3514 <column name=
"queues">
3515 <p>A map from queue numbers to
<ref table=
"Queue"/> records. The
3516 supported range of queue numbers depend on
<ref column=
"type"/>. The
3517 queue numbers are the same as the
<code>queue_id
</code> used in
3518 OpenFlow in
<code>struct ofp_action_enqueue
</code> and other
3522 Queue
0 is the ``default queue.'' It is used by OpenFlow output
3523 actions when no specific queue has been set. When no configuration for
3524 queue
0 is present, it is automatically configured as if a
<ref
3525 table=
"Queue"/> record with empty
<ref table=
"Queue" column=
"dscp"/>
3526 and
<ref table=
"Queue" column=
"other_config"/> columns had been
3528 (Before version
1.6, Open vSwitch would leave queue
0 unconfigured in
3529 this case. With some queuing disciplines, this dropped all packets
3530 destined for the default queue.)
3534 <group title=
"Configuration for linux-htb and linux-hfsc">
3536 The
<code>linux-htb
</code> and
<code>linux-hfsc
</code> classes support
3537 the following key-value pair:
3540 <column name=
"other_config" key=
"max-rate" type='{
"type":
"integer"}'
>
3541 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3542 specified, for physical interfaces, the default is the link rate. For
3543 other interfaces or if the link rate cannot be determined, the default
3544 is currently
100 Mbps.
3548 <group title=
"Configuration for egress-policer QoS">
3550 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3551 <code>egress-policer
</code> provides egress policing for userspace
3552 port types with DPDK.
3554 It has the following key-value pairs defined.
3557 <column name=
"other_config" key=
"cir" type='{
"type":
"integer"}'
>
3558 The Committed Information Rate (CIR) is measured in bytes of IP
3559 packets per second, i.e. it includes the IP header, but not link
3560 specific (e.g. Ethernet) headers. This represents the bytes per second
3561 rate at which the token bucket will be updated. The cir value is
3562 calculated by (pps x packet data size). For example assuming a user
3563 wishes to limit a stream consisting of
64 byte packets to
1 million
3564 packets per second the CIR would be set to to to
46000000. This value
3565 can be broken into '
1,
000,
000 x
46'. Where
1,
000,
000 is the policing
3566 rate for the number of packets per second and
46 represents the size
3567 of the packet data for a
64 byte ip packet.
3569 <column name=
"other_config" key=
"cbs" type='{
"type":
"integer"}'
>
3570 The Committed Burst Size (CBS) is measured in bytes and represents a
3571 token bucket. At a minimum this value should be be set to the expected
3572 largest size packet in the traffic stream. In practice larger values
3573 may be used to increase the size of the token bucket. If a packet can
3574 be transmitted then the cbs will be decremented by the number of
3575 bytes/tokens of the packet. If there are not enough tokens in the cbs
3576 bucket the packet will be dropped.
3580 <group title=
"Common Columns">
3581 The overall purpose of these columns is described under
<code>Common
3582 Columns
</code> at the beginning of this document.
3584 <column name=
"other_config"/>
3585 <column name=
"external_ids"/>
3589 <table name=
"Queue" title=
"QoS output queue.">
3590 <p>A configuration for a port output queue, used in configuring Quality of
3591 Service (QoS) features. May be referenced by
<ref column=
"queues"
3592 table=
"QoS"/> column in
<ref table=
"QoS"/> table.
</p>
3594 <column name=
"dscp">
3595 If set, Open vSwitch will mark all traffic egressing this
3596 <ref table=
"Queue"/> with the given DSCP bits. Traffic egressing the
3597 default
<ref table=
"Queue"/> is only marked if it was explicitly selected
3598 as the
<ref table=
"Queue"/> at the time the packet was output. If unset,
3599 the DSCP bits of traffic egressing this
<ref table=
"Queue"/> will remain
3603 <group title=
"Configuration for linux-htb QoS">
3605 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3606 <code>linux-htb
</code> may use
<code>queue_id
</code>s less than
61440.
3607 It has the following key-value pairs defined.
3610 <column name=
"other_config" key=
"min-rate"
3611 type='{
"type":
"integer",
"minInteger":
1}'
>
3612 Minimum guaranteed bandwidth, in bit/s.
3615 <column name=
"other_config" key=
"max-rate"
3616 type='{
"type":
"integer",
"minInteger":
1}'
>
3617 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3618 queue's rate will not be allowed to exceed the specified value, even
3619 if excess bandwidth is available. If unspecified, defaults to no
3623 <column name=
"other_config" key=
"burst"
3624 type='{
"type":
"integer",
"minInteger":
1}'
>
3625 Burst size, in bits. This is the maximum amount of ``credits'' that a
3626 queue can accumulate while it is idle. Optional. Details of the
3627 <code>linux-htb
</code> implementation require a minimum burst size, so
3628 a too-small
<code>burst
</code> will be silently ignored.
3631 <column name=
"other_config" key=
"priority"
3632 type='{
"type":
"integer",
"minInteger":
0,
"maxInteger":
4294967295}'
>
3633 A queue with a smaller
<code>priority
</code> will receive all the
3634 excess bandwidth that it can use before a queue with a larger value
3635 receives any. Specific priority values are unimportant; only relative
3636 ordering matters. Defaults to
0 if unspecified.
3640 <group title=
"Configuration for linux-hfsc QoS">
3642 <ref table=
"QoS"/> <ref table=
"QoS" column=
"type"/>
3643 <code>linux-hfsc
</code> may use
<code>queue_id
</code>s less than
61440.
3644 It has the following key-value pairs defined.
3647 <column name=
"other_config" key=
"min-rate"
3648 type='{
"type":
"integer",
"minInteger":
1}'
>
3649 Minimum guaranteed bandwidth, in bit/s.
3652 <column name=
"other_config" key=
"max-rate"
3653 type='{
"type":
"integer",
"minInteger":
1}'
>
3654 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3655 queue's rate will not be allowed to exceed the specified value, even if
3656 excess bandwidth is available. If unspecified, defaults to no
3661 <group title=
"Common Columns">
3662 The overall purpose of these columns is described under
<code>Common
3663 Columns
</code> at the beginning of this document.
3665 <column name=
"other_config"/>
3666 <column name=
"external_ids"/>
3670 <table name=
"Mirror" title=
"Port mirroring.">
3671 <p>A port mirror within a
<ref table=
"Bridge"/>.
</p>
3672 <p>A port mirror configures a bridge to send selected frames to special
3673 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3674 traffic may also be referred to as SPAN or RSPAN, depending on how
3675 the mirrored traffic is sent.
</p>
3678 When a packet enters an Open vSwitch bridge, it becomes eligible for
3679 mirroring based on its ingress port and VLAN. As the packet travels
3680 through the flow tables, each time it is output to a port, it becomes
3681 eligible for mirroring based on the egress port and VLAN. In Open
3682 vSwitch
2.5 and later, mirroring occurs just after a packet first becomes
3683 eligible, using the packet as it exists at that point; in Open vSwitch
3684 2.4 and earlier, mirroring occurs only after a packet has traversed all
3685 the flow tables, using the original packet as it entered the bridge.
3686 This makes a difference only when the flow table modifies the packet: in
3687 Open vSwitch
2.4, the modifications are never visible to mirrors, whereas
3688 in Open vSwitch
2.5 and later modifications made before the first output
3689 that makes it eligible for mirroring to a particular destination are
3694 A packet that enters an Open vSwitch bridge is mirrored to a particular
3695 destination only once, even if it is eligible for multiple reasons. For
3696 example, a packet would be mirrored to a particular
<ref
3697 column=
"output_port"/> only once, even if it is selected for mirroring to
3698 that port by
<ref column=
"select_dst_port"/> and
<ref
3699 column=
"select_src_port"/> in the same or different
<ref table=
"Mirror"/>
3703 <column name=
"name">
3704 Arbitrary identifier for the
<ref table=
"Mirror"/>.
3707 <group title=
"Selecting Packets for Mirroring">
3709 To be selected for mirroring, a given packet must enter or leave the
3710 bridge through a selected port and it must also be in one of the
3714 <column name=
"select_all">
3715 If true, every packet arriving or departing on any port is
3716 selected for mirroring.
3719 <column name=
"select_dst_port">
3720 Ports on which departing packets are selected for mirroring.
3723 <column name=
"select_src_port">
3724 Ports on which arriving packets are selected for mirroring.
3727 <column name=
"select_vlan">
3728 VLANs on which packets are selected for mirroring. An empty set
3729 selects packets on all VLANs.
3733 <group title=
"Mirroring Destination Configuration">
3735 These columns are mutually exclusive. Exactly one of them must be
3739 <column name=
"output_port">
3740 <p>Output port for selected packets, if nonempty.
</p>
3741 <p>Specifying a port for mirror output reserves that port exclusively
3742 for mirroring. No frames other than those selected for mirroring
3744 will be forwarded to the port, and any frames received on the port
3745 will be discarded.
</p>
3747 The output port may be any kind of port supported by Open vSwitch.
3748 It may be, for example, a physical port (sometimes called SPAN) or a
3753 <column name=
"output_vlan">
3754 <p>Output VLAN for selected packets, if nonempty.
</p>
3755 <p>The frames will be sent out all ports that trunk
3756 <ref column=
"output_vlan"/>, as well as any ports with implicit VLAN
3757 <ref column=
"output_vlan"/>. When a mirrored frame is sent out a
3758 trunk port, the frame's VLAN tag will be set to
3759 <ref column=
"output_vlan"/>, replacing any existing tag; when it is
3760 sent out an implicit VLAN port, the frame will not be tagged. This
3761 type of mirroring is sometimes called RSPAN.
</p>
3763 See the documentation for
3764 <ref column=
"other_config" key=
"forward-bpdu"/> in the
3765 <ref table=
"Interface"/> table for a list of destination MAC
3766 addresses which will not be mirrored to a VLAN to avoid confusing
3767 switches that interpret the protocols that they represent.
3769 <p><em>Please note:
</em> Mirroring to a VLAN can disrupt a network that
3770 contains unmanaged switches. Consider an unmanaged physical switch
3771 with two ports: port
1, connected to an end host, and port
2,
3772 connected to an Open vSwitch configured to mirror received packets
3773 into VLAN
123 on port
2. Suppose that the end host sends a packet on
3774 port
1 that the physical switch forwards to port
2. The Open vSwitch
3775 forwards this packet to its destination and then reflects it back on
3776 port
2 in VLAN
123. This reflected packet causes the unmanaged
3777 physical switch to replace the MAC learning table entry, which
3778 correctly pointed to port
1, with one that incorrectly points to port
3779 2. Afterward, the physical switch will direct packets destined for
3780 the end host to the Open vSwitch on port
2, instead of to the end
3781 host on port
1, disrupting connectivity. If mirroring to a VLAN is
3782 desired in this scenario, then the physical switch must be replaced
3783 by one that learns Ethernet addresses on a per-VLAN basis. In
3784 addition, learning should be disabled on the VLAN containing mirrored
3785 traffic. If this is not done then intermediate switches will learn
3786 the MAC address of each end host from the mirrored traffic. If
3787 packets being sent to that end host are also mirrored, then they will
3788 be dropped since the switch will attempt to send them out the input
3789 port. Disabling learning for the VLAN will cause the switch to
3790 correctly send the packet out all ports configured for that VLAN. If
3791 Open vSwitch is being used as an intermediate switch, learning can be
3792 disabled by adding the mirrored VLAN to
<ref column=
"flood_vlans"/>
3793 in the appropriate
<ref table=
"Bridge"/> table or tables.
</p>
3795 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3796 VLAN and should generally be preferred.
3800 <column name=
"snaplen">
3801 <p>Maximum per-packet number of bytes to mirror.
</p>
3802 <p>A mirrored packet with size larger than
<ref column=
"snaplen"/>
3803 will be truncated in datapath to
<ref column=
"snaplen"/> bytes
3804 before sending to the mirror output port. If omitted, packets
3810 <group title=
"Statistics: Mirror counters">
3812 Key-value pairs that report mirror statistics. The update period
3813 is controlled by
<ref column=
"other_config"
3814 key=
"stats-update-interval"/> in the
<code>Open_vSwitch
</code> table.
3816 <column name=
"statistics" key=
"tx_packets">
3817 Number of packets transmitted through this mirror.
3819 <column name=
"statistics" key=
"tx_bytes">
3820 Number of bytes transmitted through this mirror.
3824 <group title=
"Common Columns">
3825 The overall purpose of these columns is described under
<code>Common
3826 Columns
</code> at the beginning of this document.
3828 <column name=
"external_ids"/>
3832 <table name=
"Controller" title=
"OpenFlow controller configuration.">
3833 <p>An OpenFlow controller.
</p>
3836 Open vSwitch supports two kinds of OpenFlow controllers:
3840 <dt>Primary controllers
</dt>
3843 This is the kind of controller envisioned by the OpenFlow
1.0
3844 specification. Usually, a primary controller implements a network
3845 policy by taking charge of the switch's flow table.
3849 Open vSwitch initiates and maintains persistent connections to
3850 primary controllers, retrying the connection each time it fails or
3851 drops. The
<ref table=
"Bridge" column=
"fail_mode"/> column in the
3852 <ref table=
"Bridge"/> table applies to primary controllers.
3856 Open vSwitch permits a bridge to have any number of primary
3857 controllers. When multiple controllers are configured, Open
3858 vSwitch connects to all of them simultaneously. Because
3859 OpenFlow
1.0 does not specify how multiple controllers
3860 coordinate in interacting with a single switch, more than
3861 one primary controller should be specified only if the
3862 controllers are themselves designed to coordinate with each
3863 other. (The Nicira-defined
<code>NXT_ROLE
</code> OpenFlow
3864 vendor extension may be useful for this.)
3867 <dt>Service controllers
</dt>
3870 These kinds of OpenFlow controller connections are intended for
3871 occasional support and maintenance use, e.g. with
3872 <code>ovs-ofctl
</code>. Usually a service controller connects only
3873 briefly to inspect or modify some of a switch's state.
3877 Open vSwitch listens for incoming connections from service
3878 controllers. The service controllers initiate and, if necessary,
3879 maintain the connections from their end. The
<ref table=
"Bridge"
3880 column=
"fail_mode"/> column in the
<ref table=
"Bridge"/> table does
3881 not apply to service controllers.
3885 Open vSwitch supports configuring any number of service controllers.
3891 The
<ref column=
"target"/> determines the type of controller.
3894 <group title=
"Core Features">
3895 <column name=
"target">
3896 <p>Connection method for controller.
</p>
3898 The following connection methods are currently supported for primary
3902 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
3904 <p>The specified SSL
<var>port
</var> on the host at the
3905 given
<var>ip
</var>, which must be expressed as an IP
3906 address (not a DNS name). The
<ref table=
"Open_vSwitch"
3907 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
3908 table must point to a valid SSL configuration when this form
3910 <p>If
<var>port
</var> is not specified, it defaults to
6653.
</p>
3911 <p>SSL support is an optional feature that is not always built as
3912 part of Open vSwitch.
</p>
3914 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
3917 The specified TCP
<var>port
</var> on the host at the given
3918 <var>ip
</var>, which must be expressed as an IP address (not a
3919 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
3920 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
3921 e.g.
<code>tcp:[::
1]:
6653</code>.
3924 If
<var>port
</var> is not specified, it defaults to
6653.
3929 The following connection methods are currently supported for service
3933 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
3936 Listens for SSL connections on the specified TCP
<var>port
</var>.
3937 If
<var>ip
</var>, which must be expressed as an IP address (not a
3938 DNS name), is specified, then connections are restricted to the
3939 specified local IP address (either IPv4 or IPv6). If
3940 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
3941 e.g.
<code>pssl:
6653:[::
1]
</code>.
3944 If
<var>port
</var> is not specified, it defaults to
3945 6653. If
<var>ip
</var> is not specified then it listens only on
3946 IPv4 (but not IPv6) addresses. The
3947 <ref table=
"Open_vSwitch" column=
"ssl"/>
3948 column in the
<ref table=
"Open_vSwitch"/> table must point to a
3949 valid SSL configuration when this form is used.
3952 If
<var>port
</var> is not specified, it currently to
6653.
3955 SSL support is an optional feature that is not always built as
3956 part of Open vSwitch.
3959 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
3962 Listens for connections on the specified TCP
<var>port
</var>. If
3963 <var>ip
</var>, which must be expressed as an IP address (not a
3964 DNS name), is specified, then connections are restricted to the
3965 specified local IP address (either IPv4 or IPv6). If
3966 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
3967 e.g.
<code>ptcp:
6653:[::
1]
</code>. If
<var>ip
</var> is not
3968 specified then it listens only on IPv4 addresses.
3971 If
<var>port
</var> is not specified, it defaults to
6653.
3975 <p>When multiple controllers are configured for a single bridge, the
3976 <ref column=
"target"/> values must be unique. Duplicate
3977 <ref column=
"target"/> values yield unspecified results.
</p>
3980 <column name=
"connection_mode">
3981 <p>If it is specified, this setting must be one of the following
3982 strings that describes how Open vSwitch contacts this OpenFlow
3983 controller over the network:
</p>
3986 <dt><code>in-band
</code></dt>
3987 <dd>In this mode, this controller's OpenFlow traffic travels over the
3988 bridge associated with the controller. With this setting, Open
3989 vSwitch allows traffic to and from the controller regardless of the
3990 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3991 would never be able to connect to the controller, because it did
3992 not have a flow to enable it.) This is the most common connection
3993 mode because it is not necessary to maintain two independent
3995 <dt><code>out-of-band
</code></dt>
3996 <dd>In this mode, OpenFlow traffic uses a control network separate
3997 from the bridge associated with this controller, that is, the
3998 bridge does not use any of its own network devices to communicate
3999 with the controller. The control network must be configured
4000 separately, before or after
<code>ovs-vswitchd
</code> is started.
4004 <p>If not specified, the default is implementation-specific.
</p>
4008 <group title=
"Controller Failure Detection and Handling">
4009 <column name=
"max_backoff">
4010 Maximum number of milliseconds to wait between connection attempts.
4011 Default is implementation-specific.
4014 <column name=
"inactivity_probe">
4015 Maximum number of milliseconds of idle time on connection to
4016 controller before sending an inactivity probe message. If Open
4017 vSwitch does not communicate with the controller for the specified
4018 number of seconds, it will send a probe. If a response is not
4019 received for the same additional amount of time, Open vSwitch
4020 assumes the connection has been broken and attempts to reconnect.
4021 Default is implementation-specific. A value of
0 disables
4026 <group title=
"Asynchronous Messages">
4028 OpenFlow switches send certain messages to controllers spontanenously,
4029 that is, not in response to any request from the controller. These
4030 messages are called ``asynchronous messages.'' These columns allow
4031 asynchronous messages to be limited or disabled to ensure the best use
4032 of network resources.
4035 <column name=
"enable_async_messages">
4036 The OpenFlow protocol enables asynchronous messages at time of
4037 connection establishment, which means that a controller can receive
4038 asynchronous messages, potentially many of them, even if it turns them
4039 off immediately after connecting. Set this column to
4040 <code>false
</code> to change Open vSwitch behavior to disable, by
4041 default, all asynchronous messages. The controller can use the
4042 <code>NXT_SET_ASYNC_CONFIG
</code> Nicira extension to OpenFlow to turn
4043 on any messages that it does want to receive, if any.
4046 <group title=
"Controller Rate Limiting">
4048 A switch can forward packets to a controller over the OpenFlow
4049 protocol. Forwarding packets this way at too high a rate can
4050 overwhelm a controller, frustrate use of the OpenFlow connection for
4051 other purposes, increase the latency of flow setup, and use an
4052 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
4053 limiting the rate of packet forwarding to a controller.
4057 There are two main reasons in OpenFlow for a packet to be sent to a
4058 controller: either the packet ``misses'' in the flow table, that is,
4059 there is no matching flow, or a flow table action says to send the
4060 packet to the controller. Open vSwitch limits the rate of each kind
4061 of packet separately at the configured rate. Therefore, the actual
4062 rate that packets are sent to the controller can be up to twice the
4063 configured rate, when packets are sent for both reasons.
4067 This feature is specific to forwarding packets over an OpenFlow
4068 connection. It is not general-purpose QoS. See the
<ref
4069 table=
"QoS"/> table for quality of service configuration, and
<ref
4070 column=
"ingress_policing_rate" table=
"Interface"/> in the
<ref
4071 table=
"Interface"/> table for ingress policing configuration.
4074 <column name=
"controller_rate_limit">
4076 The maximum rate at which the switch will forward packets to the
4077 OpenFlow controller, in packets per second. If no value is
4078 specified, rate limiting is disabled.
4082 <column name=
"controller_burst_limit">
4084 When a high rate triggers rate-limiting, Open vSwitch queues
4085 packets to the controller for each port and transmits them to the
4086 controller at the configured rate. This value limits the number of
4087 queued packets. Ports on a bridge share the packet queue fairly.
4091 This value has no effect unless
<ref
4092 column=
"controller_rate_limit"/> is configured. The current
4093 default when this value is not specified is one-quarter of
<ref
4094 column=
"controller_rate_limit"/>, meaning that queuing can delay
4095 forwarding a packet to the controller by up to
250 ms.
4099 <group title=
"Controller Rate Limiting Statistics">
4101 These values report the effects of rate limiting. Their values are
4102 relative to establishment of the most recent OpenFlow connection,
4103 or since rate limiting was enabled, whichever happened more
4104 recently. Each consists of two values, one with
<code>TYPE
</code>
4105 replaced by
<code>miss
</code> for rate limiting flow table misses,
4106 and the other with
<code>TYPE
</code> replaced by
4107 <code>action
</code> for rate limiting packets sent by OpenFlow
4112 These statistics are reported only when controller rate limiting is
4116 <column name=
"status" key=
"packet-in-TYPE-bypassed"
4117 type='{
"type":
"integer",
"minInteger":
0}'
>
4118 Number of packets sent directly to the controller, without queuing,
4119 because the rate did not exceed the configured maximum.
4122 <column name=
"status" key=
"packet-in-TYPE-queued"
4123 type='{
"type":
"integer",
"minInteger":
0}'
>
4124 Number of packets added to the queue to send later.
4127 <column name=
"status" key=
"packet-in-TYPE-dropped"
4128 type='{
"type":
"integer",
"minInteger":
0}'
>
4129 Number of packets added to the queue that were later dropped due to
4130 overflow. This value is less than or equal to
<ref column=
"status"
4131 key=
"packet-in-TYPE-queued"/>.
4134 <column name=
"status" key=
"packet-in-TYPE-backlog"
4135 type='{
"type":
"integer",
"minInteger":
0}'
>
4136 Number of packets currently queued. The other statistics increase
4137 monotonically, but this one fluctuates between
0 and the
<ref
4138 column=
"controller_burst_limit"/> as conditions change.
4144 <group title=
"Additional In-Band Configuration">
4145 <p>These values are considered only in in-band control mode (see
4146 <ref column=
"connection_mode"/>).
</p>
4148 <p>When multiple controllers are configured on a single bridge, there
4149 should be only one set of unique values in these columns. If different
4150 values are set for these columns in different controllers, the effect
4153 <column name=
"local_ip">
4154 The IP address to configure on the local port,
4155 e.g.
<code>192.168.0.123</code>. If this value is unset, then
4156 <ref column=
"local_netmask"/> and
<ref column=
"local_gateway"/> are
4160 <column name=
"local_netmask">
4161 The IP netmask to configure on the local port,
4162 e.g.
<code>255.255.255.0</code>. If
<ref column=
"local_ip"/> is set
4163 but this value is unset, then the default is chosen based on whether
4164 the IP address is class A, B, or C.
4167 <column name=
"local_gateway">
4168 The IP address of the gateway to configure on the local port, as a
4169 string, e.g.
<code>192.168.0.1</code>. Leave this column unset if
4170 this network has no gateway.
4174 <group title=
"Controller Status">
4175 <column name=
"is_connected">
4176 <code>true
</code> if currently connected to this controller,
4177 <code>false
</code> otherwise.
4181 type='{
"type":
"string",
"enum": [
"set", [
"other",
"master",
"slave"]]}'
>
4182 <p>The level of authority this controller has on the associated
4183 bridge. Possible values are:
</p>
4185 <dt><code>other
</code></dt>
4186 <dd>Allows the controller access to all OpenFlow features.
</dd>
4187 <dt><code>master
</code></dt>
4188 <dd>Equivalent to
<code>other
</code>, except that there may be at
4189 most one master controller at a time. When a controller configures
4190 itself as
<code>master
</code>, any existing master is demoted to
4191 the
<code>slave
</code> role.
</dd>
4192 <dt><code>slave
</code></dt>
4193 <dd>Allows the controller read-only access to OpenFlow features.
4194 Attempts to modify the flow table will be rejected with an
4195 error. Slave controllers do not receive OFPT_PACKET_IN or
4196 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
4201 <column name=
"status" key=
"last_error">
4202 A human-readable description of the last error on the connection
4203 to the controller; i.e.
<code>strerror(errno)
</code>. This key
4204 will exist only if an error has occurred.
4207 <column name=
"status" key=
"state"
4208 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4210 The state of the connection to the controller:
4213 <dt><code>VOID
</code></dt>
4214 <dd>Connection is disabled.
</dd>
4216 <dt><code>BACKOFF
</code></dt>
4217 <dd>Attempting to reconnect at an increasing period.
</dd>
4219 <dt><code>CONNECTING
</code></dt>
4220 <dd>Attempting to connect.
</dd>
4222 <dt><code>ACTIVE
</code></dt>
4223 <dd>Connected, remote host responsive.
</dd>
4225 <dt><code>IDLE
</code></dt>
4226 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4229 These values may change in the future. They are provided only for
4234 <column name=
"status" key=
"sec_since_connect"
4235 type='{
"type":
"integer",
"minInteger":
0}'
>
4236 The amount of time since this controller last successfully connected to
4237 the switch (in seconds). Value is empty if controller has never
4238 successfully connected.
4241 <column name=
"status" key=
"sec_since_disconnect"
4242 type='{
"type":
"integer",
"minInteger":
1}'
>
4243 The amount of time since this controller last disconnected from
4244 the switch (in seconds). Value is empty if controller has never
4249 <group title=
"Connection Parameters">
4251 Additional configuration for a connection between the controller
4252 and the Open vSwitch.
4255 <column name=
"other_config" key=
"dscp"
4256 type='{
"type":
"integer"}'
>
4257 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4258 in the Type of Service (TOS) field in the IP header. DSCP provides a
4259 mechanism to classify the network traffic and provide Quality of
4260 Service (QoS) on IP networks.
4262 The DSCP value specified here is used when establishing the connection
4263 between the controller and the Open vSwitch. If no value is specified,
4264 a default value of
48 is chosen. Valid DSCP values must be in the
4270 <group title=
"Common Columns">
4271 The overall purpose of these columns is described under
<code>Common
4272 Columns
</code> at the beginning of this document.
4274 <column name=
"external_ids"/>
4275 <column name=
"other_config"/>
4279 <table name=
"Manager" title=
"OVSDB management connection.">
4281 Configuration for a database connection to an Open vSwitch database
4286 This table primarily configures the Open vSwitch database
4287 (
<code>ovsdb-server
</code>), not the Open vSwitch switch
4288 (
<code>ovs-vswitchd
</code>). The switch does read the table to determine
4289 what connections should be treated as in-band.
4293 The Open vSwitch database server can initiate and maintain active
4294 connections to remote clients. It can also listen for database
4298 <group title=
"Core Features">
4299 <column name=
"target">
4300 <p>Connection method for managers.
</p>
4302 The following connection methods are currently supported:
4305 <dt><code>ssl:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4308 The specified SSL
<var>port
</var> on the host at the given
4309 <var>ip
</var>, which must be expressed as an IP address
4310 (not a DNS name). The
<ref table=
"Open_vSwitch"
4311 column=
"ssl"/> column in the
<ref table=
"Open_vSwitch"/>
4312 table must point to a valid SSL configuration when this
4316 If
<var>port
</var> is not specified, it defaults to
6640.
4319 SSL support is an optional feature that is not always
4320 built as part of Open vSwitch.
4324 <dt><code>tcp:
<var>ip
</var></code>[
<code>:
<var>port
</var></code>]
</dt>
4327 The specified TCP
<var>port
</var> on the host at the given
4328 <var>ip
</var>, which must be expressed as an IP address (not a
4329 DNS name), where
<var>ip
</var> can be IPv4 or IPv6 address. If
4330 <var>ip
</var> is an IPv6 address, wrap it in square brackets,
4331 e.g.
<code>tcp:[::
1]:
6640</code>.
4334 If
<var>port
</var> is not specified, it defaults to
6640.
4337 <dt><code>pssl:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4340 Listens for SSL connections on the specified TCP
<var>port
</var>.
4341 Specify
0 for
<var>port
</var> to have the kernel automatically
4342 choose an available port. If
<var>ip
</var>, which must be
4343 expressed as an IP address (not a DNS name), is specified, then
4344 connections are restricted to the specified local IP address
4345 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4346 address, wrap in square brackets,
4347 e.g.
<code>pssl:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4348 specified then it listens only on IPv4 (but not IPv6) addresses.
4349 The
<ref table=
"Open_vSwitch" column=
"ssl"/> column in the
<ref
4350 table=
"Open_vSwitch"/> table must point to a valid SSL
4351 configuration when this form is used.
4354 If
<var>port
</var> is not specified, it defaults to
6640.
4357 SSL support is an optional feature that is not always built as
4358 part of Open vSwitch.
4361 <dt><code>ptcp:
</code>[
<var>port
</var>][
<code>:
<var>ip
</var></code>]
</dt>
4364 Listens for connections on the specified TCP
<var>port
</var>.
4365 Specify
0 for
<var>port
</var> to have the kernel automatically
4366 choose an available port. If
<var>ip
</var>, which must be
4367 expressed as an IP address (not a DNS name), is specified, then
4368 connections are restricted to the specified local IP address
4369 (either IPv4 or IPv6 address). If
<var>ip
</var> is an IPv6
4370 address, wrap it in square brackets,
4371 e.g.
<code>ptcp:
6640:[::
1]
</code>. If
<var>ip
</var> is not
4372 specified then it listens only on IPv4 addresses.
4375 If
<var>port
</var> is not specified, it defaults to
6640.
4379 <p>When multiple managers are configured, the
<ref column=
"target"/>
4380 values must be unique. Duplicate
<ref column=
"target"/> values yield
4381 unspecified results.
</p>
4384 <column name=
"connection_mode">
4386 If it is specified, this setting must be one of the following strings
4387 that describes how Open vSwitch contacts this OVSDB client over the
4392 <dt><code>in-band
</code></dt>
4394 In this mode, this connection's traffic travels over a bridge
4395 managed by Open vSwitch. With this setting, Open vSwitch allows
4396 traffic to and from the client regardless of the contents of the
4397 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4398 to connect to the client, because it did not have a flow to enable
4399 it.) This is the most common connection mode because it is not
4400 necessary to maintain two independent networks.
4402 <dt><code>out-of-band
</code></dt>
4404 In this mode, the client's traffic uses a control network separate
4405 from that managed by Open vSwitch, that is, Open vSwitch does not
4406 use any of its own network devices to communicate with the client.
4407 The control network must be configured separately, before or after
4408 <code>ovs-vswitchd
</code> is started.
4413 If not specified, the default is implementation-specific.
4418 <group title=
"Client Failure Detection and Handling">
4419 <column name=
"max_backoff">
4420 Maximum number of milliseconds to wait between connection attempts.
4421 Default is implementation-specific.
4424 <column name=
"inactivity_probe">
4425 Maximum number of milliseconds of idle time on connection to the client
4426 before sending an inactivity probe message. If Open vSwitch does not
4427 communicate with the client for the specified number of seconds, it
4428 will send a probe. If a response is not received for the same
4429 additional amount of time, Open vSwitch assumes the connection has been
4430 broken and attempts to reconnect. Default is implementation-specific.
4431 A value of
0 disables inactivity probes.
4435 <group title=
"Status">
4437 Key-value pair of
<ref column=
"is_connected"/> is always updated.
4438 Other key-value pairs in the status columns may be updated depends
4439 on the
<ref column=
"target"/> type.
4443 When
<ref column=
"target"/> specifies a connection method that
4444 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4445 <code>punix:
</code>), both
<ref column=
"n_connections"/> and
4446 <ref column=
"is_connected"/> may also be updated while the
4447 remaining key-value pairs are omitted.
4451 On the other hand, when
<ref column=
"target"/> specifies an
4452 outbound connection, all key-value pairs may be updated, except
4453 the above-mentioned two key-value pairs associated with inbound
4454 connection targets. They are omitted.
4457 <column name=
"is_connected">
4458 <code>true
</code> if currently connected to this manager,
4459 <code>false
</code> otherwise.
4462 <column name=
"status" key=
"last_error">
4463 A human-readable description of the last error on the connection
4464 to the manager; i.e.
<code>strerror(errno)
</code>. This key
4465 will exist only if an error has occurred.
4468 <column name=
"status" key=
"state"
4469 type='{
"type":
"string",
"enum": [
"set", [
"VOID",
"BACKOFF",
"CONNECTING",
"ACTIVE",
"IDLE"]]}'
>
4471 The state of the connection to the manager:
4474 <dt><code>VOID
</code></dt>
4475 <dd>Connection is disabled.
</dd>
4477 <dt><code>BACKOFF
</code></dt>
4478 <dd>Attempting to reconnect at an increasing period.
</dd>
4480 <dt><code>CONNECTING
</code></dt>
4481 <dd>Attempting to connect.
</dd>
4483 <dt><code>ACTIVE
</code></dt>
4484 <dd>Connected, remote host responsive.
</dd>
4486 <dt><code>IDLE
</code></dt>
4487 <dd>Connection is idle. Waiting for response to keep-alive.
</dd>
4490 These values may change in the future. They are provided only for
4495 <column name=
"status" key=
"sec_since_connect"
4496 type='{
"type":
"integer",
"minInteger":
0}'
>
4497 The amount of time since this manager last successfully connected
4498 to the database (in seconds). Value is empty if manager has never
4499 successfully connected.
4502 <column name=
"status" key=
"sec_since_disconnect"
4503 type='{
"type":
"integer",
"minInteger":
0}'
>
4504 The amount of time since this manager last disconnected from the
4505 database (in seconds). Value is empty if manager has never
4509 <column name=
"status" key=
"locks_held">
4510 Space-separated list of the names of OVSDB locks that the connection
4511 holds. Omitted if the connection does not hold any locks.
4514 <column name=
"status" key=
"locks_waiting">
4515 Space-separated list of the names of OVSDB locks that the connection is
4516 currently waiting to acquire. Omitted if the connection is not waiting
4520 <column name=
"status" key=
"locks_lost">
4521 Space-separated list of the names of OVSDB locks that the connection
4522 has had stolen by another OVSDB client. Omitted if no locks have been
4523 stolen from this connection.
4526 <column name=
"status" key=
"n_connections"
4527 type='{
"type":
"integer",
"minInteger":
2}'
>
4528 When
<ref column=
"target"/> specifies a connection method that
4529 listens for inbound connections (e.g.
<code>ptcp:
</code> or
4530 <code>pssl:
</code>) and more than one connection is actually active,
4531 the value is the number of active connections. Otherwise, this
4532 key-value pair is omitted.
4535 <column name=
"status" key=
"bound_port" type='{
"type":
"integer"}'
>
4536 When
<ref column=
"target"/> is
<code>ptcp:
</code> or
4537 <code>pssl:
</code>, this is the TCP port on which the OVSDB server is
4538 listening. (This is particularly useful when
<ref
4539 column=
"target"/> specifies a port of
0, allowing the kernel to
4540 choose any available port.)
4544 <group title=
"Connection Parameters">
4546 Additional configuration for a connection between the manager
4547 and the Open vSwitch Database.
4550 <column name=
"other_config" key=
"dscp"
4551 type='{
"type":
"integer"}'
>
4552 The Differentiated Service Code Point (DSCP) is specified using
6 bits
4553 in the Type of Service (TOS) field in the IP header. DSCP provides a
4554 mechanism to classify the network traffic and provide Quality of
4555 Service (QoS) on IP networks.
4557 The DSCP value specified here is used when establishing the connection
4558 between the manager and the Open vSwitch. If no value is specified, a
4559 default value of
48 is chosen. Valid DSCP values must be in the range
4564 <group title=
"Common Columns">
4565 The overall purpose of these columns is described under
<code>Common
4566 Columns
</code> at the beginning of this document.
4568 <column name=
"external_ids"/>
4569 <column name=
"other_config"/>
4573 <table name=
"NetFlow">
4574 A NetFlow target. NetFlow is a protocol that exports a number of
4575 details about terminating IP flows, such as the principals involved
4578 <column name=
"targets">
4579 NetFlow targets in the form
4580 <code><var>ip
</var>:
<var>port
</var></code>. The
<var>ip
</var>
4581 must be specified numerically, not as a DNS name.
4584 <column name=
"engine_id">
4585 Engine ID to use in NetFlow messages. Defaults to datapath index
4589 <column name=
"engine_type">
4590 Engine type to use in NetFlow messages. Defaults to datapath
4591 index if not specified.
4594 <column name=
"active_timeout">
4596 The interval at which NetFlow records are sent for flows that
4597 are still active, in seconds. A value of
<code>0</code>
4598 requests the default timeout (currently
600 seconds); a value
4599 of
<code>-
1</code> disables active timeouts.
4603 The NetFlow passive timeout, for flows that become inactive,
4604 is not configurable. It will vary depending on the Open
4605 vSwitch version, the forms and contents of the OpenFlow flow
4606 tables, CPU and memory usage, and network activity. A typical
4607 passive timeout is about a second.
4611 <column name=
"add_id_to_interface">
4612 <p>If this column's value is
<code>false
</code>, the ingress and egress
4613 interface fields of NetFlow flow records are derived from OpenFlow port
4614 numbers. When it is
<code>true
</code>, the
7 most significant bits of
4615 these fields will be replaced by the least significant
7 bits of the
4616 engine id. This is useful because many NetFlow collectors do not
4617 expect multiple switches to be sending messages from the same host, so
4618 they do not store the engine information which could be used to
4619 disambiguate the traffic.
</p>
4620 <p>When this option is enabled, a maximum of
508 ports are supported.
</p>
4623 <group title=
"Common Columns">
4624 The overall purpose of these columns is described under
<code>Common
4625 Columns
</code> at the beginning of this document.
4627 <column name=
"external_ids"/>
4632 SSL configuration for an Open_vSwitch.
4634 <column name=
"private_key">
4635 Name of a PEM file containing the private key used as the switch's
4636 identity for SSL connections to the controller.
4639 <column name=
"certificate">
4640 Name of a PEM file containing a certificate, signed by the
4641 certificate authority (CA) used by the controller and manager,
4642 that certifies the switch's private key, identifying a trustworthy
4646 <column name=
"ca_cert">
4647 Name of a PEM file containing the CA certificate used to verify
4648 that the switch is connected to a trustworthy controller.
4651 <column name=
"bootstrap_ca_cert">
4652 If set to
<code>true
</code>, then Open vSwitch will attempt to
4653 obtain the CA certificate from the controller on its first SSL
4654 connection and save it to the named PEM file. If it is successful,
4655 it will immediately drop the connection and reconnect, and from then
4656 on all SSL connections must be authenticated by a certificate signed
4657 by the CA certificate thus obtained.
<em>This option exposes the
4658 SSL connection to a man-in-the-middle attack obtaining the initial
4659 CA certificate.
</em> It may still be useful for bootstrapping.
4662 <group title=
"Common Columns">
4663 The overall purpose of these columns is described under
<code>Common
4664 Columns
</code> at the beginning of this document.
4666 <column name=
"external_ids"/>
4670 <table name=
"sFlow">
4671 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4672 monitoring of switches.
</p>
4674 <column name=
"agent">
4675 Name of the network device whose IP address should be reported as the
4676 ``agent address'' to collectors. If not specified, the agent device is
4677 figured from the first target address and the routing table. If the
4678 routing table does not contain a route to the target, the IP address
4679 defaults to the
<ref table=
"Controller" column=
"local_ip"/> in the
4680 collector's
<ref table=
"Controller"/>. If an agent IP address cannot be
4681 determined any of these ways, sFlow is disabled.
4684 <column name=
"header">
4685 Number of bytes of a sampled packet to send to the collector.
4686 If not specified, the default is
128 bytes.
4689 <column name=
"polling">
4690 Polling rate in seconds to send port statistics to the collector.
4691 If not specified, defaults to
30 seconds.
4694 <column name=
"sampling">
4695 Rate at which packets should be sampled and sent to the collector.
4696 If not specified, defaults to
400, which means one out of
400
4697 packets, on average, will be sent to the collector.
4700 <column name=
"targets">
4701 sFlow targets in the form
4702 <code><var>ip
</var>:
<var>port
</var></code>.
4705 <group title=
"Common Columns">
4706 The overall purpose of these columns is described under
<code>Common
4707 Columns
</code> at the beginning of this document.
4709 <column name=
"external_ids"/>
4713 <table name=
"IPFIX">
4714 <p>Configuration for sending packets to IPFIX collectors.
</p>
4717 IPFIX is a protocol that exports a number of details about flows. The
4718 IPFIX implementation in Open vSwitch samples packets at a configurable
4719 rate, extracts flow information from those packets, optionally caches and
4720 aggregates the flow information, and sends the result to one or more
4725 IPFIX in Open vSwitch can be configured two different ways:
4730 With
<em>per-bridge sampling
</em>, Open vSwitch performs IPFIX sampling
4731 automatically on all packets that pass through a bridge. To configure
4732 per-bridge sampling, create an
<ref table=
"IPFIX"/> record and point a
4733 <ref table=
"Bridge"/> table's
<ref table=
"Bridge" column=
"ipfix"/>
4734 column to it. The
<ref table=
"Flow_Sample_Collector_Set"/> table is
4735 not used for per-bridge sampling.
4740 With
<em>flow-based sampling
</em>,
<code>sample
</code> actions in the
4741 OpenFlow flow table drive IPFIX sampling. See
4742 <code>ovs-ofctl
</code>(
8) for a description of the
4743 <code>sample
</code> action.
4747 Flow-based sampling also requires database configuration: create a
4748 <ref table=
"IPFIX"/> record that describes the IPFIX configuration
4749 and a
<ref table=
"Flow_Sample_Collector_Set"/> record that points to
4750 the
<ref table=
"Bridge"/> whose flow table holds the
4751 <code>sample
</code> actions and to
<ref table=
"IPFIX"/> record. The
4752 <ref table=
"Bridge" column=
"ipfix"/> in the
<ref table=
"Bridge"/>
4753 table is not used for flow-based sampling.
4758 <column name=
"targets">
4759 IPFIX target collectors in the form
4760 <code><var>ip
</var>:
<var>port
</var></code>.
4763 <column name=
"cache_active_timeout">
4764 The maximum period in seconds for which an IPFIX flow record is
4765 cached and aggregated before being sent. If not specified,
4766 defaults to
0. If
0, caching is disabled.
4769 <column name=
"cache_max_flows">
4770 The maximum number of IPFIX flow records that can be cached at a
4771 time. If not specified, defaults to
0. If
0, caching is
4775 <column name=
"other_config" key=
"enable-tunnel-sampling"
4776 type='{
"type":
"boolean"}'
>
4778 Set to
<code>true
</code> to enable sampling and reporting tunnel
4779 header
7-tuples in IPFIX flow records. Tunnel sampling is enabled
4784 The following enterprise entities report the sampled tunnel info:
4788 <dt>tunnelType:
</dt>
4790 <p>ID:
891, and enterprise ID
6876 (VMware).
</p>
4791 <p>type: unsigned
8-bit integer.
</p>
4792 <p>data type semantics: identifier.
</p>
4793 <p>description: Identifier of the layer
2 network overlay network
4794 encapsulation type:
0x01 VxLAN,
0x02 GRE,
0x03 LISP,
0x07 GENEVE.
</p>
4798 <p>ID:
892, and enterprise ID
6876 (VMware).
</p>
4799 <p>type: variable-length octetarray.
</p>
4800 <p>data type semantics: identifier.
</p>
4801 <p>description: Key which is used for identifying an individual
4802 traffic flow within a VxLAN (
24-bit VNI), GENEVE (
24-bit VNI),
4803 GRE (
32-bit key), or LISP (
24-bit instance ID) tunnel. The
4804 key is encoded in this octetarray as a
3-,
4-, or
8-byte integer
4805 ID in network byte order.
</p>
4807 <dt>tunnelSourceIPv4Address:
</dt>
4809 <p>ID:
893, and enterprise ID
6876 (VMware).
</p>
4810 <p>type: unsigned
32-bit integer.
</p>
4811 <p>data type semantics: identifier.
</p>
4812 <p>description: The IPv4 source address in the tunnel IP packet
4815 <dt>tunnelDestinationIPv4Address:
</dt>
4817 <p>ID:
894, and enterprise ID
6876 (VMware).
</p>
4818 <p>type: unsigned
32-bit integer.
</p>
4819 <p>data type semantics: identifier.
</p>
4820 <p>description: The IPv4 destination address in the tunnel IP
4823 <dt>tunnelProtocolIdentifier:
</dt>
4825 <p>ID:
895, and enterprise ID
6876 (VMware).
</p>
4826 <p>type: unsigned
8-bit integer.
</p>
4827 <p>data type semantics: identifier.
</p>
4828 <p>description: The value of the protocol number in the tunnel
4829 IP packet header. The protocol number identifies the tunnel IP
4830 packet payload type.
</p>
4832 <dt>tunnelSourceTransportPort:
</dt>
4834 <p>ID:
896, and enterprise ID
6876 (VMware).
</p>
4835 <p>type: unsigned
16-bit integer.
</p>
4836 <p>data type semantics: identifier.
</p>
4837 <p>description: The source port identifier in the tunnel transport
4838 header. For the transport protocols UDP, TCP, and SCTP, this is
4839 the source port number given in the respective header.
</p>
4841 <dt>tunnelDestinationTransportPort:
</dt>
4843 <p>ID:
897, and enterprise ID
6876 (VMware).
</p>
4844 <p>type: unsigned
16-bit integer.
</p>
4845 <p>data type semantics: identifier.
</p>
4846 <p>description: The destination port identifier in the tunnel
4847 transport header. For the transport protocols UDP, TCP, and SCTP,
4848 this is the destination port number given in the respective header.
4854 Before Open vSwitch
2.5.90,
<ref column=
"other_config"
4855 key=
"enable-tunnel-sampling"/> was only supported with per-bridge
4856 sampling, and ignored otherwise. Open vSwitch
2.5.90 and later support
4857 <ref column=
"other_config" key=
"enable-tunnel-sampling"/> for
4858 per-bridge and per-flow sampling.
4862 <column name=
"other_config" key=
"virtual_obs_id"
4863 type='{
"type":
"string"}'
>
4865 A string that accompanies each IPFIX flow record. Its intended use is
4866 for the ``virtual observation ID,'' an identifier of a virtual
4867 observation point that is locally unique in a virtual network. It
4868 describes a location in the virtual network where IP packets can be
4869 observed. The maximum length is
254 bytes. If not specified, the
4870 field is omitted from the IPFIX flow record.
4874 The following enterprise entity reports the specified virtual
4879 <dt>virtualObsID:
</dt>
4881 <p>ID:
898, and enterprise ID
6876 (VMware).
</p>
4882 <p>type: variable-length string.
</p>
4883 <p>data type semantics: identifier.
</p>
4884 <p>description: A virtual observation domain ID that is locally
4885 unique in a virtual network.
4891 This feature was introduced in Open vSwitch
2.5.90.
4895 <group title=
"Per-Bridge Sampling">
4897 These values affect only per-bridge sampling. See above for a
4898 description of the differences between per-bridge and flow-based
4902 <column name=
"sampling">
4903 The rate at which packets should be sampled and sent to each target
4904 collector. If not specified, defaults to
400, which means one out of
4905 400 packets, on average, will be sent to each target collector.
4908 <column name=
"obs_domain_id">
4909 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4910 specified, defaults to
0.
4913 <column name=
"obs_point_id">
4914 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4915 specified, defaults to
0.
4918 <column name=
"other_config" key=
"enable-input-sampling"
4919 type='{
"type":
"boolean"}'
>
4920 By default, Open vSwitch samples and reports flows at bridge port input
4921 in IPFIX flow records. Set this column to
<code>false
</code> to
4922 disable input sampling.
4925 <column name=
"other_config" key=
"enable-output-sampling"
4926 type='{
"type":
"boolean"}'
>
4927 By default, Open vSwitch samples and reports flows at bridge port
4928 output in IPFIX flow records. Set this column to
<code>false
</code> to
4929 disable output sampling.
4933 <group title=
"Common Columns">
4934 The overall purpose of these columns is described under
<code>Common
4935 Columns
</code> at the beginning of this document.
4937 <column name=
"external_ids"/>
4941 <table name=
"Flow_Sample_Collector_Set">
4943 A set of IPFIX collectors of packet samples generated by OpenFlow
4944 <code>sample
</code> actions. This table is used only for IPFIX
4945 flow-based sampling, not for per-bridge sampling (see the
<ref
4946 table=
"IPFIX"/> table for a description of the two forms).
4950 The ID of this collector set, unique among the bridge's
4951 collector sets, to be used as the
<code>collector_set_id
</code>
4952 in OpenFlow
<code>sample
</code> actions.
4955 <column name=
"bridge">
4956 The bridge into which OpenFlow
<code>sample
</code> actions can
4957 be added to send packet samples to this set of IPFIX collectors.
4960 <column name=
"ipfix">
4961 Configuration of the set of IPFIX collectors to send one flow
4962 record per sampled packet to.
4965 <group title=
"Common Columns">
4966 The overall purpose of these columns is described under
<code>Common
4967 Columns
</code> at the beginning of this document.
4969 <column name=
"external_ids"/>
4973 <table name=
"AutoAttach">
4975 Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4976 draft standard describes a compact method of using IEEE
802.1AB Link
4977 Layer Discovery Protocol (LLDP) together with a IEEE
802.1aq Shortest
4978 Path Bridging (SPB) network to automatically attach network devices
4979 to individual services in a SPB network. The intent here is to allow
4980 network applications and devices using OVS to be able to easily take
4981 advantage of features offered by industry standard SPB networks.
4985 Auto Attach (AA) uses LLDP to communicate between a directly connected
4986 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4987 is extended to add two new Type-Length-Value tuples (TLVs). The first
4988 new TLV supports the ongoing discovery of directly connected AA
4989 correspondents. Auto Attach operates by regularly transmitting AA
4990 discovery TLVs between the AA client and AA server. By exchanging these
4991 discovery messages, both the AAC and AAS learn the system name and
4992 system description of their peer. In the OVS context, OVS operates as
4993 the AA client and the AA server resides on a switch at the edge of the
4998 Once AA discovery has been completed the AAC then uses the second new TLV
4999 to deliver identifier mappings from the AAC to the AAS. A primary feature
5000 of Auto Attach is to facilitate the mapping of VLANs defined outside the
5001 SPB network onto service ids (ISIDs) defined within the SPM network. By
5002 doing so individual external VLANs can be mapped onto specific SPB
5003 network services. These VLAN id to ISID mappings can be configured and
5004 managed locally using new options added to the ovs-vsctl command.
5008 The Auto Attach OVS feature does not provide a full implementation of
5009 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
5010 standard and support for the AA TLV extensions is provided. LLDP
5011 protocol support in OVS can be enabled or disabled on a port by port
5012 basis. LLDP support is disabled by default.
5015 <column name=
"system_name">
5016 The system_name string is exported in LLDP messages. It should uniquely
5017 identify the bridge in the network.
5020 <column name=
"system_description">
5021 The system_description string is exported in LLDP messages. It should
5022 describe the type of software and hardware.
5025 <column name=
"mappings">
5026 A mapping from SPB network Individual Service Identifier (ISID) to VLAN