1 <?xml version="1.0" encoding="utf-8"?>
2 <database 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="other_config" key="stats-update-interval"
76 type='{"type": "integer", "minInteger": 5000}'>
78 Interval for updating statistics to the database, in milliseconds.
79 This option will affect the update of the <code>statistics</code>
80 column in the following tables: <code>Port</code>, <code>Interface
81 </code>, <code>Mirror</code>.
84 Default value is 5000 ms.
87 Getting statistics more frequently can be achieved via OpenFlow.
91 <column name="other_config" key="flow-restore-wait"
92 type='{"type": "boolean"}'>
94 When <code>ovs-vswitchd</code> starts up, it has an empty flow table
95 and therefore it handles all arriving packets in its default fashion
96 according to its configuration, by dropping them or sending them to
97 an OpenFlow controller or switching them as a standalone switch.
98 This behavior is ordinarily desirable. However, if
99 <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
100 then this leads to a relatively long period during which packets are
104 This option allows for improvement. When <code>ovs-vswitchd</code>
105 starts with this value set as <code>true</code>, it will neither
106 flush or expire previously set datapath flows nor will it send and
107 receive any packets to or from the datapath. When this value is
108 later set to <code>false</code>, <code>ovs-vswitchd</code> will
109 start receiving packets from the datapath and re-setup the flows.
112 Thus, with this option, the procedure for a hot-upgrade of
113 <code>ovs-vswitchd</code> becomes roughly the following:
117 Stop <code>ovs-vswitchd</code>.
120 Set <ref column="other_config" key="flow-restore-wait"/>
121 to <code>true</code>.
124 Start <code>ovs-vswitchd</code>.
127 Use <code>ovs-ofctl</code> (or some other program, such as an
128 OpenFlow controller) to restore the OpenFlow flow table
129 to the desired state.
132 Set <ref column="other_config" key="flow-restore-wait"/>
133 to <code>false</code> (or remove it entirely from the database).
137 The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
138 functions use the above config option during hot upgrades.
142 <column name="other_config" key="flow-limit"
143 type='{"type": "integer", "minInteger": 0}'>
146 number of flows allowed in the datapath flow table. Internally OVS
147 will choose a flow limit which will likely be lower than this number,
148 based on real time network conditions.
151 The default is 200000.
155 <column name="other_config" key="n-dpdk-rxqs"
156 type='{"type": "integer", "minInteger": 1}'>
158 Specifies the number of rx queues to be created for each dpdk
159 interface. If not specified or specified to 0, one rx queue will
160 be created for each dpdk interface by default.
164 <column name="other_config" key="pmd-cpu-mask">
166 Specifies CPU mask for setting the cpu affinity of PMD (Poll
167 Mode Driver) threads. Value should be in the form of hex string,
168 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
172 The lowest order bit corresponds to the first CPU core. A set bit
173 means the corresponding core is available and a pmd thread will be
174 created and pinned to it. If the input does not cover all cores,
175 those uncovered cores are considered not set.
178 If not specified, one pmd thread will be created for each numa node
179 and pinned to any available core on the numa node by default.
183 <column name="other_config" key="n-handler-threads"
184 type='{"type": "integer", "minInteger": 1}'>
186 Specifies the number of threads for software datapaths to use for
187 handling new flows. The default the number of online CPU cores minus
188 the number of revalidators.
191 This configuration is per datapath. If you have more than one
192 software datapath (e.g. some <code>system</code> bridges and some
193 <code>netdev</code> bridges), then the total number of threads is
194 <code>n-handler-threads</code> times the number of software
199 <column name="other_config" key="n-revalidator-threads"
200 type='{"type": "integer", "minInteger": 1}'>
202 Specifies the number of threads for software datapaths to use for
203 revalidating flows in the datapath. Typically, there is a direct
204 correlation between the number of revalidator threads, and the number
205 of flows allowed in the datapath. The default is the number of cpu
206 cores divided by four plus one. If <code>n-handler-threads</code> is
207 set, the default changes to the number of cpu cores minus the number
211 This configuration is per datapath. If you have more than one
212 software datapath (e.g. some <code>system</code> bridges and some
213 <code>netdev</code> bridges), then the total number of threads is
214 <code>n-handler-threads</code> times the number of software
220 <group title="Status">
221 <column name="next_cfg">
222 Sequence number for client to increment. When a client modifies
223 any part of the database configuration and wishes to wait for
224 Open vSwitch to finish applying the changes, it may increment
225 this sequence number.
228 <column name="cur_cfg">
229 Sequence number that Open vSwitch sets to the current value of
230 <ref column="next_cfg"/> after it finishes applying a set of
231 configuration changes.
234 <group title="Statistics">
236 The <code>statistics</code> column contains key-value pairs that
237 report statistics about a system running an Open vSwitch. These are
238 updated periodically (currently, every 5 seconds). Key-value pairs
239 that cannot be determined or that do not apply to a platform are
243 <column name="other_config" key="enable-statistics"
244 type='{"type": "boolean"}'>
245 Statistics are disabled by default to avoid overhead in the common
246 case when statistics gathering is not useful. Set this value to
247 <code>true</code> to enable populating the <ref column="statistics"/>
248 column or to <code>false</code> to explicitly disable it.
251 <column name="statistics" key="cpu"
252 type='{"type": "integer", "minInteger": 1}'>
254 Number of CPU processors, threads, or cores currently online and
255 available to the operating system on which Open vSwitch is running,
256 as an integer. This may be less than the number installed, if some
257 are not online or if they are not available to the operating
261 Open vSwitch userspace processes are not multithreaded, but the
262 Linux kernel-based datapath is.
266 <column name="statistics" key="load_average">
267 A comma-separated list of three floating-point numbers,
268 representing the system load average over the last 1, 5, and 15
269 minutes, respectively.
272 <column name="statistics" key="memory">
274 A comma-separated list of integers, each of which represents a
275 quantity of memory in kilobytes that describes the operating
276 system on which Open vSwitch is running. In respective order,
281 <li>Total amount of RAM allocated to the OS.</li>
282 <li>RAM allocated to the OS that is in use.</li>
283 <li>RAM that can be flushed out to disk or otherwise discarded
284 if that space is needed for another purpose. This number is
285 necessarily less than or equal to the previous value.</li>
286 <li>Total disk space allocated for swap.</li>
287 <li>Swap space currently in use.</li>
291 On Linux, all five values can be determined and are included. On
292 other operating systems, only the first two values can be
293 determined, so the list will only have two values.
297 <column name="statistics" key="process_NAME">
299 One such key-value pair, with <code>NAME</code> replaced by
300 a process name, will exist for each running Open vSwitch
301 daemon process, with <var>name</var> replaced by the
302 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
303 value is a comma-separated list of integers. The integers
304 represent the following, with memory measured in kilobytes
305 and durations in milliseconds:
309 <li>The process's virtual memory size.</li>
310 <li>The process's resident set size.</li>
311 <li>The amount of user and system CPU time consumed by the
313 <li>The number of times that the process has crashed and been
314 automatically restarted by the monitor.</li>
315 <li>The duration since the process was started.</li>
316 <li>The duration for which the process has been running.</li>
320 The interpretation of some of these values depends on whether the
321 process was started with the <option>--monitor</option>. If it
322 was not, then the crash count will always be 0 and the two
323 durations will always be the same. If <option>--monitor</option>
324 was given, then the crash count may be positive; if it is, the
325 latter duration is the amount of time since the most recent crash
330 There will be one key-value pair for each file in Open vSwitch's
331 ``run directory'' (usually <code>/var/run/openvswitch</code>)
332 whose name ends in <code>.pid</code>, whose contents are a
333 process ID, and which is locked by a running process. The
334 <var>name</var> is taken from the pidfile's name.
338 Currently Open vSwitch is only able to obtain all of the above
339 detail on Linux systems. On other systems, the same key-value
340 pairs will be present but the values will always be the empty
345 <column name="statistics" key="file_systems">
347 A space-separated list of information on local, writable file
348 systems. Each item in the list describes one file system and
349 consists in turn of a comma-separated list of the following:
353 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
354 Any spaces or commas in the mount point are replaced by
356 <li>Total size, in kilobytes, as an integer.</li>
357 <li>Amount of storage in use, in kilobytes, as an integer.</li>
361 This key-value pair is omitted if there are no local, writable
362 file systems or if Open vSwitch cannot obtain the needed
369 <group title="Version Reporting">
371 These columns report the types and versions of the hardware and
372 software running Open vSwitch. We recommend in general that software
373 should test whether specific features are supported instead of relying
374 on version number checks. These values are primarily intended for
375 reporting to human administrators.
378 <column name="ovs_version">
379 The Open vSwitch version number, e.g. <code>1.1.0</code>.
382 <column name="db_version">
384 The database schema version number in the form
385 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
386 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
387 a non-backward compatible way (e.g. deleting a column or a table),
388 <var>major</var> is incremented. When the database schema is changed
389 in a backward compatible way (e.g. adding a new column),
390 <var>minor</var> is incremented. When the database schema is changed
391 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
396 The schema version is part of the database schema, so it can also be
397 retrieved by fetching the schema using the Open vSwitch database
402 <column name="system_type">
404 An identifier for the type of system on top of which Open vSwitch
405 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
408 System integrators are responsible for choosing and setting an
409 appropriate value for this column.
413 <column name="system_version">
415 The version of the system identified by <ref column="system_type"/>,
416 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
419 System integrators are responsible for choosing and setting an
420 appropriate value for this column.
426 <group title="Database Configuration">
428 These columns primarily configure the Open vSwitch database
429 (<code>ovsdb-server</code>), not the Open vSwitch switch
430 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
431 column="ssl"/> settings.
435 The Open vSwitch switch does read the database configuration to
436 determine remote IP addresses to which in-band control should apply.
439 <column name="manager_options">
440 Database clients to which the Open vSwitch database server should
441 connect or to which it should listen, along with options for how these
442 connection should be configured. See the <ref table="Manager"/> table
443 for more information.
447 <group title="Common Columns">
448 The overall purpose of these columns is described under <code>Common
449 Columns</code> at the beginning of this document.
451 <column name="other_config"/>
452 <column name="external_ids"/>
456 <table name="Bridge">
458 Configuration for a bridge within an
459 <ref table="Open_vSwitch"/>.
462 A <ref table="Bridge"/> record represents an Ethernet switch with one or
463 more ``ports,'' which are the <ref table="Port"/> records pointed to by
464 the <ref table="Bridge"/>'s <ref column="ports"/> column.
467 <group title="Core Features">
469 Bridge identifier. Should be alphanumeric and no more than about 8
470 bytes long. Must be unique among the names of ports, interfaces, and
474 <column name="ports">
475 Ports included in the bridge.
478 <column name="mirrors">
479 Port mirroring configuration.
482 <column name="netflow">
483 NetFlow configuration.
486 <column name="sflow">
487 sFlow(R) configuration.
490 <column name="ipfix">
494 <column name="flood_vlans">
496 VLAN IDs of VLANs on which MAC address learning should be disabled,
497 so that packets are flooded instead of being sent to specific ports
498 that are believed to contain packets' destination MACs. This should
499 ordinarily be used to disable MAC learning on VLANs used for
500 mirroring (RSPAN VLANs). It may also be useful for debugging.
503 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
504 the <ref table="Port"/> table) is incompatible with
505 <code>flood_vlans</code>. Consider using another bonding mode or
506 a different type of mirror instead.
511 <group title="OpenFlow Configuration">
512 <column name="controller">
514 OpenFlow controller set. If unset, then no OpenFlow controllers
519 If there are primary controllers, removing all of them clears the
520 flow table. If there are no primary controllers, adding one also
521 clears the flow table. Other changes to the set of controllers, such
522 as adding or removing a service controller, adding another primary
523 controller to supplement an existing primary controller, or removing
524 only one of two primary controllers, have no effect on the flow
529 <column name="flow_tables">
530 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
531 table ID to configuration for that table.
534 <column name="fail_mode">
535 <p>When a controller is configured, it is, ordinarily, responsible
536 for setting up all flows on the switch. Thus, if the connection to
537 the controller fails, no new network connections can be set up.
538 If the connection to the controller stays down long enough,
539 no packets can pass through the switch at all. This setting
540 determines the switch's response to such a situation. It may be set
541 to one of the following:
543 <dt><code>standalone</code></dt>
544 <dd>If no message is received from the controller for three
545 times the inactivity probe interval
546 (see <ref column="inactivity_probe"/>), then Open vSwitch
547 will take over responsibility for setting up flows. In
548 this mode, Open vSwitch causes the bridge to act like an
549 ordinary MAC-learning switch. Open vSwitch will continue
550 to retry connecting to the controller in the background
551 and, when the connection succeeds, it will discontinue its
552 standalone behavior.</dd>
553 <dt><code>secure</code></dt>
554 <dd>Open vSwitch will not set up flows on its own when the
555 controller connection fails or when no controllers are
556 defined. The bridge will continue to retry connecting to
557 any defined controllers forever.</dd>
561 The default is <code>standalone</code> if the value is unset, but
562 future versions of Open vSwitch may change the default.
565 The <code>standalone</code> mode can create forwarding loops on a
566 bridge that has more than one uplink port unless STP is enabled. To
567 avoid loops on such a bridge, configure <code>secure</code> mode or
568 enable STP (see <ref column="stp_enable"/>).
570 <p>When more than one controller is configured,
571 <ref column="fail_mode"/> is considered only when none of the
572 configured controllers can be contacted.</p>
574 Changing <ref column="fail_mode"/> when no primary controllers are
575 configured clears the flow table.
579 <column name="datapath_id">
580 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
581 (Setting this column has no useful effect. Set <ref
582 column="other-config" key="datapath-id"/> instead.)
585 <column name="datapath_version">
587 Reports the version number of the Open vSwitch datapath in use.
588 This allows management software to detect and report discrepancies
589 between Open vSwitch userspace and datapath versions. (The <ref
590 column="ovs_version" table="Open_vSwitch"/> column in the <ref
591 table="Open_vSwitch"/> reports the Open vSwitch userspace version.)
592 The version reported depends on the datapath in use:
597 When the kernel module included in the Open vSwitch source tree is
598 used, this column reports the Open vSwitch version from which the
603 When the kernel module that is part of the upstream Linux kernel is
604 used, this column reports <code><unknown></code>.
608 When the datapath is built into the <code>ovs-vswitchd</code>
609 binary, this column reports <code><built-in></code>. A
610 built-in datapath is by definition the same version as the rest of
611 the Open VSwitch userspace.
615 Other datapaths (such as the Hyper-V kernel datapath) currently
616 report <code><unknown></code>.
621 A version discrepancy between <code>ovs-vswitchd</code> and the
622 datapath in use is not normally cause for alarm. The Open vSwitch
623 kernel datapaths for Linux and Hyper-V, in particular, are designed
624 for maximum inter-version compatibility: any userspace version works
625 with with any kernel version. Some reasons do exist to insist on
626 particular user/kernel pairings. First, newer kernel versions add
627 new features, that can only be used by new-enough userspace, e.g.
628 VXLAN tunneling requires certain minimal userspace and kernel
629 versions. Second, as an extension to the first reason, some newer
630 kernel versions add new features for enhancing performance that only
631 new-enough userspace versions can take advantage of.
635 <column name="other_config" key="datapath-id">
636 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
637 value. May not be all-zero.
640 <column name="other_config" key="dp-desc">
641 Human readable description of datapath. It it a maximum 256
642 byte-long free-form string to describe the datapath for
643 debugging purposes, e.g. <code>switch3 in room 3120</code>.
646 <column name="other_config" key="disable-in-band"
647 type='{"type": "boolean"}'>
648 If set to <code>true</code>, disable in-band control on the bridge
649 regardless of controller and manager settings.
652 <column name="other_config" key="in-band-queue"
653 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
654 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
655 that will be used by flows set up by in-band control on this bridge.
656 If unset, or if the port used by an in-band control flow does not have
657 QoS configured, or if the port does not have a queue with the specified
658 ID, the default queue is used instead.
661 <column name="protocols">
663 List of OpenFlow protocols that may be used when negotiating
664 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
665 1.3 are enabled by default if this column is empty.
669 OpenFlow 1.4 is not enabled by default because its implementation is
674 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
675 experimental because the OpenFlow 1.5 specification is still under
676 development and thus subject to change. Pass
677 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
678 OpenFlow 1.5 to be enabled.
683 <group title="Spanning Tree Configuration">
684 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
685 that ensures loop-free topologies. It allows redundant links to
686 be included in the network to provide automatic backup paths if
687 the active links fails.
689 <column name="stp_enable" type='{"type": "boolean"}'>
690 Enable spanning tree on the bridge. By default, STP is disabled
691 on bridges. Bond, internal, and mirror ports are not supported
692 and will not participate in the spanning tree.
695 <column name="other_config" key="stp-system-id">
696 The bridge's STP identifier (the lower 48 bits of the bridge-id)
698 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
699 By default, the identifier is the MAC address of the bridge.
702 <column name="other_config" key="stp-priority"
703 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
704 The bridge's relative priority value for determining the root
705 bridge (the upper 16 bits of the bridge-id). A bridge with the
706 lowest bridge-id is elected the root. By default, the priority
710 <column name="other_config" key="stp-hello-time"
711 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
712 The interval between transmissions of hello messages by
713 designated ports, in seconds. By default the hello interval is
717 <column name="other_config" key="stp-max-age"
718 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
719 The maximum age of the information transmitted by the bridge
720 when it is the root bridge, in seconds. By default, the maximum
724 <column name="other_config" key="stp-forward-delay"
725 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
726 The delay to wait between transitioning root and designated
727 ports to <code>forwarding</code>, in seconds. By default, the
728 forwarding delay is 15 seconds.
731 <column name="other_config" key="mcast-snooping-aging-time"
732 type='{"type": "integer", "minInteger": 1}'>
734 The maximum number of seconds to retain a multicast snooping entry for
735 which no packets have been seen. The default is currently 300
736 seconds (5 minutes). The value, if specified, is forced into a
737 reasonable range, currently 15 to 3600 seconds.
741 <column name="other_config" key="mcast-snooping-table-size"
742 type='{"type": "integer", "minInteger": 1}'>
744 The maximum number of multicast snooping addresses to learn. The
745 default is currently 2048. The value, if specified, is forced into
746 a reasonable range, currently 10 to 1,000,000.
749 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
750 type='{"type": "boolean"}'>
752 If set to <code>false</code>, unregistered multicast packets are forwarded
754 If set to <code>true</code>, unregistered multicast packets are forwarded
755 to ports connected to multicast routers.
760 <group title="Multicast Snooping Configuration">
761 Multicast snooping (RFC 4541) monitors the Internet Group Management
762 Protocol (IGMP) traffic between hosts and multicast routers. The
763 switch uses what IGMP snooping learns to forward multicast traffic
764 only to interfaces that are connected to interested receivers.
765 Currently it supports IGMPv1 and IGMPv2 protocols.
767 <column name="mcast_snooping_enable">
768 Enable multicast snooping on the bridge. For now, the default
773 <group title="Rapid Spanning Tree Configuration">
774 In IEEE Std 802.1D, 1998 Edition, and prior editions of this standard,
775 Clause 8 specified the spanning tree algorithm and protocol (STP). STP
776 has now been superseded by the Rapid Spanning Tree Protocol (RSTP)
777 specified in Clause 17 of the IEEE Std 802.1D, 2004 Edition.
778 The IEEE 802.1D-2004 Rapid Spanning Tree Algorithm Protocol configures
779 full, simple, and symmetric connectivity throughout a Bridged Local Area
780 Network that comprises individual LANs interconnected by Bridges.
781 Like STP, RSTP is a network protocol that ensures loop-free topologies.
782 It allows redundant links to be included in the network to provide
783 automatic backup paths if the active links fails.
785 <column name="rstp_enable" type='{"type": "boolean"}'>
786 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
787 on bridges. Bond, internal, and mirror ports are not supported
788 and will not participate in the spanning tree.
791 <column name="other_config" key="rstp-address">
792 The bridge's RSTP address (the lower 48 bits of the bridge-id)
794 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
795 By default, the address is the MAC address of the bridge.
798 <column name="other_config" key="rstp-priority"
799 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
800 The bridge's relative priority value for determining the root
801 bridge (the upper 16 bits of the bridge-id). A bridge with the
802 lowest bridge-id is elected the root. By default, the priority
803 is 0x8000 (32768). This value needs to be a multiple of 4096,
804 otherwise it's rounded to the nearest inferior one.
807 <column name="other_config" key="rstp-ageing-time"
808 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
809 The Ageing Time parameter for the Bridge. The default value
813 <column name="other_config" key="rstp-force-protocol-version"
814 type='{"type": "integer"}'>
815 The Force Protocol Version parameter for the Bridge. This
816 can take the value 0 (STP Compatibility mode) or 2
817 (the default, normal operation).
820 <column name="other_config" key="rstp-max-age"
821 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
822 The maximum age of the information transmitted by the Bridge
823 when it is the Root Bridge. The default value is 20.
826 <column name="other_config" key="rstp-forward-delay"
827 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
828 The delay used by STP Bridges to transition Root and Designated
829 Ports to Forwarding. The default value is 15.
832 <column name="other_config" key="rstp-transmit-hold-count"
833 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
834 The Transmit Hold Count used by the Port Transmit state machine
835 to limit transmission rate. The default value is 6.
840 <group title="Other Features">
841 <column name="datapath_type">
842 Name of datapath provider. The kernel datapath has
843 type <code>system</code>. The userspace datapath has
844 type <code>netdev</code>.
847 <column name="external_ids" key="bridge-id">
848 A unique identifier of the bridge. On Citrix XenServer this will
849 commonly be the same as
850 <ref column="external_ids" key="xs-network-uuids"/>.
853 <column name="external_ids" key="xs-network-uuids">
854 Semicolon-delimited set of universally unique identifier(s) for the
855 network with which this bridge is associated on a Citrix XenServer
856 host. The network identifiers are RFC 4122 UUIDs as displayed by,
857 e.g., <code>xe network-list</code>.
860 <column name="other_config" key="hwaddr">
861 An Ethernet address in the form
862 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
863 to set the hardware address of the local port and influence the
867 <column name="other_config" key="forward-bpdu"
868 type='{"type": "boolean"}'>
869 Option to allow forwarding of BPDU frames when NORMAL action is
870 invoked. Frames with reserved Ethernet addresses (e.g. STP
871 BPDU) will be forwarded when this option is enabled and the
872 switch is not providing that functionality. If STP is enabled
873 on the port, STP BPDUs will never be forwarded. If the Open
874 vSwitch bridge is used to connect different Ethernet networks,
875 and if Open vSwitch node does not run STP, then this option
876 should be enabled. Default is disabled, set to
877 <code>true</code> to enable.
879 The following destination MAC addresss will not be forwarded when this
882 <dt><code>01:80:c2:00:00:00</code></dt>
883 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
885 <dt><code>01:80:c2:00:00:01</code></dt>
886 <dd>IEEE Pause frame.</dd>
888 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
889 <dd>Other reserved protocols.</dd>
891 <dt><code>00:e0:2b:00:00:00</code></dt>
892 <dd>Extreme Discovery Protocol (EDP).</dd>
895 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
897 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
899 <dt><code>01:00:0c:cc:cc:cc</code></dt>
901 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
902 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
906 <dt><code>01:00:0c:cc:cc:cd</code></dt>
907 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
909 <dt><code>01:00:0c:cd:cd:cd</code></dt>
910 <dd>Cisco STP Uplink Fast.</dd>
912 <dt><code>01:00:0c:00:00:00</code></dt>
913 <dd>Cisco Inter Switch Link.</dd>
915 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
920 <column name="other_config" key="mac-aging-time"
921 type='{"type": "integer", "minInteger": 1}'>
923 The maximum number of seconds to retain a MAC learning entry for
924 which no packets have been seen. The default is currently 300
925 seconds (5 minutes). The value, if specified, is forced into a
926 reasonable range, currently 15 to 3600 seconds.
930 A short MAC aging time allows a network to more quickly detect that a
931 host is no longer connected to a switch port. However, it also makes
932 it more likely that packets will be flooded unnecessarily, when they
933 are addressed to a connected host that rarely transmits packets. To
934 reduce the incidence of unnecessary flooding, use a MAC aging time
935 longer than the maximum interval at which a host will ordinarily
940 <column name="other_config" key="mac-table-size"
941 type='{"type": "integer", "minInteger": 1}'>
943 The maximum number of MAC addresses to learn. The default is
944 currently 2048. The value, if specified, is forced into a reasonable
945 range, currently 10 to 1,000,000.
950 <group title="Bridge Status">
952 Status information about bridges.
954 <column name="status">
955 Key-value pairs that report bridge status.
957 <column name="status" key="stp_bridge_id">
959 The bridge-id (in hex) used in spanning tree advertisements.
960 Configuring the bridge-id is described in the
961 <code>stp-system-id</code> and <code>stp-priority</code> keys
962 of the <code>other_config</code> section earlier.
965 <column name="status" key="stp_designated_root">
967 The designated root (in hex) for this spanning tree.
970 <column name="status" key="stp_root_path_cost">
972 The path cost of reaching the designated bridge. A lower
978 <group title="Common Columns">
979 The overall purpose of these columns is described under <code>Common
980 Columns</code> at the beginning of this document.
982 <column name="other_config"/>
983 <column name="external_ids"/>
987 <table name="Port" table="Port or bond configuration.">
988 <p>A port within a <ref table="Bridge"/>.</p>
989 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
990 <ref column="interfaces"/> column. Such a port logically
991 corresponds to a port on a physical Ethernet switch. A port
992 with more than one interface is a ``bonded port'' (see
993 <ref group="Bonding Configuration"/>).</p>
994 <p>Some properties that one might think as belonging to a port are actually
995 part of the port's <ref table="Interface"/> members.</p>
998 Port name. Should be alphanumeric and no more than about 8
999 bytes long. May be the same as the interface name, for
1000 non-bonded ports. Must otherwise be unique among the names of
1001 ports, interfaces, and bridges on a host.
1004 <column name="interfaces">
1005 The port's interfaces. If there is more than one, this is a
1009 <group title="VLAN Configuration">
1010 <p>Bridge ports support the following types of VLAN configuration:</p>
1015 A trunk port carries packets on one or more specified VLANs
1016 specified in the <ref column="trunks"/> column (often, on every
1017 VLAN). A packet that ingresses on a trunk port is in the VLAN
1018 specified in its 802.1Q header, or VLAN 0 if the packet has no
1019 802.1Q header. A packet that egresses through a trunk port will
1020 have an 802.1Q header if it has a nonzero VLAN ID.
1024 Any packet that ingresses on a trunk port tagged with a VLAN that
1025 the port does not trunk is dropped.
1032 An access port carries packets on exactly one VLAN specified in the
1033 <ref column="tag"/> column. Packets egressing on an access port
1034 have no 802.1Q header.
1038 Any packet with an 802.1Q header with a nonzero VLAN ID that
1039 ingresses on an access port is dropped, regardless of whether the
1040 VLAN ID in the header is the access port's VLAN ID.
1044 <dt>native-tagged</dt>
1046 A native-tagged port resembles a trunk port, with the exception that
1047 a packet without an 802.1Q header that ingresses on a native-tagged
1048 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1052 <dt>native-untagged</dt>
1054 A native-untagged port resembles a native-tagged port, with the
1055 exception that a packet that egresses on a native-untagged port in
1056 the native VLAN will not have an 802.1Q header.
1060 A packet will only egress through bridge ports that carry the VLAN of
1061 the packet, as described by the rules above.
1064 <column name="vlan_mode">
1066 The VLAN mode of the port, as described above. When this column is
1067 empty, a default mode is selected as follows:
1071 If <ref column="tag"/> contains a value, the port is an access
1072 port. The <ref column="trunks"/> column should be empty.
1075 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1076 column value is honored if it is present.
1083 For an access port, the port's implicitly tagged VLAN. For a
1084 native-tagged or native-untagged port, the port's native VLAN. Must
1085 be empty if this is a trunk port.
1089 <column name="trunks">
1091 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1092 or VLANs that this port trunks; if it is empty, then the port trunks
1093 all VLANs. Must be empty if this is an access port.
1096 A native-tagged or native-untagged port always trunks its native
1097 VLAN, regardless of whether <ref column="trunks"/> includes that
1102 <column name="other_config" key="priority-tags"
1103 type='{"type": "boolean"}'>
1105 An 802.1Q header contains two important pieces of information: a VLAN
1106 ID and a priority. A frame with a zero VLAN ID, called a
1107 ``priority-tagged'' frame, is supposed to be treated the same way as
1108 a frame without an 802.1Q header at all (except for the priority).
1112 However, some network elements ignore any frame that has 802.1Q
1113 header at all, even when the VLAN ID is zero. Therefore, by default
1114 Open vSwitch does not output priority-tagged frames, instead omitting
1115 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1116 <code>true</code> to enable priority-tagged frames on a port.
1120 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1121 output if both the VLAN ID and priority would be zero.
1125 All frames output to native-tagged ports have a nonzero VLAN ID, so
1126 this setting is not meaningful on native-tagged ports.
1131 <group title="Bonding Configuration">
1132 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1133 allows for load balancing and fail-over.</p>
1136 The following types of bonding will work with any kind of upstream
1137 switch. On the upstream switch, do not configure the interfaces as a
1142 <dt><code>balance-slb</code></dt>
1144 Balances flows among slaves based on source MAC address and output
1145 VLAN, with periodic rebalancing as traffic patterns change.
1148 <dt><code>active-backup</code></dt>
1150 Assigns all flows to one slave, failing over to a backup slave when
1151 the active slave is disabled. This is the only bonding mode in which
1152 interfaces may be plugged into different upstream switches.
1157 The following modes require the upstream switch to support 802.3ad with
1158 successful LACP negotiation. If LACP negotiation fails and
1159 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1164 <dt><code>balance-tcp</code></dt>
1166 Balances flows among slaves based on L2, L3, and L4 protocol
1167 information such as destination MAC address, IP address, and TCP
1172 <p>These columns apply only to bonded ports. Their values are
1173 otherwise ignored.</p>
1175 <column name="bond_mode">
1176 <p>The type of bonding used for a bonded port. Defaults to
1177 <code>active-backup</code> if unset.
1181 <column name="other_config" key="bond-hash-basis"
1182 type='{"type": "integer"}'>
1183 An integer hashed along with flows when choosing output slaves in load
1184 balanced bonds. When changed, all flows will be assigned different
1185 hash values possibly causing slave selection decisions to change. Does
1186 not affect bonding modes which do not employ load balancing such as
1187 <code>active-backup</code>.
1190 <group title="Link Failure Detection">
1192 An important part of link bonding is detecting that links are down so
1193 that they may be disabled. These settings determine how Open vSwitch
1194 detects link failure.
1197 <column name="other_config" key="bond-detect-mode"
1198 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1199 The means used to detect link failures. Defaults to
1200 <code>carrier</code> which uses each interface's carrier to detect
1201 failures. When set to <code>miimon</code>, will check for failures
1202 by polling each interface's MII.
1205 <column name="other_config" key="bond-miimon-interval"
1206 type='{"type": "integer"}'>
1207 The interval, in milliseconds, between successive attempts to poll
1208 each interface's MII. Relevant only when <ref column="other_config"
1209 key="bond-detect-mode"/> is <code>miimon</code>.
1212 <column name="bond_updelay">
1214 The number of milliseconds for which the link must stay up on an
1215 interface before the interface is considered to be up. Specify
1216 <code>0</code> to enable the interface immediately.
1220 This setting is honored only when at least one bonded interface is
1221 already enabled. When no interfaces are enabled, then the first
1222 bond interface to come up is enabled immediately.
1226 <column name="bond_downdelay">
1227 The number of milliseconds for which the link must stay down on an
1228 interface before the interface is considered to be down. Specify
1229 <code>0</code> to disable the interface immediately.
1233 <group title="LACP Configuration">
1235 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1236 allows switches to automatically detect that they are connected by
1237 multiple links and aggregate across those links. These settings
1238 control LACP behavior.
1241 <column name="lacp">
1242 Configures LACP on this port. LACP allows directly connected
1243 switches to negotiate which links may be bonded. LACP may be enabled
1244 on non-bonded ports for the benefit of any switches they may be
1245 connected to. <code>active</code> ports are allowed to initiate LACP
1246 negotiations. <code>passive</code> ports are allowed to participate
1247 in LACP negotiations initiated by a remote switch, but not allowed to
1248 initiate such negotiations themselves. If LACP is enabled on a port
1249 whose partner switch does not support LACP, the bond will be
1250 disabled, unless other-config:lacp-fallback-ab is set to true.
1251 Defaults to <code>off</code> if unset.
1254 <column name="other_config" key="lacp-system-id">
1255 The LACP system ID of this <ref table="Port"/>. The system ID of a
1256 LACP bond is used to identify itself to its partners. Must be a
1257 nonzero MAC address. Defaults to the bridge Ethernet address if
1261 <column name="other_config" key="lacp-system-priority"
1262 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1263 The LACP system priority of this <ref table="Port"/>. In LACP
1264 negotiations, link status decisions are made by the system with the
1265 numerically lower priority.
1268 <column name="other_config" key="lacp-time"
1269 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1271 The LACP timing which should be used on this <ref table="Port"/>.
1272 By default <code>slow</code> is used. When configured to be
1273 <code>fast</code> LACP heartbeats are requested at a rate of once
1274 per second causing connectivity problems to be detected more
1275 quickly. In <code>slow</code> mode, heartbeats are requested at a
1276 rate of once every 30 seconds.
1280 <column name="other_config" key="lacp-fallback-ab"
1281 type='{"type": "boolean"}'>
1283 Determines the behavior of openvswitch bond in LACP mode. If
1284 the partner switch does not support LACP, setting this option
1285 to <code>true</code> allows openvswitch to fallback to
1286 active-backup. If the option is set to <code>false</code>, the
1287 bond will be disabled. In both the cases, once the partner switch
1288 is configured to LACP mode, the bond will use LACP.
1293 <group title="Rebalancing Configuration">
1295 These settings control behavior when a bond is in
1296 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1299 <column name="other_config" key="bond-rebalance-interval"
1300 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1301 For a load balanced bonded port, the number of milliseconds between
1302 successive attempts to rebalance the bond, that is, to move flows
1303 from one interface on the bond to another in an attempt to keep usage
1304 of each interface roughly equal. If zero, load balancing is disabled
1305 on the bond (link failure still cause flows to move). If
1306 less than 1000ms, the rebalance interval will be 1000ms.
1310 <column name="bond_fake_iface">
1311 For a bonded port, whether to create a fake internal interface with the
1312 name of the port. Use only for compatibility with legacy software that
1317 <group title="Spanning Tree Configuration">
1318 <column name="other_config" key="stp-enable"
1319 type='{"type": "boolean"}'>
1320 If spanning tree is enabled on the bridge, member ports are
1321 enabled by default (with the exception of bond, internal, and
1322 mirror ports which do not work with STP). If this column's
1323 value is <code>false</code> spanning tree is disabled on the
1327 <column name="other_config" key="stp-port-num"
1328 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1329 The port number used for the lower 8 bits of the port-id. By
1330 default, the numbers will be assigned automatically. If any
1331 port's number is manually configured on a bridge, then they
1335 <column name="other_config" key="stp-port-priority"
1336 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1337 The port's relative priority value for determining the root
1338 port (the upper 8 bits of the port-id). A port with a lower
1339 port-id will be chosen as the root port. By default, the
1343 <column name="other_config" key="stp-path-cost"
1344 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1345 Spanning tree path cost for the port. A lower number indicates
1346 a faster link. By default, the cost is based on the maximum
1351 <group title="Rapid Spanning Tree Configuration">
1352 <column name="other_config" key="rstp-enable"
1353 type='{"type": "boolean"}'>
1354 If rapid spanning tree is enabled on the bridge, member ports are
1355 enabled by default (with the exception of bond, internal, and
1356 mirror ports which do not work with RSTP). If this column's
1357 value is <code>false</code> rapid spanning tree is disabled on the
1361 <column name="other_config" key="rstp-port-priority"
1362 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1363 The port's relative priority value for determining the root
1364 port, in multiples of 16. By default, the port priority is 0x80
1365 (128). Any value in the lower 4 bits is rounded off. The significant
1366 upper 4 bits become the upper 4 bits of the port-id. A port with the
1367 lowest port-id is elected as the root.
1370 <column name="other_config" key="rstp-port-num"
1371 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1372 The local RSTP port number, used as the lower 12 bits of the port-id.
1373 By default the port numbers are assigned automatically, and typically
1374 may not correspond to the OpenFlow port numbers. A port with the
1375 lowest port-id is elected as the root.
1378 <column name="other_config" key="rstp-port-path-cost"
1379 type='{"type": "integer"}'>
1380 The port path cost. The Port's contribution, when it is
1381 the Root Port, to the Root Path Cost for the Bridge. By default the
1382 cost is automatically calculated from the port's speed.
1385 <column name="other_config" key="rstp-port-admin-edge"
1386 type='{"type": "boolean"}'>
1387 The admin edge port parameter for the Port. Default is
1391 <column name="other_config" key="rstp-port-auto-edge"
1392 type='{"type": "boolean"}'>
1393 The auto edge port parameter for the Port. Default is
1397 <column name="other_config" key="rstp-port-mcheck"
1398 type='{"type": "boolean"}'>
1400 The mcheck port parameter for the Port. Default is
1401 <code>false</code>. May be set to force the Port Protocol
1402 Migration state machine to transmit RST BPDUs for a
1403 MigrateTime period, to test whether all STP Bridges on the
1404 attached LAN have been removed and the Port can continue to
1405 transmit RSTP BPDUs. Setting mcheck has no effect if the
1406 Bridge is operating in STP Compatibility mode.
1409 Changing the value from <code>true</code> to
1410 <code>false</code> has no effect, but needs to be done if
1411 this behavior is to be triggered again by subsequently
1412 changing the value from <code>false</code> to
1418 <group title="Multicast Snooping">
1419 <column name="other_config" key="mcast-snooping-flood"
1420 type='{"type": "boolean"}'>
1422 If set to <code>true</code>, multicast packets (except Reports) are
1423 unconditionally forwarded to the specific port.
1426 <column name="other_config" key="mcast-snooping-flood-reports"
1427 type='{"type": "boolean"}'>
1429 If set to <code>true</code>, multicast Reports are unconditionally
1430 forwarded to the specific port.
1435 <group title="Other Features">
1437 Quality of Service configuration for this port.
1441 The MAC address to use for this port for the purpose of choosing the
1442 bridge's MAC address. This column does not necessarily reflect the
1443 port's actual MAC address, nor will setting it change the port's actual
1447 <column name="fake_bridge">
1448 Does this port represent a sub-bridge for its tagged VLAN within the
1449 Bridge? See ovs-vsctl(8) for more information.
1452 <column name="external_ids" key="fake-bridge-id-*">
1453 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1454 column) are defined by prefixing a <ref table="Bridge"/> <ref
1455 table="Bridge" column="external_ids"/> key with
1456 <code>fake-bridge-</code>,
1457 e.g. <code>fake-bridge-xs-network-uuids</code>.
1461 <group title="Port Status">
1463 Status information about ports attached to bridges.
1465 <column name="status">
1466 Key-value pairs that report port status.
1468 <column name="status" key="stp_port_id">
1470 The port-id (in hex) used in spanning tree advertisements for
1471 this port. Configuring the port-id is described in the
1472 <code>stp-port-num</code> and <code>stp-port-priority</code>
1473 keys of the <code>other_config</code> section earlier.
1476 <column name="status" key="stp_state"
1477 type='{"type": "string", "enum": ["set",
1478 ["disabled", "listening", "learning",
1479 "forwarding", "blocking"]]}'>
1481 STP state of the port.
1484 <column name="status" key="stp_sec_in_state"
1485 type='{"type": "integer", "minInteger": 0}'>
1487 The amount of time (in seconds) port has been in the current
1491 <column name="status" key="stp_role"
1492 type='{"type": "string", "enum": ["set",
1493 ["root", "designated", "alternate"]]}'>
1495 STP role of the port.
1499 <column name="status" key="bond_active_slave">
1501 For a bonded port, record the mac address of the current active slave.
1507 <group title="Port Statistics">
1509 Key-value pairs that report port statistics. The update period
1510 is controlled by <ref column="other_config"
1511 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1513 <group title="Statistics: STP transmit and receive counters">
1514 <column name="statistics" key="stp_tx_count">
1515 Number of STP BPDUs sent on this port by the spanning
1518 <column name="statistics" key="stp_rx_count">
1519 Number of STP BPDUs received on this port and accepted by the
1520 spanning tree library.
1522 <column name="statistics" key="stp_error_count">
1523 Number of bad STP BPDUs received on this port. Bad BPDUs
1524 include runt packets and those with an unexpected protocol ID.
1529 <group title="Common Columns">
1530 The overall purpose of these columns is described under <code>Common
1531 Columns</code> at the beginning of this document.
1533 <column name="other_config"/>
1534 <column name="external_ids"/>
1538 <table name="Interface" title="One physical network device in a Port.">
1539 An interface within a <ref table="Port"/>.
1541 <group title="Core Features">
1542 <column name="name">
1543 Interface name. Should be alphanumeric and no more than about 8 bytes
1544 long. May be the same as the port name, for non-bonded ports. Must
1545 otherwise be unique among the names of ports, interfaces, and bridges
1549 <column name="ifindex">
1550 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1551 2863, if the interface has one, otherwise 0. The ifindex is useful for
1552 seamless integration with protocols such as SNMP and sFlow.
1555 <column name="mac_in_use">
1556 The MAC address in use by this interface.
1560 <p>Ethernet address to set for this interface. If unset then the
1561 default MAC address is used:</p>
1563 <li>For the local interface, the default is the lowest-numbered MAC
1564 address among the other bridge ports, either the value of the
1565 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1566 if set, or its actual MAC (for bonded ports, the MAC of its slave
1567 whose name is first in alphabetical order). Internal ports and
1568 bridge ports that are used as port mirroring destinations (see the
1569 <ref table="Mirror"/> table) are ignored.</li>
1570 <li>For other internal interfaces, the default MAC is randomly
1572 <li>External interfaces typically have a MAC address associated with
1573 their hardware.</li>
1575 <p>Some interfaces may not have a software-controllable MAC
1579 <column name="error">
1580 If the configuration of the port failed, as indicated by -1 in <ref
1581 column="ofport"/>, Open vSwitch sets this column to an error
1582 description in human readable form. Otherwise, Open vSwitch clears
1586 <group title="OpenFlow Port Number">
1588 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1589 port number for the new port. If the client that adds the port fills
1590 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1591 value as the OpenFlow port number. Otherwise, or if the requested
1592 port number is already in use or cannot be used for another reason,
1593 Open vSwitch automatically assigns a free port number. Regardless of
1594 how the port number was obtained, Open vSwitch then reports in <ref
1595 column="ofport"/> the port number actually assigned.
1599 Open vSwitch limits the port numbers that it automatically assigns to
1600 the range 1 through 32,767, inclusive. Controllers therefore have
1601 free use of ports 32,768 and up.
1604 <column name="ofport">
1606 OpenFlow port number for this interface. Open vSwitch sets this
1607 column's value, so other clients should treat it as read-only.
1610 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1611 The other valid port numbers are in the range 1 to 65,279,
1612 inclusive. Value -1 indicates an error adding the interface.
1616 <column name="ofport_request"
1617 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1619 Requested OpenFlow port number for this interface.
1623 A client should ideally set this column's value in the same
1624 database transaction that it uses to create the interface. Open
1625 vSwitch version 2.1 and later will honor a later request for a
1626 specific port number, althuogh it might confuse some controllers:
1627 OpenFlow does not have a way to announce a port number change, so
1628 Open vSwitch represents it over OpenFlow as a port deletion
1629 followed immediately by a port addition.
1633 If <ref column="ofport_request"/> is set or changed to some other
1634 port's automatically assigned port number, Open vSwitch chooses a
1635 new port number for the latter port.
1641 <group title="System-Specific Details">
1642 <column name="type">
1644 The interface type, one of:
1648 <dt><code>system</code></dt>
1649 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1650 Sometimes referred to as ``external interfaces'' since they are
1651 generally connected to hardware external to that on which the Open
1652 vSwitch is running. The empty string is a synonym for
1653 <code>system</code>.</dd>
1655 <dt><code>internal</code></dt>
1656 <dd>A simulated network device that sends and receives traffic. An
1657 internal interface whose <ref column="name"/> is the same as its
1658 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1659 ``local interface.'' It does not make sense to bond an internal
1660 interface, so the terms ``port'' and ``interface'' are often used
1661 imprecisely for internal interfaces.</dd>
1663 <dt><code>tap</code></dt>
1664 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1666 <dt><code>geneve</code></dt>
1668 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1671 Geneve supports options as a means to transport additional metadata,
1672 however, currently only the 24-bit VNI is supported. This is planned
1673 to be extended in the future.
1676 <dt><code>gre</code></dt>
1678 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1682 <dt><code>ipsec_gre</code></dt>
1684 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1688 <dt><code>gre64</code></dt>
1690 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1691 of key, it uses GRE protocol sequence number field. This is non
1692 standard use of GRE protocol since OVS does not increment
1693 sequence number for every packet at time of encap as expected by
1694 standard GRE implementation. See <ref group="Tunnel Options"/>
1695 for information on configuring GRE tunnels.
1698 <dt><code>ipsec_gre64</code></dt>
1700 Same as IPSEC_GRE except 64 bit key.
1703 <dt><code>vxlan</code></dt>
1706 An Ethernet tunnel over the experimental, UDP-based VXLAN
1707 protocol described at
1708 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1711 Open vSwitch uses UDP destination port 4789. The source port used for
1712 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1717 <dt><code>lisp</code></dt>
1720 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1721 Separation Protocol (RFC 6830).
1724 Only IPv4 and IPv6 packets are supported by the protocol, and
1725 they are sent and received without an Ethernet header. Traffic
1726 to/from LISP ports is expected to be configured explicitly, and
1727 the ports are not intended to participate in learning based
1728 switching. As such, they are always excluded from packet
1733 <dt><code>patch</code></dt>
1735 A pair of virtual devices that act as a patch cable.
1738 <dt><code>null</code></dt>
1739 <dd>An ignored interface. Deprecated and slated for removal in
1745 <group title="Tunnel Options">
1747 These options apply to interfaces with <ref column="type"/> of
1748 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1749 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1750 and <code>lisp</code>.
1754 Each tunnel must be uniquely identified by the combination of <ref
1755 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1756 column="options" key="local_ip"/>, and <ref column="options"
1757 key="in_key"/>. If two ports are defined that are the same except one
1758 has an optional identifier and the other does not, the more specific
1759 one is matched first. <ref column="options" key="in_key"/> is
1760 considered more specific than <ref column="options" key="local_ip"/> if
1761 a port defines one and another port defines the other.
1764 <column name="options" key="remote_ip">
1765 <p>Required. The remote tunnel endpoint, one of:</p>
1769 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1770 Only unicast endpoints are supported.
1773 The word <code>flow</code>. The tunnel accepts packets from any
1774 remote tunnel endpoint. To process only packets from a specific
1775 remote tunnel endpoint, the flow entries may match on the
1776 <code>tun_src</code> field. When sending packets to a
1777 <code>remote_ip=flow</code> tunnel, the flow actions must
1778 explicitly set the <code>tun_dst</code> field to the IP address of
1779 the desired remote tunnel endpoint, e.g. with a
1780 <code>set_field</code> action.
1785 The remote tunnel endpoint for any packet received from a tunnel
1786 is available in the <code>tun_src</code> field for matching in the
1791 <column name="options" key="local_ip">
1793 Optional. The tunnel destination IP that received packets must
1794 match. Default is to match all addresses. If specified, may be one
1800 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1803 The word <code>flow</code>. The tunnel accepts packets sent to any
1804 of the local IP addresses of the system running OVS. To process
1805 only packets sent to a specific IP address, the flow entries may
1806 match on the <code>tun_dst</code> field. When sending packets to a
1807 <code>local_ip=flow</code> tunnel, the flow actions may
1808 explicitly set the <code>tun_src</code> field to the desired IP
1809 address, e.g. with a <code>set_field</code> action. However, while
1810 routing the tunneled packet out, the local system may override the
1811 specified address with the local IP address configured for the
1812 outgoing system interface.
1815 This option is valid only for tunnels also configured with the
1816 <code>remote_ip=flow</code> option.
1822 The tunnel destination IP address for any packet received from a
1823 tunnel is available in the <code>tun_dst</code> field for matching in
1828 <column name="options" key="in_key">
1829 <p>Optional. The key that received packets must contain, one of:</p>
1833 <code>0</code>. The tunnel receives packets with no key or with a
1834 key of 0. This is equivalent to specifying no <ref column="options"
1835 key="in_key"/> at all.
1838 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
1839 or 64-bit (for GRE64) number. The tunnel receives only packets
1840 with the specified key.
1843 The word <code>flow</code>. The tunnel accepts packets with any
1844 key. The key will be placed in the <code>tun_id</code> field for
1845 matching in the flow table. The <code>ovs-ofctl</code> manual page
1846 contains additional information about matching fields in OpenFlow
1855 <column name="options" key="out_key">
1856 <p>Optional. The key to be set on outgoing packets, one of:</p>
1860 <code>0</code>. Packets sent through the tunnel will have no key.
1861 This is equivalent to specifying no <ref column="options"
1862 key="out_key"/> at all.
1865 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
1866 64-bit (for GRE64) number. Packets sent through the tunnel will
1867 have the specified key.
1870 The word <code>flow</code>. Packets sent through the tunnel will
1871 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1872 vendor extension (0 is used in the absence of an action). The
1873 <code>ovs-ofctl</code> manual page contains additional information
1874 about the Nicira OpenFlow vendor extensions.
1879 <column name="options" key="key">
1880 Optional. Shorthand to set <code>in_key</code> and
1881 <code>out_key</code> at the same time.
1884 <column name="options" key="tos">
1885 Optional. The value of the ToS bits to be set on the encapsulating
1886 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1887 zero. It may also be the word <code>inherit</code>, in which case
1888 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1889 (otherwise it will be 0). The ECN fields are always inherited.
1893 <column name="options" key="ttl">
1894 Optional. The TTL to be set on the encapsulating packet. It may also
1895 be the word <code>inherit</code>, in which case the TTL will be copied
1896 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1897 system default, typically 64). Default is the system default TTL.
1900 <column name="options" key="df_default"
1901 type='{"type": "boolean"}'>
1902 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1903 outer headers to allow path MTU discovery. Default is enabled; set
1904 to <code>false</code> to disable.
1907 <group title="Tunnel Options: vxlan only">
1909 <column name="options" key="exts">
1910 <p>Optional. Comma separated list of optional VXLAN extensions to
1911 enable. The following extensions are supported:</p>
1915 <code>gbp</code>: VXLAN-GBP allows to transport the group policy
1916 context of a packet across the VXLAN tunnel to other network
1917 peers. See the field description of <code>tun_gbp_id</code> and
1918 <code>tun_gbp_flags</code> in ovs-ofctl(8) for additional
1920 (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>)
1927 <group title="Tunnel Options: gre and ipsec_gre only">
1929 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1933 <column name="options" key="csum" type='{"type": "boolean"}'>
1935 Optional. Compute GRE checksums on outgoing packets. Default is
1936 disabled, set to <code>true</code> to enable. Checksums present on
1937 incoming packets will be validated regardless of this setting.
1941 GRE checksums impose a significant performance penalty because they
1942 cover the entire packet. The encapsulated L3, L4, and L7 packet
1943 contents typically have their own checksums, so this additional
1944 checksum only adds value for the GRE and encapsulated L2 headers.
1948 This option is supported for <code>ipsec_gre</code>, but not useful
1949 because GRE checksums are weaker than, and redundant with, IPsec
1950 payload authentication.
1955 <group title="Tunnel Options: ipsec_gre only">
1957 Only <code>ipsec_gre</code> interfaces support these options.
1960 <column name="options" key="peer_cert">
1961 Required for certificate authentication. A string containing the
1962 peer's certificate in PEM format. Additionally the host's
1963 certificate must be specified with the <code>certificate</code>
1967 <column name="options" key="certificate">
1968 Required for certificate authentication. The name of a PEM file
1969 containing a certificate that will be presented to the peer during
1973 <column name="options" key="private_key">
1974 Optional for certificate authentication. The name of a PEM file
1975 containing the private key associated with <code>certificate</code>.
1976 If <code>certificate</code> contains the private key, this option may
1980 <column name="options" key="psk">
1981 Required for pre-shared key authentication. Specifies a pre-shared
1982 key for authentication that must be identical on both sides of the
1988 <group title="Patch Options">
1990 Only <code>patch</code> interfaces support these options.
1993 <column name="options" key="peer">
1994 The <ref column="name"/> of the <ref table="Interface"/> for the other
1995 side of the patch. The named <ref table="Interface"/>'s own
1996 <code>peer</code> option must specify this <ref table="Interface"/>'s
1997 name. That is, the two patch interfaces must have reversed <ref
1998 column="name"/> and <code>peer</code> values.
2002 <group title="Interface Status">
2004 Status information about interfaces attached to bridges, updated every
2005 5 seconds. Not all interfaces have all of these properties; virtual
2006 interfaces don't have a link speed, for example. Non-applicable
2007 columns will have empty values.
2009 <column name="admin_state">
2011 The administrative state of the physical network link.
2015 <column name="link_state">
2017 The observed state of the physical network link. This is ordinarily
2018 the link's carrier status. If the interface's <ref table="Port"/> is
2019 a bond configured for miimon monitoring, it is instead the network
2020 link's miimon status.
2024 <column name="link_resets">
2026 The number of times Open vSwitch has observed the
2027 <ref column="link_state"/> of this <ref table="Interface"/> change.
2031 <column name="link_speed">
2033 The negotiated speed of the physical network link.
2034 Valid values are positive integers greater than 0.
2038 <column name="duplex">
2040 The duplex mode of the physical network link.
2046 The MTU (maximum transmission unit); i.e. the largest
2047 amount of data that can fit into a single Ethernet frame.
2048 The standard Ethernet MTU is 1500 bytes. Some physical media
2049 and many kinds of virtual interfaces can be configured with
2053 This column will be empty for an interface that does not
2054 have an MTU as, for example, some kinds of tunnels do not.
2058 <column name="lacp_current">
2059 Boolean value indicating LACP status for this interface. If true, this
2060 interface has current LACP information about its LACP partner. This
2061 information may be used to monitor the health of interfaces in a LACP
2062 enabled port. This column will be empty if LACP is not enabled.
2065 <column name="status">
2066 Key-value pairs that report port status. Supported status values are
2067 <ref column="type"/>-dependent; some interfaces may not have a valid
2068 <ref column="status" key="driver_name"/>, for example.
2071 <column name="status" key="driver_name">
2072 The name of the device driver controlling the network adapter.
2075 <column name="status" key="driver_version">
2076 The version string of the device driver controlling the network
2080 <column name="status" key="firmware_version">
2081 The version string of the network adapter's firmware, if available.
2084 <column name="status" key="source_ip">
2085 The source IP address used for an IPv4 tunnel end-point, such as
2089 <column name="status" key="tunnel_egress_iface">
2090 Egress interface for tunnels. Currently only relevant for tunnels
2091 on Linux systems, this column will show the name of the interface
2092 which is responsible for routing traffic destined for the configured
2093 <ref column="options" key="remote_ip"/>. This could be an internal
2094 interface such as a bridge port.
2097 <column name="status" key="tunnel_egress_iface_carrier"
2098 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2099 Whether carrier is detected on <ref column="status"
2100 key="tunnel_egress_iface"/>.
2104 <group title="Statistics">
2106 Key-value pairs that report interface statistics. The current
2107 implementation updates these counters periodically. The update period
2108 is controlled by <ref column="other_config"
2109 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2110 Future implementations may update them when an interface is created,
2111 when they are queried (e.g. using an OVSDB <code>select</code>
2112 operation), and just before an interface is deleted due to virtual
2113 interface hot-unplug or VM shutdown, and perhaps at other times, but
2114 not on any regular periodic basis.
2117 These are the same statistics reported by OpenFlow in its <code>struct
2118 ofp_port_stats</code> structure. If an interface does not support a
2119 given statistic, then that pair is omitted.
2121 <group title="Statistics: Successful transmit and receive counters">
2122 <column name="statistics" key="rx_packets">
2123 Number of received packets.
2125 <column name="statistics" key="rx_bytes">
2126 Number of received bytes.
2128 <column name="statistics" key="tx_packets">
2129 Number of transmitted packets.
2131 <column name="statistics" key="tx_bytes">
2132 Number of transmitted bytes.
2135 <group title="Statistics: Receive errors">
2136 <column name="statistics" key="rx_dropped">
2137 Number of packets dropped by RX.
2139 <column name="statistics" key="rx_frame_err">
2140 Number of frame alignment errors.
2142 <column name="statistics" key="rx_over_err">
2143 Number of packets with RX overrun.
2145 <column name="statistics" key="rx_crc_err">
2146 Number of CRC errors.
2148 <column name="statistics" key="rx_errors">
2149 Total number of receive errors, greater than or equal to the sum of
2153 <group title="Statistics: Transmit errors">
2154 <column name="statistics" key="tx_dropped">
2155 Number of packets dropped by TX.
2157 <column name="statistics" key="collisions">
2158 Number of collisions.
2160 <column name="statistics" key="tx_errors">
2161 Total number of transmit errors, greater than or equal to the sum of
2167 <group title="Ingress Policing">
2169 These settings control ingress policing for packets received on this
2170 interface. On a physical interface, this limits the rate at which
2171 traffic is allowed into the system from the outside; on a virtual
2172 interface (one connected to a virtual machine), this limits the rate at
2173 which the VM is able to transmit.
2176 Policing is a simple form of quality-of-service that simply drops
2177 packets received in excess of the configured rate. Due to its
2178 simplicity, policing is usually less accurate and less effective than
2179 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2180 table="Queue"/> tables).
2183 Policing is currently implemented only on Linux. The Linux
2184 implementation uses a simple ``token bucket'' approach:
2188 The size of the bucket corresponds to <ref
2189 column="ingress_policing_burst"/>. Initially the bucket is full.
2192 Whenever a packet is received, its size (converted to tokens) is
2193 compared to the number of tokens currently in the bucket. If the
2194 required number of tokens are available, they are removed and the
2195 packet is forwarded. Otherwise, the packet is dropped.
2198 Whenever it is not full, the bucket is refilled with tokens at the
2199 rate specified by <ref column="ingress_policing_rate"/>.
2203 Policing interacts badly with some network protocols, and especially
2204 with fragmented IP packets. Suppose that there is enough network
2205 activity to keep the bucket nearly empty all the time. Then this token
2206 bucket algorithm will forward a single packet every so often, with the
2207 period depending on packet size and on the configured rate. All of the
2208 fragments of an IP packets are normally transmitted back-to-back, as a
2209 group. In such a situation, therefore, only one of these fragments
2210 will be forwarded and the rest will be dropped. IP does not provide
2211 any way for the intended recipient to ask for only the remaining
2212 fragments. In such a case there are two likely possibilities for what
2213 will happen next: either all of the fragments will eventually be
2214 retransmitted (as TCP will do), in which case the same problem will
2215 recur, or the sender will not realize that its packet has been dropped
2216 and data will simply be lost (as some UDP-based protocols will do).
2217 Either way, it is possible that no forward progress will ever occur.
2219 <column name="ingress_policing_rate">
2221 Maximum rate for data received on this interface, in kbps. Data
2222 received faster than this rate is dropped. Set to <code>0</code>
2223 (the default) to disable policing.
2227 <column name="ingress_policing_burst">
2228 <p>Maximum burst size for data received on this interface, in kb. The
2229 default burst size if set to <code>0</code> is 1000 kb. This value
2230 has no effect if <ref column="ingress_policing_rate"/>
2231 is <code>0</code>.</p>
2233 Specifying a larger burst size lets the algorithm be more forgiving,
2234 which is important for protocols like TCP that react severely to
2235 dropped packets. The burst size should be at least the size of the
2236 interface's MTU. Specifying a value that is numerically at least as
2237 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2238 closer to achieving the full rate.
2243 <group title="Bidirectional Forwarding Detection (BFD)">
2245 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2246 detection of connectivity failures by occasional transmission of
2247 BFD control messages. Open vSwitch implements BFD to serve
2248 as a more popular and standards compliant alternative to CFM.
2252 BFD operates by regularly transmitting BFD control messages at a rate
2253 negotiated independently in each direction. Each endpoint specifies
2254 the rate at which it expects to receive control messages, and the rate
2255 at which it is willing to transmit them. Open vSwitch uses a detection
2256 multiplier of three, meaning that an endpoint signals a connectivity
2257 fault if three consecutive BFD control messages fail to arrive. In the
2258 case of a unidirectional connectivity issue, the system not receiving
2259 BFD control messages signals the problem to its peer in the messages it
2264 The Open vSwitch implementation of BFD aims to comply faithfully
2265 with RFC 5880 requirements. Open vSwitch does not implement the
2266 optional Authentication or ``Echo Mode'' features.
2269 <group title="BFD Configuration">
2271 A controller sets up key-value pairs in the <ref column="bfd"/>
2272 column to enable and configure BFD.
2275 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2276 True to enable BFD on this <ref table="Interface"/>. If not
2277 specified, BFD will not be enabled by default.
2280 <column name="bfd" key="min_rx"
2281 type='{"type": "integer", "minInteger": 1}'>
2282 The shortest interval, in milliseconds, at which this BFD session
2283 offers to receive BFD control messages. The remote endpoint may
2284 choose to send messages at a slower rate. Defaults to
2288 <column name="bfd" key="min_tx"
2289 type='{"type": "integer", "minInteger": 1}'>
2290 The shortest interval, in milliseconds, at which this BFD session is
2291 willing to transmit BFD control messages. Messages will actually be
2292 transmitted at a slower rate if the remote endpoint is not willing to
2293 receive as quickly as specified. Defaults to <code>100</code>.
2296 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2297 An alternate receive interval, in milliseconds, that must be greater
2298 than or equal to <ref column="bfd" key="min_rx"/>. The
2299 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2300 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2301 data traffic at the interface, to reduce the CPU and bandwidth cost
2302 of monitoring an idle interface. This feature may be disabled by
2303 setting a value of 0. This feature is reset whenever <ref
2304 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2308 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2309 When <code>true</code>, traffic received on the
2310 <ref table="Interface"/> is used to indicate the capability of packet
2311 I/O. BFD control packets are still transmitted and received. At
2312 least one BFD control packet must be received every 100 * <ref
2313 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2314 traffic are received, the <ref column="bfd" key="forwarding"/>
2315 will be <code>false</code>.
2318 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2319 Set to true to notify the remote endpoint that traffic should not be
2320 forwarded to this system for some reason other than a connectivty
2321 failure on the interface being monitored. The typical underlying
2322 reason is ``concatenated path down,'' that is, that connectivity
2323 beyond the local system is down. Defaults to false.
2326 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2327 Set to true to make BFD accept only control messages with a tunnel
2328 key of zero. By default, BFD accepts control messages with any
2332 <column name="bfd" key="bfd_local_src_mac">
2333 Set to an Ethernet address in the form
2334 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2335 to set the MAC used as source for transmitted BFD packets. The
2336 default is the mac address of the BFD enabled interface.
2339 <column name="bfd" key="bfd_local_dst_mac">
2340 Set to an Ethernet address in the form
2341 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2342 to set the MAC used as destination for transmitted BFD packets. The
2343 default is <code>00:23:20:00:00:01</code>.
2346 <column name="bfd" key="bfd_remote_dst_mac">
2347 Set to an Ethernet address in the form
2348 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2349 to set the MAC used for checking the destination of received BFD packets.
2350 Packets with different destination MAC will not be considered as BFD packets.
2351 If not specified the destination MAC address of received BFD packets
2355 <column name="bfd" key="bfd_src_ip">
2356 Set to an IPv4 address to set the IP address used as source for
2357 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2360 <column name="bfd" key="bfd_dst_ip">
2361 Set to an IPv4 address to set the IP address used as destination
2362 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2366 <group title="BFD Status">
2368 The switch sets key-value pairs in the <ref column="bfd_status"/>
2369 column to report the status of BFD on this interface. When BFD is
2370 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2371 all key-value pairs from <ref column="bfd_status"/>.
2374 <column name="bfd_status" key="state"
2375 type='{"type": "string",
2376 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2377 Reports the state of the BFD session. The BFD session is fully
2378 healthy and negotiated if <code>UP</code>.
2381 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2382 Reports whether the BFD session believes this <ref
2383 table="Interface"/> may be used to forward traffic. Typically this
2384 means the local session is signaling <code>UP</code>, and the remote
2385 system isn't signaling a problem such as concatenated path down.
2388 <column name="bfd_status" key="diagnostic">
2389 In case of a problem, set to an error message that reports what the
2390 local BFD session thinks is wrong. The error messages are defined
2391 in section 4.1 of [RFC 5880].
2394 <column name="bfd_status" key="remote_state"
2395 type='{"type": "string",
2396 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2397 Reports the state of the remote endpoint's BFD session.
2400 <column name="bfd_status" key="remote_diagnostic">
2401 In case of a problem, set to an error message that reports what the
2402 remote endpoint's BFD session thinks is wrong. The error messages
2403 are defined in section 4.1 of [RFC 5880].
2406 <column name="bfd_status" key="flap_count"
2407 type='{"type": "integer", "minInteger": 0}'>
2408 Counts the number of <ref column="bfd_status" key="forwarding" />
2409 flaps since start. A flap is considered as a change of the
2410 <ref column="bfd_status" key="forwarding" /> value.
2415 <group title="Connectivity Fault Management">
2417 802.1ag Connectivity Fault Management (CFM) allows a group of
2418 Maintenance Points (MPs) called a Maintenance Association (MA) to
2419 detect connectivity problems with each other. MPs within a MA should
2420 have complete and exclusive interconnectivity. This is verified by
2421 occasionally broadcasting Continuity Check Messages (CCMs) at a
2422 configurable transmission interval.
2426 According to the 802.1ag specification, each Maintenance Point should
2427 be configured out-of-band with a list of Remote Maintenance Points it
2428 should have connectivity to. Open vSwitch differs from the
2429 specification in this area. It simply assumes the link is faulted if
2430 no Remote Maintenance Points are reachable, and considers it not
2435 When operating over tunnels which have no <code>in_key</code>, or an
2436 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2437 with a tunnel key of zero.
2440 <column name="cfm_mpid">
2442 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2443 within a Maintenance Association. The MPID is used to identify this
2444 endpoint to other Maintenance Points in the MA. Each end of a link
2445 being monitored should have a different MPID. Must be configured to
2446 enable CFM on this <ref table="Interface"/>.
2449 According to the 802.1ag specification, MPIDs can only range between
2450 [1, 8191]. However, extended mode (see <ref column="other_config"
2451 key="cfm_extended"/>) supports eight byte MPIDs.
2455 <column name="cfm_flap_count">
2456 Counts the number of cfm fault flapps since boot. A flap is
2457 considered to be a change of the <ref column="cfm_fault"/> value.
2460 <column name="cfm_fault">
2462 Indicates a connectivity fault triggered by an inability to receive
2463 heartbeats from any remote endpoint. When a fault is triggered on
2464 <ref table="Interface"/>s participating in bonds, they will be
2468 Faults can be triggered for several reasons. Most importantly they
2469 are triggered when no CCMs are received for a period of 3.5 times the
2470 transmission interval. Faults are also triggered when any CCMs
2471 indicate that a Remote Maintenance Point is not receiving CCMs but
2472 able to send them. Finally, a fault is triggered if a CCM is
2473 received which indicates unexpected configuration. Notably, this
2474 case arises when a CCM is received which advertises the local MPID.
2478 <column name="cfm_fault_status" key="recv">
2479 Indicates a CFM fault was triggered due to a lack of CCMs received on
2480 the <ref table="Interface"/>.
2483 <column name="cfm_fault_status" key="rdi">
2484 Indicates a CFM fault was triggered due to the reception of a CCM with
2485 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2486 are not receiving CCMs themselves. This typically indicates a
2487 unidirectional connectivity failure.
2490 <column name="cfm_fault_status" key="maid">
2491 Indicates a CFM fault was triggered due to the reception of a CCM with
2492 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2493 with an identification number in addition to the MPID called the MAID.
2494 Open vSwitch only supports receiving CCM broadcasts tagged with the
2495 MAID it uses internally.
2498 <column name="cfm_fault_status" key="loopback">
2499 Indicates a CFM fault was triggered due to the reception of a CCM
2500 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2501 column of this <ref table="Interface"/>. This may indicate a loop in
2505 <column name="cfm_fault_status" key="overflow">
2506 Indicates a CFM fault was triggered because the CFM module received
2507 CCMs from more remote endpoints than it can keep track of.
2510 <column name="cfm_fault_status" key="override">
2511 Indicates a CFM fault was manually triggered by an administrator using
2512 an <code>ovs-appctl</code> command.
2515 <column name="cfm_fault_status" key="interval">
2516 Indicates a CFM fault was triggered due to the reception of a CCM
2517 frame having an invalid interval.
2520 <column name="cfm_remote_opstate">
2521 <p>When in extended mode, indicates the operational state of the
2522 remote endpoint as either <code>up</code> or <code>down</code>. See
2523 <ref column="other_config" key="cfm_opstate"/>.
2527 <column name="cfm_health">
2529 Indicates the health of the interface as a percentage of CCM frames
2530 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2531 The health of an interface is undefined if it is communicating with
2532 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2533 healthy heartbeats are not received at the expected rate, and
2534 gradually improves as healthy heartbeats are received at the desired
2535 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2536 health of the interface is refreshed.
2539 As mentioned above, the faults can be triggered for several reasons.
2540 The link health will deteriorate even if heartbeats are received but
2541 they are reported to be unhealthy. An unhealthy heartbeat in this
2542 context is a heartbeat for which either some fault is set or is out
2543 of sequence. The interface health can be 100 only on receiving
2544 healthy heartbeats at the desired rate.
2548 <column name="cfm_remote_mpids">
2549 When CFM is properly configured, Open vSwitch will occasionally
2550 receive CCM broadcasts. These broadcasts contain the MPID of the
2551 sending Maintenance Point. The list of MPIDs from which this
2552 <ref table="Interface"/> is receiving broadcasts from is regularly
2553 collected and written to this column.
2556 <column name="other_config" key="cfm_interval"
2557 type='{"type": "integer"}'>
2559 The interval, in milliseconds, between transmissions of CFM
2560 heartbeats. Three missed heartbeat receptions indicate a
2565 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2566 60,000, or 600,000 ms are supported. Other values will be rounded
2567 down to the nearest value on the list. Extended mode (see <ref
2568 column="other_config" key="cfm_extended"/>) supports any interval up
2569 to 65,535 ms. In either mode, the default is 1000 ms.
2572 <p>We do not recommend using intervals less than 100 ms.</p>
2575 <column name="other_config" key="cfm_extended"
2576 type='{"type": "boolean"}'>
2577 When <code>true</code>, the CFM module operates in extended mode. This
2578 causes it to use a nonstandard destination address to avoid conflicting
2579 with compliant implementations which may be running concurrently on the
2580 network. Furthermore, extended mode increases the accuracy of the
2581 <code>cfm_interval</code> configuration parameter by breaking wire
2582 compatibility with 802.1ag compliant implementations. And extended
2583 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2586 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2588 When <code>true</code>, and
2589 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2590 module operates in demand mode. When in demand mode, traffic
2591 received on the <ref table="Interface"/> is used to indicate
2592 liveness. CCMs are still transmitted and received. At least one
2593 CCM must be received every 100 * <ref column="other_config"
2594 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2595 are received, the CFM module will raise the connectivity fault.
2599 Demand mode has a couple of caveats:
2602 To ensure that ovs-vswitchd has enough time to pull statistics
2603 from the datapath, the fault detection interval is set to
2604 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2609 To avoid ambiguity, demand mode disables itself when there are
2610 multiple remote maintenance points.
2614 If the <ref table="Interface"/> is heavily congested, CCMs
2615 containing the <ref column="other_config" key="cfm_opstate"/>
2616 status may be dropped causing changes in the operational state to
2617 be delayed. Similarly, if CCMs containing the RDI bit are not
2618 received, unidirectional link failures may not be detected.
2624 <column name="other_config" key="cfm_opstate"
2625 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2626 When <code>down</code>, the CFM module marks all CCMs it generates as
2627 operationally down without triggering a fault. This allows remote
2628 maintenance points to choose not to forward traffic to the
2629 <ref table="Interface"/> on which this CFM module is running.
2630 Currently, in Open vSwitch, the opdown bit of CCMs affects
2631 <ref table="Interface"/>s participating in bonds, and the bundle
2632 OpenFlow action. This setting is ignored when CFM is not in extended
2633 mode. Defaults to <code>up</code>.
2636 <column name="other_config" key="cfm_ccm_vlan"
2637 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2638 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2639 with the given value. May be the string <code>random</code> in which
2640 case each CCM will be tagged with a different randomly generated VLAN.
2643 <column name="other_config" key="cfm_ccm_pcp"
2644 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2645 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2646 with the given PCP value, the VLAN ID of the tag is governed by the
2647 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2648 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2654 <group title="Bonding Configuration">
2655 <column name="other_config" key="lacp-port-id"
2656 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2657 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2658 used in LACP negotiations to identify individual ports
2659 participating in a bond.
2662 <column name="other_config" key="lacp-port-priority"
2663 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2664 The LACP port priority of this <ref table="Interface"/>. In LACP
2665 negotiations <ref table="Interface"/>s with numerically lower
2666 priorities are preferred for aggregation.
2669 <column name="other_config" key="lacp-aggregation-key"
2670 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2671 The LACP aggregation key of this <ref table="Interface"/>. <ref
2672 table="Interface"/>s with different aggregation keys may not be active
2673 within a given <ref table="Port"/> at the same time.
2677 <group title="Virtual Machine Identifiers">
2679 These key-value pairs specifically apply to an interface that
2680 represents a virtual Ethernet interface connected to a virtual
2681 machine. These key-value pairs should not be present for other types
2682 of interfaces. Keys whose names end in <code>-uuid</code> have
2683 values that uniquely identify the entity in question. For a Citrix
2684 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2685 Other hypervisors may use other formats.
2688 <column name="external_ids" key="attached-mac">
2689 The MAC address programmed into the ``virtual hardware'' for this
2690 interface, in the form
2691 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2692 For Citrix XenServer, this is the value of the <code>MAC</code> field
2693 in the VIF record for this interface.
2696 <column name="external_ids" key="iface-id">
2697 A system-unique identifier for the interface. On XenServer, this will
2698 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2701 <column name="external_ids" key="iface-status"
2702 type='{"type": "string",
2703 "enum": ["set", ["active", "inactive"]]}'>
2705 Hypervisors may sometimes have more than one interface associated
2706 with a given <ref column="external_ids" key="iface-id"/>, only one of
2707 which is actually in use at a given time. For example, in some
2708 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2709 for a single <ref column="external_ids" key="iface-id"/>, but only
2710 uses one of them at a time. A hypervisor that behaves this way must
2711 mark the currently in use interface <code>active</code> and the
2712 others <code>inactive</code>. A hypervisor that never has more than
2713 one interface for a given <ref column="external_ids" key="iface-id"/>
2714 may mark that interface <code>active</code> or omit <ref
2715 column="external_ids" key="iface-status"/> entirely.
2719 During VM migration, a given <ref column="external_ids"
2720 key="iface-id"/> might transiently be marked <code>active</code> on
2721 two different hypervisors. That is, <code>active</code> means that
2722 this <ref column="external_ids" key="iface-id"/> is the active
2723 instance within a single hypervisor, not in a broader scope.
2724 There is one exception: some hypervisors support ``migration'' from a
2725 given hypervisor to itself (most often for test purposes). During
2726 such a ``migration,'' two instances of a single <ref
2727 column="external_ids" key="iface-id"/> might both be briefly marked
2728 <code>active</code> on a single hypervisor.
2732 <column name="external_ids" key="xs-vif-uuid">
2733 The virtual interface associated with this interface.
2736 <column name="external_ids" key="xs-network-uuid">
2737 The virtual network to which this interface is attached.
2740 <column name="external_ids" key="vm-id">
2741 The VM to which this interface belongs. On XenServer, this will be the
2742 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2745 <column name="external_ids" key="xs-vm-uuid">
2746 The VM to which this interface belongs.
2750 <group title="VLAN Splinters">
2752 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2753 with buggy network drivers in old versions of Linux that do not
2754 properly support VLANs when VLAN devices are not used, at some cost
2755 in memory and performance.
2759 When VLAN splinters are enabled on a particular interface, Open vSwitch
2760 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2761 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2762 received on the VLAN device is treated as if it had been received on
2763 the interface on the particular VLAN.
2767 VLAN splinters consider a VLAN to be in use if:
2772 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2773 table="Port"/> record.
2777 The VLAN is listed within the <ref table="Port" column="trunks"/>
2778 column of the <ref table="Port"/> record of an interface on which
2779 VLAN splinters are enabled.
2781 An empty <ref table="Port" column="trunks"/> does not influence the
2782 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2783 will exceed the current 1,024 port per datapath limit.
2787 An OpenFlow flow within any bridge matches the VLAN.
2792 The same set of in-use VLANs applies to every interface on which VLAN
2793 splinters are enabled. That is, the set is not chosen separately for
2794 each interface but selected once as the union of all in-use VLANs based
2799 It does not make sense to enable VLAN splinters on an interface for an
2800 access port, or on an interface that is not a physical port.
2804 VLAN splinters are deprecated. When broken device drivers are no
2805 longer in widespread use, we will delete this feature.
2808 <column name="other_config" key="enable-vlan-splinters"
2809 type='{"type": "boolean"}'>
2811 Set to <code>true</code> to enable VLAN splinters on this interface.
2812 Defaults to <code>false</code>.
2816 VLAN splinters increase kernel and userspace memory overhead, so do
2817 not use them unless they are needed.
2821 VLAN splinters do not support 802.1p priority tags. Received
2822 priorities will appear to be 0, regardless of their actual values,
2823 and priorities on transmitted packets will also be cleared to 0.
2828 <group title="Common Columns">
2829 The overall purpose of these columns is described under <code>Common
2830 Columns</code> at the beginning of this document.
2832 <column name="other_config"/>
2833 <column name="external_ids"/>
2837 <table name="Flow_Table" title="OpenFlow table configuration">
2838 <p>Configuration for a particular OpenFlow table.</p>
2840 <column name="name">
2841 The table's name. Set this column to change the name that controllers
2842 will receive when they request table statistics, e.g. <code>ovs-ofctl
2843 dump-tables</code>. The name does not affect switch behavior.
2846 <column name="flow_limit">
2847 If set, limits the number of flows that may be added to the table. Open
2848 vSwitch may limit the number of flows in a table for other reasons,
2849 e.g. due to hardware limitations or for resource availability or
2850 performance reasons.
2853 <column name="overflow_policy">
2855 Controls the switch's behavior when an OpenFlow flow table modification
2856 request would add flows in excess of <ref column="flow_limit"/>. The
2857 supported values are:
2861 <dt><code>refuse</code></dt>
2863 Refuse to add the flow or flows. This is also the default policy
2864 when <ref column="overflow_policy"/> is unset.
2867 <dt><code>evict</code></dt>
2869 Delete the flow that will expire soonest. See <ref column="groups"/>
2875 <column name="groups">
2877 When <ref column="overflow_policy"/> is <code>evict</code>, this
2878 controls how flows are chosen for eviction when the flow table would
2879 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2880 of NXM fields or sub-fields, each of which takes one of the forms
2881 <code><var>field</var>[]</code> or
2882 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2883 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2884 <code>nicira-ext.h</code> for a complete list of NXM field names.
2888 When a flow must be evicted due to overflow, the flow to evict is
2889 chosen through an approximation of the following algorithm:
2894 Divide the flows in the table into groups based on the values of the
2895 specified fields or subfields, so that all of the flows in a given
2896 group have the same values for those fields. If a flow does not
2897 specify a given field, that field's value is treated as 0.
2901 Consider the flows in the largest group, that is, the group that
2902 contains the greatest number of flows. If two or more groups all
2903 have the same largest number of flows, consider the flows in all of
2908 Among the flows under consideration, choose the flow that expires
2909 soonest for eviction.
2914 The eviction process only considers flows that have an idle timeout or
2915 a hard timeout. That is, eviction never deletes permanent flows.
2916 (Permanent flows do count against <ref column="flow_limit"/>.)
2920 Open vSwitch ignores any invalid or unknown field specifications.
2924 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2925 column has no effect.
2929 <column name="prefixes">
2931 This string set specifies which fields should be used for
2932 address prefix tracking. Prefix tracking allows the
2933 classifier to skip rules with longer than necessary prefixes,
2934 resulting in better wildcarding for datapath flows.
2937 Prefix tracking may be beneficial when a flow table contains
2938 matches on IP address fields with different prefix lengths.
2939 For example, when a flow table contains IP address matches on
2940 both full addresses and proper prefixes, the full address
2941 matches will typically cause the datapath flow to un-wildcard
2942 the whole address field (depending on flow entry priorities).
2943 In this case each packet with a different address gets handed
2944 to the userspace for flow processing and generates its own
2945 datapath flow. With prefix tracking enabled for the address
2946 field in question packets with addresses matching shorter
2947 prefixes would generate datapath flows where the irrelevant
2948 address bits are wildcarded, allowing the same datapath flow
2949 to handle all the packets within the prefix in question. In
2950 this case many userspace upcalls can be avoided and the
2951 overall performance can be better.
2954 This is a performance optimization only, so packets will
2955 receive the same treatment with or without prefix tracking.
2958 The supported fields are: <code>tun_id</code>,
2959 <code>tun_src</code>, <code>tun_dst</code>,
2960 <code>nw_src</code>, <code>nw_dst</code> (or aliases
2961 <code>ip_src</code> and <code>ip_dst</code>),
2962 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
2963 feature for <code>tun_id</code> would only make sense if the
2964 tunnel IDs have prefix structure similar to IP addresses.)
2968 By default, the <code>prefixes=ip_dst,ip_src</code> are used
2969 on each flow table. This instructs the flow classifier to
2970 track the IP destination and source addresses used by the
2971 rules in this specific flow table.
2975 The keyword <code>none</code> is recognized as an explicit
2976 override of the default values, causing no prefix fields to be
2981 To set the prefix fields, the flow table record needs to
2986 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
2988 Creates a flow table record for the OpenFlow table number 0.
2991 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
2993 Enables prefix tracking for IP source and destination
2999 There is a maximum number of fields that can be enabled for any
3000 one flow table. Currently this limit is 3.
3004 <group title="Common Columns">
3005 The overall purpose of these columns is described under <code>Common
3006 Columns</code> at the beginning of this document.
3008 <column name="external_ids"/>
3012 <table name="QoS" title="Quality of Service configuration">
3013 <p>Quality of Service (QoS) configuration for each Port that
3016 <column name="type">
3017 <p>The type of QoS to implement. The currently defined types are
3020 <dt><code>linux-htb</code></dt>
3022 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
3023 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
3024 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
3025 for information on how this classifier works and how to configure it.
3029 <dt><code>linux-hfsc</code></dt>
3031 Linux "Hierarchical Fair Service Curve" classifier.
3032 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
3033 information on how this classifier works.
3038 <column name="queues">
3039 <p>A map from queue numbers to <ref table="Queue"/> records. The
3040 supported range of queue numbers depend on <ref column="type"/>. The
3041 queue numbers are the same as the <code>queue_id</code> used in
3042 OpenFlow in <code>struct ofp_action_enqueue</code> and other
3046 Queue 0 is the ``default queue.'' It is used by OpenFlow output
3047 actions when no specific queue has been set. When no configuration for
3048 queue 0 is present, it is automatically configured as if a <ref
3049 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
3050 and <ref table="Queue" column="other_config"/> columns had been
3052 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
3053 this case. With some queuing disciplines, this dropped all packets
3054 destined for the default queue.)
3058 <group title="Configuration for linux-htb and linux-hfsc">
3060 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
3061 the following key-value pair:
3064 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
3065 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3066 specified, for physical interfaces, the default is the link rate. For
3067 other interfaces or if the link rate cannot be determined, the default
3068 is currently 100 Mbps.
3072 <group title="Common Columns">
3073 The overall purpose of these columns is described under <code>Common
3074 Columns</code> at the beginning of this document.
3076 <column name="other_config"/>
3077 <column name="external_ids"/>
3081 <table name="Queue" title="QoS output queue.">
3082 <p>A configuration for a port output queue, used in configuring Quality of
3083 Service (QoS) features. May be referenced by <ref column="queues"
3084 table="QoS"/> column in <ref table="QoS"/> table.</p>
3086 <column name="dscp">
3087 If set, Open vSwitch will mark all traffic egressing this
3088 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3089 default <ref table="Queue"/> is only marked if it was explicitly selected
3090 as the <ref table="Queue"/> at the time the packet was output. If unset,
3091 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3095 <group title="Configuration for linux-htb QoS">
3097 <ref table="QoS"/> <ref table="QoS" column="type"/>
3098 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3099 It has the following key-value pairs defined.
3102 <column name="other_config" key="min-rate"
3103 type='{"type": "integer", "minInteger": 1}'>
3104 Minimum guaranteed bandwidth, in bit/s.
3107 <column name="other_config" key="max-rate"
3108 type='{"type": "integer", "minInteger": 1}'>
3109 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3110 queue's rate will not be allowed to exceed the specified value, even
3111 if excess bandwidth is available. If unspecified, defaults to no
3115 <column name="other_config" key="burst"
3116 type='{"type": "integer", "minInteger": 1}'>
3117 Burst size, in bits. This is the maximum amount of ``credits'' that a
3118 queue can accumulate while it is idle. Optional. Details of the
3119 <code>linux-htb</code> implementation require a minimum burst size, so
3120 a too-small <code>burst</code> will be silently ignored.
3123 <column name="other_config" key="priority"
3124 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3125 A queue with a smaller <code>priority</code> will receive all the
3126 excess bandwidth that it can use before a queue with a larger value
3127 receives any. Specific priority values are unimportant; only relative
3128 ordering matters. Defaults to 0 if unspecified.
3132 <group title="Configuration for linux-hfsc QoS">
3134 <ref table="QoS"/> <ref table="QoS" column="type"/>
3135 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3136 It has the following key-value pairs defined.
3139 <column name="other_config" key="min-rate"
3140 type='{"type": "integer", "minInteger": 1}'>
3141 Minimum guaranteed bandwidth, in bit/s.
3144 <column name="other_config" key="max-rate"
3145 type='{"type": "integer", "minInteger": 1}'>
3146 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3147 queue's rate will not be allowed to exceed the specified value, even if
3148 excess bandwidth is available. If unspecified, defaults to no
3153 <group title="Common Columns">
3154 The overall purpose of these columns is described under <code>Common
3155 Columns</code> at the beginning of this document.
3157 <column name="other_config"/>
3158 <column name="external_ids"/>
3162 <table name="Mirror" title="Port mirroring.">
3163 <p>A port mirror within a <ref table="Bridge"/>.</p>
3164 <p>A port mirror configures a bridge to send selected frames to special
3165 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3166 traffic may also be referred to as SPAN or RSPAN, depending on how
3167 the mirrored traffic is sent.</p>
3169 <column name="name">
3170 Arbitrary identifier for the <ref table="Mirror"/>.
3173 <group title="Selecting Packets for Mirroring">
3175 To be selected for mirroring, a given packet must enter or leave the
3176 bridge through a selected port and it must also be in one of the
3180 <column name="select_all">
3181 If true, every packet arriving or departing on any port is
3182 selected for mirroring.
3185 <column name="select_dst_port">
3186 Ports on which departing packets are selected for mirroring.
3189 <column name="select_src_port">
3190 Ports on which arriving packets are selected for mirroring.
3193 <column name="select_vlan">
3194 VLANs on which packets are selected for mirroring. An empty set
3195 selects packets on all VLANs.
3199 <group title="Mirroring Destination Configuration">
3201 These columns are mutually exclusive. Exactly one of them must be
3205 <column name="output_port">
3206 <p>Output port for selected packets, if nonempty.</p>
3207 <p>Specifying a port for mirror output reserves that port exclusively
3208 for mirroring. No frames other than those selected for mirroring
3210 will be forwarded to the port, and any frames received on the port
3211 will be discarded.</p>
3213 The output port may be any kind of port supported by Open vSwitch.
3214 It may be, for example, a physical port (sometimes called SPAN) or a
3219 <column name="output_vlan">
3220 <p>Output VLAN for selected packets, if nonempty.</p>
3221 <p>The frames will be sent out all ports that trunk
3222 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3223 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3224 trunk port, the frame's VLAN tag will be set to
3225 <ref column="output_vlan"/>, replacing any existing tag; when it is
3226 sent out an implicit VLAN port, the frame will not be tagged. This
3227 type of mirroring is sometimes called RSPAN.</p>
3229 See the documentation for
3230 <ref column="other_config" key="forward-bpdu"/> in the
3231 <ref table="Interface"/> table for a list of destination MAC
3232 addresses which will not be mirrored to a VLAN to avoid confusing
3233 switches that interpret the protocols that they represent.
3235 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3236 contains unmanaged switches. Consider an unmanaged physical switch
3237 with two ports: port 1, connected to an end host, and port 2,
3238 connected to an Open vSwitch configured to mirror received packets
3239 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3240 port 1 that the physical switch forwards to port 2. The Open vSwitch
3241 forwards this packet to its destination and then reflects it back on
3242 port 2 in VLAN 123. This reflected packet causes the unmanaged
3243 physical switch to replace the MAC learning table entry, which
3244 correctly pointed to port 1, with one that incorrectly points to port
3245 2. Afterward, the physical switch will direct packets destined for
3246 the end host to the Open vSwitch on port 2, instead of to the end
3247 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3248 desired in this scenario, then the physical switch must be replaced
3249 by one that learns Ethernet addresses on a per-VLAN basis. In
3250 addition, learning should be disabled on the VLAN containing mirrored
3251 traffic. If this is not done then intermediate switches will learn
3252 the MAC address of each end host from the mirrored traffic. If
3253 packets being sent to that end host are also mirrored, then they will
3254 be dropped since the switch will attempt to send them out the input
3255 port. Disabling learning for the VLAN will cause the switch to
3256 correctly send the packet out all ports configured for that VLAN. If
3257 Open vSwitch is being used as an intermediate switch, learning can be
3258 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3259 in the appropriate <ref table="Bridge"/> table or tables.</p>
3261 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3262 VLAN and should generally be preferred.
3267 <group title="Statistics: Mirror counters">
3269 Key-value pairs that report mirror statistics. The update period
3270 is controlled by <ref column="other_config"
3271 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3273 <column name="statistics" key="tx_packets">
3274 Number of packets transmitted through this mirror.
3276 <column name="statistics" key="tx_bytes">
3277 Number of bytes transmitted through this mirror.
3281 <group title="Common Columns">
3282 The overall purpose of these columns is described under <code>Common
3283 Columns</code> at the beginning of this document.
3285 <column name="external_ids"/>
3289 <table name="Controller" title="OpenFlow controller configuration.">
3290 <p>An OpenFlow controller.</p>
3293 Open vSwitch supports two kinds of OpenFlow controllers:
3297 <dt>Primary controllers</dt>
3300 This is the kind of controller envisioned by the OpenFlow 1.0
3301 specification. Usually, a primary controller implements a network
3302 policy by taking charge of the switch's flow table.
3306 Open vSwitch initiates and maintains persistent connections to
3307 primary controllers, retrying the connection each time it fails or
3308 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3309 <ref table="Bridge"/> table applies to primary controllers.
3313 Open vSwitch permits a bridge to have any number of primary
3314 controllers. When multiple controllers are configured, Open
3315 vSwitch connects to all of them simultaneously. Because
3316 OpenFlow 1.0 does not specify how multiple controllers
3317 coordinate in interacting with a single switch, more than
3318 one primary controller should be specified only if the
3319 controllers are themselves designed to coordinate with each
3320 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3321 vendor extension may be useful for this.)
3324 <dt>Service controllers</dt>
3327 These kinds of OpenFlow controller connections are intended for
3328 occasional support and maintenance use, e.g. with
3329 <code>ovs-ofctl</code>. Usually a service controller connects only
3330 briefly to inspect or modify some of a switch's state.
3334 Open vSwitch listens for incoming connections from service
3335 controllers. The service controllers initiate and, if necessary,
3336 maintain the connections from their end. The <ref table="Bridge"
3337 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3338 not apply to service controllers.
3342 Open vSwitch supports configuring any number of service controllers.
3348 The <ref column="target"/> determines the type of controller.
3351 <group title="Core Features">
3352 <column name="target">
3353 <p>Connection method for controller.</p>
3355 The following connection methods are currently supported for primary
3359 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3361 <p>The specified SSL <var>port</var> on the host at the
3362 given <var>ip</var>, which must be expressed as an IP
3363 address (not a DNS name). The <ref table="Open_vSwitch"
3364 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3365 table must point to a valid SSL configuration when this form
3367 <p>If <var>port</var> is not specified, it currently
3368 defaults to 6633. In the future, the default will change to
3369 6653, which is the IANA-defined value.</p>
3370 <p>SSL support is an optional feature that is not always built as
3371 part of Open vSwitch.</p>
3373 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3376 The specified TCP <var>port</var> on the host at the given
3377 <var>ip</var>, which must be expressed as an IP address (not a
3378 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3379 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3380 e.g. <code>tcp:[::1]:6632</code>.
3383 If <var>port</var> is not specified, it currently defaults to
3384 6633. In the future, the default will change to 6653, which is
3385 the IANA-defined value.
3390 The following connection methods are currently supported for service
3394 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3397 Listens for SSL connections on the specified TCP <var>port</var>.
3398 If <var>ip</var>, which must be expressed as an IP address (not a
3399 DNS name), is specified, then connections are restricted to the
3400 specified local IP address (either IPv4 or IPv6). If
3401 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3402 e.g. <code>pssl:6632:[::1]</code>.
3405 If <var>port</var> is not specified, it currently defaults to
3406 6633. If <var>ip</var> is not specified then it listens only on
3407 IPv4 (but not IPv6) addresses. The
3408 <ref table="Open_vSwitch" column="ssl"/>
3409 column in the <ref table="Open_vSwitch"/> table must point to a
3410 valid SSL configuration when this form is used.
3413 If <var>port</var> is not specified, it currently defaults to
3414 6633. In the future, the default will change to 6653, which is
3415 the IANA-defined value.
3418 SSL support is an optional feature that is not always built as
3419 part of Open vSwitch.
3422 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3425 Listens for connections on the specified TCP <var>port</var>. If
3426 <var>ip</var>, which must be expressed as an IP address (not a
3427 DNS name), is specified, then connections are restricted to the
3428 specified local IP address (either IPv4 or IPv6). If
3429 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3430 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3431 specified then it listens only on IPv4 addresses.
3434 If <var>port</var> is not specified, it currently defaults to
3435 6633. In the future, the default will change to 6653, which is
3436 the IANA-defined value.
3440 <p>When multiple controllers are configured for a single bridge, the
3441 <ref column="target"/> values must be unique. Duplicate
3442 <ref column="target"/> values yield unspecified results.</p>
3445 <column name="connection_mode">
3446 <p>If it is specified, this setting must be one of the following
3447 strings that describes how Open vSwitch contacts this OpenFlow
3448 controller over the network:</p>
3451 <dt><code>in-band</code></dt>
3452 <dd>In this mode, this controller's OpenFlow traffic travels over the
3453 bridge associated with the controller. With this setting, Open
3454 vSwitch allows traffic to and from the controller regardless of the
3455 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3456 would never be able to connect to the controller, because it did
3457 not have a flow to enable it.) This is the most common connection
3458 mode because it is not necessary to maintain two independent
3460 <dt><code>out-of-band</code></dt>
3461 <dd>In this mode, OpenFlow traffic uses a control network separate
3462 from the bridge associated with this controller, that is, the
3463 bridge does not use any of its own network devices to communicate
3464 with the controller. The control network must be configured
3465 separately, before or after <code>ovs-vswitchd</code> is started.
3469 <p>If not specified, the default is implementation-specific.</p>
3473 <group title="Controller Failure Detection and Handling">
3474 <column name="max_backoff">
3475 Maximum number of milliseconds to wait between connection attempts.
3476 Default is implementation-specific.
3479 <column name="inactivity_probe">
3480 Maximum number of milliseconds of idle time on connection to
3481 controller before sending an inactivity probe message. If Open
3482 vSwitch does not communicate with the controller for the specified
3483 number of seconds, it will send a probe. If a response is not
3484 received for the same additional amount of time, Open vSwitch
3485 assumes the connection has been broken and attempts to reconnect.
3486 Default is implementation-specific. A value of 0 disables
3491 <group title="Asynchronous Messages">
3493 OpenFlow switches send certain messages to controllers spontanenously,
3494 that is, not in response to any request from the controller. These
3495 messages are called ``asynchronous messages.'' These columns allow
3496 asynchronous messages to be limited or disabled to ensure the best use
3497 of network resources.
3500 <column name="enable_async_messages">
3501 The OpenFlow protocol enables asynchronous messages at time of
3502 connection establishment, which means that a controller can receive
3503 asynchronous messages, potentially many of them, even if it turns them
3504 off immediately after connecting. Set this column to
3505 <code>false</code> to change Open vSwitch behavior to disable, by
3506 default, all asynchronous messages. The controller can use the
3507 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3508 on any messages that it does want to receive, if any.
3511 <group title="Controller Rate Limiting">
3513 A switch can forward packets to a controller over the OpenFlow
3514 protocol. Forwarding packets this way at too high a rate can
3515 overwhelm a controller, frustrate use of the OpenFlow connection for
3516 other purposes, increase the latency of flow setup, and use an
3517 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3518 limiting the rate of packet forwarding to a controller.
3522 There are two main reasons in OpenFlow for a packet to be sent to a
3523 controller: either the packet ``misses'' in the flow table, that is,
3524 there is no matching flow, or a flow table action says to send the
3525 packet to the controller. Open vSwitch limits the rate of each kind
3526 of packet separately at the configured rate. Therefore, the actual
3527 rate that packets are sent to the controller can be up to twice the
3528 configured rate, when packets are sent for both reasons.
3532 This feature is specific to forwarding packets over an OpenFlow
3533 connection. It is not general-purpose QoS. See the <ref
3534 table="QoS"/> table for quality of service configuration, and <ref
3535 column="ingress_policing_rate" table="Interface"/> in the <ref
3536 table="Interface"/> table for ingress policing configuration.
3539 <column name="controller_rate_limit">
3541 The maximum rate at which the switch will forward packets to the
3542 OpenFlow controller, in packets per second. If no value is
3543 specified, rate limiting is disabled.
3547 <column name="controller_burst_limit">
3549 When a high rate triggers rate-limiting, Open vSwitch queues
3550 packets to the controller for each port and transmits them to the
3551 controller at the configured rate. This value limits the number of
3552 queued packets. Ports on a bridge share the packet queue fairly.
3556 This value has no effect unless <ref
3557 column="controller_rate_limit"/> is configured. The current
3558 default when this value is not specified is one-quarter of <ref
3559 column="controller_rate_limit"/>, meaning that queuing can delay
3560 forwarding a packet to the controller by up to 250 ms.
3564 <group title="Controller Rate Limiting Statistics">
3566 These values report the effects of rate limiting. Their values are
3567 relative to establishment of the most recent OpenFlow connection,
3568 or since rate limiting was enabled, whichever happened more
3569 recently. Each consists of two values, one with <code>TYPE</code>
3570 replaced by <code>miss</code> for rate limiting flow table misses,
3571 and the other with <code>TYPE</code> replaced by
3572 <code>action</code> for rate limiting packets sent by OpenFlow
3577 These statistics are reported only when controller rate limiting is
3581 <column name="status" key="packet-in-TYPE-bypassed"
3582 type='{"type": "integer", "minInteger": 0}'>
3583 Number of packets sent directly to the controller, without queuing,
3584 because the rate did not exceed the configured maximum.
3587 <column name="status" key="packet-in-TYPE-queued"
3588 type='{"type": "integer", "minInteger": 0}'>
3589 Number of packets added to the queue to send later.
3592 <column name="status" key="packet-in-TYPE-dropped"
3593 type='{"type": "integer", "minInteger": 0}'>
3594 Number of packets added to the queue that were later dropped due to
3595 overflow. This value is less than or equal to <ref column="status"
3596 key="packet-in-TYPE-queued"/>.
3599 <column name="status" key="packet-in-TYPE-backlog"
3600 type='{"type": "integer", "minInteger": 0}'>
3601 Number of packets currently queued. The other statistics increase
3602 monotonically, but this one fluctuates between 0 and the <ref
3603 column="controller_burst_limit"/> as conditions change.
3609 <group title="Additional In-Band Configuration">
3610 <p>These values are considered only in in-band control mode (see
3611 <ref column="connection_mode"/>).</p>
3613 <p>When multiple controllers are configured on a single bridge, there
3614 should be only one set of unique values in these columns. If different
3615 values are set for these columns in different controllers, the effect
3618 <column name="local_ip">
3619 The IP address to configure on the local port,
3620 e.g. <code>192.168.0.123</code>. If this value is unset, then
3621 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3625 <column name="local_netmask">
3626 The IP netmask to configure on the local port,
3627 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3628 but this value is unset, then the default is chosen based on whether
3629 the IP address is class A, B, or C.
3632 <column name="local_gateway">
3633 The IP address of the gateway to configure on the local port, as a
3634 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3635 this network has no gateway.
3639 <group title="Controller Status">
3640 <column name="is_connected">
3641 <code>true</code> if currently connected to this controller,
3642 <code>false</code> otherwise.
3646 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3647 <p>The level of authority this controller has on the associated
3648 bridge. Possible values are:</p>
3650 <dt><code>other</code></dt>
3651 <dd>Allows the controller access to all OpenFlow features.</dd>
3652 <dt><code>master</code></dt>
3653 <dd>Equivalent to <code>other</code>, except that there may be at
3654 most one master controller at a time. When a controller configures
3655 itself as <code>master</code>, any existing master is demoted to
3656 the <code>slave</code> role.</dd>
3657 <dt><code>slave</code></dt>
3658 <dd>Allows the controller read-only access to OpenFlow features.
3659 Attempts to modify the flow table will be rejected with an
3660 error. Slave controllers do not receive OFPT_PACKET_IN or
3661 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3666 <column name="status" key="last_error">
3667 A human-readable description of the last error on the connection
3668 to the controller; i.e. <code>strerror(errno)</code>. This key
3669 will exist only if an error has occurred.
3672 <column name="status" key="state"
3673 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3675 The state of the connection to the controller:
3678 <dt><code>VOID</code></dt>
3679 <dd>Connection is disabled.</dd>
3681 <dt><code>BACKOFF</code></dt>
3682 <dd>Attempting to reconnect at an increasing period.</dd>
3684 <dt><code>CONNECTING</code></dt>
3685 <dd>Attempting to connect.</dd>
3687 <dt><code>ACTIVE</code></dt>
3688 <dd>Connected, remote host responsive.</dd>
3690 <dt><code>IDLE</code></dt>
3691 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3694 These values may change in the future. They are provided only for
3699 <column name="status" key="sec_since_connect"
3700 type='{"type": "integer", "minInteger": 0}'>
3701 The amount of time since this controller last successfully connected to
3702 the switch (in seconds). Value is empty if controller has never
3703 successfully connected.
3706 <column name="status" key="sec_since_disconnect"
3707 type='{"type": "integer", "minInteger": 1}'>
3708 The amount of time since this controller last disconnected from
3709 the switch (in seconds). Value is empty if controller has never
3714 <group title="Connection Parameters">
3716 Additional configuration for a connection between the controller
3717 and the Open vSwitch.
3720 <column name="other_config" key="dscp"
3721 type='{"type": "integer"}'>
3722 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3723 in the Type of Service (TOS) field in the IP header. DSCP provides a
3724 mechanism to classify the network traffic and provide Quality of
3725 Service (QoS) on IP networks.
3727 The DSCP value specified here is used when establishing the connection
3728 between the controller and the Open vSwitch. If no value is specified,
3729 a default value of 48 is chosen. Valid DSCP values must be in the
3735 <group title="Common Columns">
3736 The overall purpose of these columns is described under <code>Common
3737 Columns</code> at the beginning of this document.
3739 <column name="external_ids"/>
3740 <column name="other_config"/>
3744 <table name="Manager" title="OVSDB management connection.">
3746 Configuration for a database connection to an Open vSwitch database
3751 This table primarily configures the Open vSwitch database
3752 (<code>ovsdb-server</code>), not the Open vSwitch switch
3753 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3754 what connections should be treated as in-band.
3758 The Open vSwitch database server can initiate and maintain active
3759 connections to remote clients. It can also listen for database
3763 <group title="Core Features">
3764 <column name="target">
3765 <p>Connection method for managers.</p>
3767 The following connection methods are currently supported:
3770 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3773 The specified SSL <var>port</var> on the host at the given
3774 <var>ip</var>, which must be expressed as an IP address
3775 (not a DNS name). The <ref table="Open_vSwitch"
3776 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3777 table must point to a valid SSL configuration when this
3781 If <var>port</var> is not specified, it currently defaults
3782 to 6632. In the future, the default will change to 6640,
3783 which is the IANA-defined value.
3786 SSL support is an optional feature that is not always
3787 built as part of Open vSwitch.
3791 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3794 The specified TCP <var>port</var> on the host at the given
3795 <var>ip</var>, which must be expressed as an IP address (not a
3796 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3797 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3798 e.g. <code>tcp:[::1]:6632</code>.
3801 If <var>port</var> is not specified, it currently defaults
3802 to 6632. In the future, the default will change to 6640,
3803 which is the IANA-defined value.
3806 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3809 Listens for SSL connections on the specified TCP <var>port</var>.
3810 Specify 0 for <var>port</var> to have the kernel automatically
3811 choose an available port. If <var>ip</var>, which must be
3812 expressed as an IP address (not a DNS name), is specified, then
3813 connections are restricted to the specified local IP address
3814 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3815 address, wrap in square brackets,
3816 e.g. <code>pssl:6632:[::1]</code>. If <var>ip</var> is not
3817 specified then it listens only on IPv4 (but not IPv6) addresses.
3818 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3819 table="Open_vSwitch"/> table must point to a valid SSL
3820 configuration when this form is used.
3823 If <var>port</var> is not specified, it currently defaults
3824 to 6632. In the future, the default will change to 6640,
3825 which is the IANA-defined value.
3828 SSL support is an optional feature that is not always built as
3829 part of Open vSwitch.
3832 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3835 Listens for connections on the specified TCP <var>port</var>.
3836 Specify 0 for <var>port</var> to have the kernel automatically
3837 choose an available port. If <var>ip</var>, which must be
3838 expressed as an IP address (not a DNS name), is specified, then
3839 connections are restricted to the specified local IP address
3840 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3841 address, wrap it in square brackets,
3842 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3843 specified then it listens only on IPv4 addresses.
3846 If <var>port</var> is not specified, it currently defaults
3847 to 6632. In the future, the default will change to 6640,
3848 which is the IANA-defined value.
3852 <p>When multiple managers are configured, the <ref column="target"/>
3853 values must be unique. Duplicate <ref column="target"/> values yield
3854 unspecified results.</p>
3857 <column name="connection_mode">
3859 If it is specified, this setting must be one of the following strings
3860 that describes how Open vSwitch contacts this OVSDB client over the
3865 <dt><code>in-band</code></dt>
3867 In this mode, this connection's traffic travels over a bridge
3868 managed by Open vSwitch. With this setting, Open vSwitch allows
3869 traffic to and from the client regardless of the contents of the
3870 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3871 to connect to the client, because it did not have a flow to enable
3872 it.) This is the most common connection mode because it is not
3873 necessary to maintain two independent networks.
3875 <dt><code>out-of-band</code></dt>
3877 In this mode, the client's traffic uses a control network separate
3878 from that managed by Open vSwitch, that is, Open vSwitch does not
3879 use any of its own network devices to communicate with the client.
3880 The control network must be configured separately, before or after
3881 <code>ovs-vswitchd</code> is started.
3886 If not specified, the default is implementation-specific.
3891 <group title="Client Failure Detection and Handling">
3892 <column name="max_backoff">
3893 Maximum number of milliseconds to wait between connection attempts.
3894 Default is implementation-specific.
3897 <column name="inactivity_probe">
3898 Maximum number of milliseconds of idle time on connection to the client
3899 before sending an inactivity probe message. If Open vSwitch does not
3900 communicate with the client for the specified number of seconds, it
3901 will send a probe. If a response is not received for the same
3902 additional amount of time, Open vSwitch assumes the connection has been
3903 broken and attempts to reconnect. Default is implementation-specific.
3904 A value of 0 disables inactivity probes.
3908 <group title="Status">
3909 <column name="is_connected">
3910 <code>true</code> if currently connected to this manager,
3911 <code>false</code> otherwise.
3914 <column name="status" key="last_error">
3915 A human-readable description of the last error on the connection
3916 to the manager; i.e. <code>strerror(errno)</code>. This key
3917 will exist only if an error has occurred.
3920 <column name="status" key="state"
3921 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3923 The state of the connection to the manager:
3926 <dt><code>VOID</code></dt>
3927 <dd>Connection is disabled.</dd>
3929 <dt><code>BACKOFF</code></dt>
3930 <dd>Attempting to reconnect at an increasing period.</dd>
3932 <dt><code>CONNECTING</code></dt>
3933 <dd>Attempting to connect.</dd>
3935 <dt><code>ACTIVE</code></dt>
3936 <dd>Connected, remote host responsive.</dd>
3938 <dt><code>IDLE</code></dt>
3939 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3942 These values may change in the future. They are provided only for
3947 <column name="status" key="sec_since_connect"
3948 type='{"type": "integer", "minInteger": 0}'>
3949 The amount of time since this manager last successfully connected
3950 to the database (in seconds). Value is empty if manager has never
3951 successfully connected.
3954 <column name="status" key="sec_since_disconnect"
3955 type='{"type": "integer", "minInteger": 0}'>
3956 The amount of time since this manager last disconnected from the
3957 database (in seconds). Value is empty if manager has never
3961 <column name="status" key="locks_held">
3962 Space-separated list of the names of OVSDB locks that the connection
3963 holds. Omitted if the connection does not hold any locks.
3966 <column name="status" key="locks_waiting">
3967 Space-separated list of the names of OVSDB locks that the connection is
3968 currently waiting to acquire. Omitted if the connection is not waiting
3972 <column name="status" key="locks_lost">
3973 Space-separated list of the names of OVSDB locks that the connection
3974 has had stolen by another OVSDB client. Omitted if no locks have been
3975 stolen from this connection.
3978 <column name="status" key="n_connections"
3979 type='{"type": "integer", "minInteger": 2}'>
3981 When <ref column="target"/> specifies a connection method that
3982 listens for inbound connections (e.g. <code>ptcp:</code> or
3983 <code>pssl:</code>) and more than one connection is actually active,
3984 the value is the number of active connections. Otherwise, this
3985 key-value pair is omitted.
3988 When multiple connections are active, status columns and key-value
3989 pairs (other than this one) report the status of one arbitrarily
3994 <column name="status" key="bound_port" type='{"type": "integer"}'>
3995 When <ref column="target"/> is <code>ptcp:</code> or
3996 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3997 listening. (This is is particularly useful when <ref
3998 column="target"/> specifies a port of 0, allowing the kernel to
3999 choose any available port.)
4003 <group title="Connection Parameters">
4005 Additional configuration for a connection between the manager
4006 and the Open vSwitch Database.
4009 <column name="other_config" key="dscp"
4010 type='{"type": "integer"}'>
4011 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4012 in the Type of Service (TOS) field in the IP header. DSCP provides a
4013 mechanism to classify the network traffic and provide Quality of
4014 Service (QoS) on IP networks.
4016 The DSCP value specified here is used when establishing the connection
4017 between the manager and the Open vSwitch. If no value is specified, a
4018 default value of 48 is chosen. Valid DSCP values must be in the range
4023 <group title="Common Columns">
4024 The overall purpose of these columns is described under <code>Common
4025 Columns</code> at the beginning of this document.
4027 <column name="external_ids"/>
4028 <column name="other_config"/>
4032 <table name="NetFlow">
4033 A NetFlow target. NetFlow is a protocol that exports a number of
4034 details about terminating IP flows, such as the principals involved
4037 <column name="targets">
4038 NetFlow targets in the form
4039 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
4040 must be specified numerically, not as a DNS name.
4043 <column name="engine_id">
4044 Engine ID to use in NetFlow messages. Defaults to datapath index
4048 <column name="engine_type">
4049 Engine type to use in NetFlow messages. Defaults to datapath
4050 index if not specified.
4053 <column name="active_timeout">
4055 The interval at which NetFlow records are sent for flows that
4056 are still active, in seconds. A value of <code>0</code>
4057 requests the default timeout (currently 600 seconds); a value
4058 of <code>-1</code> disables active timeouts.
4062 The NetFlow passive timeout, for flows that become inactive,
4063 is not configurable. It will vary depending on the Open
4064 vSwitch version, the forms and contents of the OpenFlow flow
4065 tables, CPU and memory usage, and network activity. A typical
4066 passive timeout is about a second.
4070 <column name="add_id_to_interface">
4071 <p>If this column's value is <code>false</code>, the ingress and egress
4072 interface fields of NetFlow flow records are derived from OpenFlow port
4073 numbers. When it is <code>true</code>, the 7 most significant bits of
4074 these fields will be replaced by the least significant 7 bits of the
4075 engine id. This is useful because many NetFlow collectors do not
4076 expect multiple switches to be sending messages from the same host, so
4077 they do not store the engine information which could be used to
4078 disambiguate the traffic.</p>
4079 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
4082 <group title="Common Columns">
4083 The overall purpose of these columns is described under <code>Common
4084 Columns</code> at the beginning of this document.
4086 <column name="external_ids"/>
4091 SSL configuration for an Open_vSwitch.
4093 <column name="private_key">
4094 Name of a PEM file containing the private key used as the switch's
4095 identity for SSL connections to the controller.
4098 <column name="certificate">
4099 Name of a PEM file containing a certificate, signed by the
4100 certificate authority (CA) used by the controller and manager,
4101 that certifies the switch's private key, identifying a trustworthy
4105 <column name="ca_cert">
4106 Name of a PEM file containing the CA certificate used to verify
4107 that the switch is connected to a trustworthy controller.
4110 <column name="bootstrap_ca_cert">
4111 If set to <code>true</code>, then Open vSwitch will attempt to
4112 obtain the CA certificate from the controller on its first SSL
4113 connection and save it to the named PEM file. If it is successful,
4114 it will immediately drop the connection and reconnect, and from then
4115 on all SSL connections must be authenticated by a certificate signed
4116 by the CA certificate thus obtained. <em>This option exposes the
4117 SSL connection to a man-in-the-middle attack obtaining the initial
4118 CA certificate.</em> It may still be useful for bootstrapping.
4121 <group title="Common Columns">
4122 The overall purpose of these columns is described under <code>Common
4123 Columns</code> at the beginning of this document.
4125 <column name="external_ids"/>
4129 <table name="sFlow">
4130 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4131 monitoring of switches.</p>
4133 <column name="agent">
4134 Name of the network device whose IP address should be reported as the
4135 ``agent address'' to collectors. If not specified, the agent device is
4136 figured from the first target address and the routing table. If the
4137 routing table does not contain a route to the target, the IP address
4138 defaults to the <ref table="Controller" column="local_ip"/> in the
4139 collector's <ref table="Controller"/>. If an agent IP address cannot be
4140 determined any of these ways, sFlow is disabled.
4143 <column name="header">
4144 Number of bytes of a sampled packet to send to the collector.
4145 If not specified, the default is 128 bytes.
4148 <column name="polling">
4149 Polling rate in seconds to send port statistics to the collector.
4150 If not specified, defaults to 30 seconds.
4153 <column name="sampling">
4154 Rate at which packets should be sampled and sent to the collector.
4155 If not specified, defaults to 400, which means one out of 400
4156 packets, on average, will be sent to the collector.
4159 <column name="targets">
4160 sFlow targets in the form
4161 <code><var>ip</var>:<var>port</var></code>.
4164 <group title="Common Columns">
4165 The overall purpose of these columns is described under <code>Common
4166 Columns</code> at the beginning of this document.
4168 <column name="external_ids"/>
4172 <table name="IPFIX">
4173 <p>Configuration for sending packets to IPFIX collectors.</p>
4176 IPFIX is a protocol that exports a number of details about flows. The
4177 IPFIX implementation in Open vSwitch samples packets at a configurable
4178 rate, extracts flow information from those packets, optionally caches and
4179 aggregates the flow information, and sends the result to one or more
4184 IPFIX in Open vSwitch can be configured two different ways:
4189 With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling
4190 automatically on all packets that pass through a bridge. To configure
4191 per-bridge sampling, create an <ref table="IPFIX"/> record and point a
4192 <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/>
4193 column to it. The <ref table="Flow_Sample_Collector_Set"/> table is
4194 not used for per-bridge sampling.
4199 With <em>flow-based sampling</em>, <code>sample</code> actions in the
4200 OpenFlow flow table drive IPFIX sampling. See
4201 <code>ovs-ofctl</code>(8) for a description of the
4202 <code>sample</code> action.
4206 Flow-based sampling also requires database configuration: create a
4207 <ref table="IPFIX"/> record that describes the IPFIX configuration
4208 and a <ref table="Flow_Sample_Collector_Set"/> record that points to
4209 the <ref table="Bridge"/> whose flow table holds the
4210 <code>sample</code> actions and to <ref table="IPFIX"/> record. The
4211 <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/>
4212 table is not used for flow-based sampling.
4217 <column name="targets">
4218 IPFIX target collectors in the form
4219 <code><var>ip</var>:<var>port</var></code>.
4222 <column name="cache_active_timeout">
4223 The maximum period in seconds for which an IPFIX flow record is
4224 cached and aggregated before being sent. If not specified,
4225 defaults to 0. If 0, caching is disabled.
4228 <column name="cache_max_flows">
4229 The maximum number of IPFIX flow records that can be cached at a
4230 time. If not specified, defaults to 0. If 0, caching is
4234 <group title="Per-Bridge Sampling">
4236 These values affect only per-bridge sampling. See above for a
4237 description of the differences between per-bridge and flow-based
4241 <column name="sampling">
4242 The rate at which packets should be sampled and sent to each target
4243 collector. If not specified, defaults to 400, which means one out of
4244 400 packets, on average, will be sent to each target collector.
4247 <column name="obs_domain_id">
4248 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4249 specified, defaults to 0.
4252 <column name="obs_point_id">
4253 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4254 specified, defaults to 0.
4257 <column name="other_config" key="enable-tunnel-sampling"
4258 type='{"type": "boolean"}'>
4260 Set to <code>true</code> to enable sampling and reporting tunnel
4261 header 7-tuples in IPFIX flow records. Tunnel sampling is disabled
4266 The following enterprise entities report the sampled tunnel info:
4270 <dt>tunnelType:</dt>
4272 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4273 <p>type: unsigned 8-bit integer.</p>
4274 <p>data type semantics: identifier.</p>
4275 <p>description: Identifier of the layer 2 network overlay network
4276 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4281 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4282 <p>type: variable-length octetarray.</p>
4283 <p>data type semantics: identifier.</p>
4284 <p>description: Key which is used for identifying an individual
4285 traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI),
4286 GRE (32- or 64-bit key), or LISP (24-bit instance ID) tunnel. The
4287 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4288 ID in network byte order.</p>
4290 <dt>tunnelSourceIPv4Address:</dt>
4292 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4293 <p>type: unsigned 32-bit integer.</p>
4294 <p>data type semantics: identifier.</p>
4295 <p>description: The IPv4 source address in the tunnel IP packet
4298 <dt>tunnelDestinationIPv4Address:</dt>
4300 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4301 <p>type: unsigned 32-bit integer.</p>
4302 <p>data type semantics: identifier.</p>
4303 <p>description: The IPv4 destination address in the tunnel IP
4306 <dt>tunnelProtocolIdentifier:</dt>
4308 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4309 <p>type: unsigned 8-bit integer.</p>
4310 <p>data type semantics: identifier.</p>
4311 <p>description: The value of the protocol number in the tunnel
4312 IP packet header. The protocol number identifies the tunnel IP
4313 packet payload type.</p>
4315 <dt>tunnelSourceTransportPort:</dt>
4317 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4318 <p>type: unsigned 16-bit integer.</p>
4319 <p>data type semantics: identifier.</p>
4320 <p>description: The source port identifier in the tunnel transport
4321 header. For the transport protocols UDP, TCP, and SCTP, this is
4322 the source port number given in the respective header.</p>
4324 <dt>tunnelDestinationTransportPort:</dt>
4326 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4327 <p>type: unsigned 16-bit integer.</p>
4328 <p>data type semantics: identifier.</p>
4329 <p>description: The destination port identifier in the tunnel
4330 transport header. For the transport protocols UDP, TCP, and SCTP,
4331 this is the destination port number given in the respective header.
4337 <column name="other_config" key="enable-input-sampling"
4338 type='{"type": "boolean"}'>
4339 By default, Open vSwitch samples and reports flows at bridge port input
4340 in IPFIX flow records. Set this column to <code>false</code> to
4341 disable input sampling.
4344 <column name="other_config" key="enable-output-sampling"
4345 type='{"type": "boolean"}'>
4346 By default, Open vSwitch samples and reports flows at bridge port
4347 output in IPFIX flow records. Set this column to <code>false</code> to
4348 disable output sampling.
4352 <group title="Common Columns">
4353 The overall purpose of these columns is described under <code>Common
4354 Columns</code> at the beginning of this document.
4356 <column name="external_ids"/>
4360 <table name="Flow_Sample_Collector_Set">
4362 A set of IPFIX collectors of packet samples generated by OpenFlow
4363 <code>sample</code> actions. This table is used only for IPFIX
4364 flow-based sampling, not for per-bridge sampling (see the <ref
4365 table="IPFIX"/> table for a description of the two forms).
4369 The ID of this collector set, unique among the bridge's
4370 collector sets, to be used as the <code>collector_set_id</code>
4371 in OpenFlow <code>sample</code> actions.
4374 <column name="bridge">
4375 The bridge into which OpenFlow <code>sample</code> actions can
4376 be added to send packet samples to this set of IPFIX collectors.
4379 <column name="ipfix">
4380 Configuration of the set of IPFIX collectors to send one flow
4381 record per sampled packet to.
4384 <group title="Common Columns">
4385 The overall purpose of these columns is described under <code>Common
4386 Columns</code> at the beginning of this document.
4388 <column name="external_ids"/>
projects / cascardo / ovs.git / blob