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>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
412 <p>If this value is unset, the default is implementation-specific.</p>
414 The <code>standalone</code> mode can create forwarding loops on a
415 bridge that has more than one uplink port unless STP is enabled. To
416 avoid loops on such a bridge, configure <code>secure</code> mode or
417 enable STP (see <ref column="stp_enable"/>).
419 <p>When more than one controller is configured,
420 <ref column="fail_mode"/> is considered only when none of the
421 configured controllers can be contacted.</p>
423 Changing <ref column="fail_mode"/> when no primary controllers are
424 configured clears the flow table.
428 <column name="datapath_id">
429 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
430 (Setting this column has no useful effect. Set <ref
431 column="other-config" key="datapath-id"/> instead.)
434 <column name="other_config" key="datapath-id">
435 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
436 value. May not be all-zero.
439 <column name="other_config" key="disable-in-band"
440 type='{"type": "boolean"}'>
441 If set to <code>true</code>, disable in-band control on the bridge
442 regardless of controller and manager settings.
445 <column name="other_config" key="in-band-queue"
446 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
447 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
448 that will be used by flows set up by in-band control on this bridge.
449 If unset, or if the port used by an in-band control flow does not have
450 QoS configured, or if the port does not have a queue with the specified
451 ID, the default queue is used instead.
455 <group title="Spanning Tree Configuration">
456 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
457 that ensures loop-free topologies. It allows redundant links to
458 be included in the network to provide automatic backup paths if
459 the active links fails.
461 <column name="stp_enable">
462 Enable spanning tree on the bridge. By default, STP is disabled
463 on bridges. Bond, internal, and mirror ports are not supported
464 and will not participate in the spanning tree.
467 <column name="other_config" key="stp-system-id">
468 The bridge's STP identifier (the lower 48 bits of the bridge-id)
470 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
471 By default, the identifier is the MAC address of the bridge.
474 <column name="other_config" key="stp-priority"
475 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
476 The bridge's relative priority value for determining the root
477 bridge (the upper 16 bits of the bridge-id). A bridge with the
478 lowest bridge-id is elected the root. By default, the priority
482 <column name="other_config" key="stp-hello-time"
483 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
484 The interval between transmissions of hello messages by
485 designated ports, in seconds. By default the hello interval is
489 <column name="other_config" key="stp-max-age"
490 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
491 The maximum age of the information transmitted by the bridge
492 when it is the root bridge, in seconds. By default, the maximum
496 <column name="other_config" key="stp-forward-delay"
497 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
498 The delay to wait between transitioning root and designated
499 ports to <code>forwarding</code>, in seconds. By default, the
500 forwarding delay is 15 seconds.
504 <group title="Other Features">
505 <column name="datapath_type">
506 Name of datapath provider. The kernel datapath has
507 type <code>system</code>. The userspace datapath has
508 type <code>netdev</code>.
511 <column name="external_ids" key="bridge-id">
512 A unique identifier of the bridge. On Citrix XenServer this will
513 commonly be the same as
514 <ref column="external_ids" key="xs-network-uuids"/>.
517 <column name="external_ids" key="xs-network-uuids">
518 Semicolon-delimited set of universally unique identifier(s) for the
519 network with which this bridge is associated on a Citrix XenServer
520 host. The network identifiers are RFC 4122 UUIDs as displayed by,
521 e.g., <code>xe network-list</code>.
524 <column name="other_config" key="hwaddr">
525 An Ethernet address in the form
526 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
527 to set the hardware address of the local port and influence the
531 <column name="other_config" key="flow-eviction-threshold"
532 type='{"type": "integer", "minInteger": 0}'>
534 A number of flows as a nonnegative integer. This sets number of
535 flows at which eviction from the kernel flow table will be triggered.
536 If there are a large number of flows then increasing this value to
537 around the number of flows present can result in reduced CPU usage
541 The default is 1000. Values below 100 will be rounded up to 100.
545 <column name="other_config" key="forward-bpdu"
546 type='{"type": "boolean"}'>
547 Option to allow forwarding of BPDU frames when NORMAL action is
548 invoked. Frames with reserved Ethernet addresses (e.g. STP
549 BPDU) will be forwarded when this option is enabled and the
550 switch is not providing that functionality. If STP is enabled
551 on the port, STP BPDUs will never be forwarded. If the Open
552 vSwitch bridge is used to connect different Ethernet networks,
553 and if Open vSwitch node does not run STP, then this option
554 should be enabled. Default is disabled, set to
555 <code>true</code> to enable.
558 <column name="other_config" key="mac-aging-time"
559 type='{"type": "integer", "minInteger": 1}'>
561 The maximum number of seconds to retain a MAC learning entry for
562 which no packets have been seen. The default is currently 300
563 seconds (5 minutes). The value, if specified, is forced into a
564 reasonable range, currently 15 to 3600 seconds.
568 A short MAC aging time allows a network to more quickly detect that a
569 host is no longer connected to a switch port. However, it also makes
570 it more likely that packets will be flooded unnecessarily, when they
571 are addressed to a connected host that rarely transmits packets. To
572 reduce the incidence of unnecessary flooding, use a MAC aging time
573 longer than the maximum interval at which a host will ordinarily
579 <group title="Bridge Status">
581 Status information about bridges.
583 <column name="status">
584 Key-value pairs that report bridge status.
586 <column name="status" key="stp_bridge_id">
588 The bridge-id (in hex) used in spanning tree advertisements.
589 Configuring the bridge-id is described in the
590 <code>stp-system-id</code> and <code>stp-priority</code> keys
591 of the <code>other_config</code> section earlier.
594 <column name="status" key="stp_designated_root">
596 The designated root (in hex) for this spanning tree.
599 <column name="status" key="stp_root_path_cost">
601 The path cost of reaching the designated bridge. A lower
607 <group title="Common Columns">
608 The overall purpose of these columns is described under <code>Common
609 Columns</code> at the beginning of this document.
611 <column name="other_config"/>
612 <column name="external_ids"/>
616 <table name="Port" table="Port or bond configuration.">
617 <p>A port within a <ref table="Bridge"/>.</p>
618 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
619 <ref column="interfaces"/> column. Such a port logically
620 corresponds to a port on a physical Ethernet switch. A port
621 with more than one interface is a ``bonded port'' (see
622 <ref group="Bonding Configuration"/>).</p>
623 <p>Some properties that one might think as belonging to a port are actually
624 part of the port's <ref table="Interface"/> members.</p>
627 Port name. Should be alphanumeric and no more than about 8
628 bytes long. May be the same as the interface name, for
629 non-bonded ports. Must otherwise be unique among the names of
630 ports, interfaces, and bridges on a host.
633 <column name="interfaces">
634 The port's interfaces. If there is more than one, this is a
638 <group title="VLAN Configuration">
639 <p>Bridge ports support the following types of VLAN configuration:</p>
644 A trunk port carries packets on one or more specified VLANs
645 specified in the <ref column="trunks"/> column (often, on every
646 VLAN). A packet that ingresses on a trunk port is in the VLAN
647 specified in its 802.1Q header, or VLAN 0 if the packet has no
648 802.1Q header. A packet that egresses through a trunk port will
649 have an 802.1Q header if it has a nonzero VLAN ID.
653 Any packet that ingresses on a trunk port tagged with a VLAN that
654 the port does not trunk is dropped.
661 An access port carries packets on exactly one VLAN specified in the
662 <ref column="tag"/> column. Packets egressing on an access port
663 have no 802.1Q header.
667 Any packet with an 802.1Q header with a nonzero VLAN ID that
668 ingresses on an access port is dropped, regardless of whether the
669 VLAN ID in the header is the access port's VLAN ID.
673 <dt>native-tagged</dt>
675 A native-tagged port resembles a trunk port, with the exception that
676 a packet without an 802.1Q header that ingresses on a native-tagged
677 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
681 <dt>native-untagged</dt>
683 A native-untagged port resembles a native-tagged port, with the
684 exception that a packet that egresses on a native-untagged port in
685 the native VLAN will not have an 802.1Q header.
689 A packet will only egress through bridge ports that carry the VLAN of
690 the packet, as described by the rules above.
693 <column name="vlan_mode">
695 The VLAN mode of the port, as described above. When this column is
696 empty, a default mode is selected as follows:
700 If <ref column="tag"/> contains a value, the port is an access
701 port. The <ref column="trunks"/> column should be empty.
704 Otherwise, the port is a trunk port. The <ref column="trunks"/>
705 column value is honored if it is present.
712 For an access port, the port's implicitly tagged VLAN. For a
713 native-tagged or native-untagged port, the port's native VLAN. Must
714 be empty if this is a trunk port.
718 <column name="trunks">
720 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
721 or VLANs that this port trunks; if it is empty, then the port trunks
722 all VLANs. Must be empty if this is an access port.
725 A native-tagged or native-untagged port always trunks its native
726 VLAN, regardless of whether <ref column="trunks"/> includes that
731 <column name="other_config" key="priority-tags"
732 type='{"type": "boolean"}'>
734 An 802.1Q header contains two important pieces of information: a VLAN
735 ID and a priority. A frame with a zero VLAN ID, called a
736 ``priority-tagged'' frame, is supposed to be treated the same way as
737 a frame without an 802.1Q header at all (except for the priority).
741 However, some network elements ignore any frame that has 802.1Q
742 header at all, even when the VLAN ID is zero. Therefore, by default
743 Open vSwitch does not output priority-tagged frames, instead omitting
744 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
745 <code>true</code> to enable priority-tagged frames on a port.
749 Regardless of this setting, Open vSwitch omits the 802.1Q header on
750 output if both the VLAN ID and priority would be zero.
754 All frames output to native-tagged ports have a nonzero VLAN ID, so
755 this setting is not meaningful on native-tagged ports.
760 <group title="Bonding Configuration">
761 <p>A port that has more than one interface is a ``bonded port.'' Bonding
762 allows for load balancing and fail-over. Some kinds of bonding will
763 work with any kind of upstream switch:</p>
766 <dt><code>balance-slb</code></dt>
768 Balances flows among slaves based on source MAC address and output
769 VLAN, with periodic rebalancing as traffic patterns change.
772 <dt><code>active-backup</code></dt>
774 Assigns all flows to one slave, failing over to a backup slave when
775 the active slave is disabled.
780 The following modes require the upstream switch to support 802.3ad with
781 successful LACP negotiation:
785 <dt><code>balance-tcp</code></dt>
787 Balances flows among slaves based on L2, L3, and L4 protocol
788 information such as destination MAC address, IP address, and TCP
792 <dt><code>stable</code></dt>
794 <p>Attempts to always assign a given flow to the same slave
795 consistently. In an effort to maintain stability, no load
796 balancing is done. Uses a similar hashing strategy to
797 <code>balance-tcp</code>, always taking into account L3 and L4
798 fields even if LACP negotiations are unsuccessful. </p>
799 <p>Slave selection decisions are made based on <ref table="Interface"
800 column="other_config" key="bond-stable-id"/> if set. Otherwise,
801 OpenFlow port number is used. Decisions are consistent across all
802 <code>ovs-vswitchd</code> instances with equivalent
803 <ref table="Interface" column="other_config" key="bond-stable-id"/>
808 <p>These columns apply only to bonded ports. Their values are
809 otherwise ignored.</p>
811 <column name="bond_mode">
812 <p>The type of bonding used for a bonded port. Defaults to
813 <code>active-backup</code> if unset.
817 <column name="other_config" key="bond-hash-basis"
818 type='{"type": "integer"}'>
819 An integer hashed along with flows when choosing output slaves in load
820 balanced bonds. When changed, all flows will be assigned different
821 hash values possibly causing slave selection decisions to change. Does
822 not affect bonding modes which do not employ load balancing such as
823 <code>active-backup</code>.
826 <group title="Link Failure Detection">
828 An important part of link bonding is detecting that links are down so
829 that they may be disabled. These settings determine how Open vSwitch
830 detects link failure.
833 <column name="other_config" key="bond-detect-mode"
834 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
835 The means used to detect link failures. Defaults to
836 <code>carrier</code> which uses each interface's carrier to detect
837 failures. When set to <code>miimon</code>, will check for failures
838 by polling each interface's MII.
841 <column name="other_config" key="bond-miimon-interval"
842 type='{"type": "integer"}'>
843 The interval, in milliseconds, between successive attempts to poll
844 each interface's MII. Relevant only when <ref column="other_config"
845 key="bond-detect-mode"/> is <code>miimon</code>.
848 <column name="bond_updelay">
850 The number of milliseconds for which carrier must stay up on an
851 interface before the interface is considered to be up. Specify
852 <code>0</code> to enable the interface immediately.
856 This setting is honored only when at least one bonded interface is
857 already enabled. When no interfaces are enabled, then the first
858 bond interface to come up is enabled immediately.
862 <column name="bond_downdelay">
863 The number of milliseconds for which carrier must stay down on an
864 interface before the interface is considered to be down. Specify
865 <code>0</code> to disable the interface immediately.
869 <group title="LACP Configuration">
871 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
872 allows switches to automatically detect that they are connected by
873 multiple links and aggregate across those links. These settings
874 control LACP behavior.
878 Configures LACP on this port. LACP allows directly connected
879 switches to negotiate which links may be bonded. LACP may be enabled
880 on non-bonded ports for the benefit of any switches they may be
881 connected to. <code>active</code> ports are allowed to initiate LACP
882 negotiations. <code>passive</code> ports are allowed to participate
883 in LACP negotiations initiated by a remote switch, but not allowed to
884 initiate such negotiations themselves. If LACP is enabled on a port
885 whose partner switch does not support LACP, the bond will be
886 disabled. Defaults to <code>off</code> if unset.
889 <column name="other_config" key="lacp-system-id">
890 The LACP system ID of this <ref table="Port"/>. The system ID of a
891 LACP bond is used to identify itself to its partners. Must be a
892 nonzero MAC address. Defaults to the bridge Ethernet address if
896 <column name="other_config" key="lacp-system-priority"
897 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
898 The LACP system priority of this <ref table="Port"/>. In LACP
899 negotiations, link status decisions are made by the system with the
900 numerically lower priority.
903 <column name="other_config" key="lacp-time"
904 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
906 The LACP timing which should be used on this <ref table="Port"/>.
907 By default <code>slow</code> is used. When configured to be
908 <code>fast</code> LACP heartbeats are requested at a rate of once
909 per second causing connectivity problems to be detected more
910 quickly. In <code>slow</code> mode, heartbeats are requested at a
911 rate of once every 30 seconds.
916 <group title="SLB Configuration">
918 These settings control behavior when a bond is in
919 <code>balance-slb</code> mode, regardless of whether the bond was
920 intentionally configured in SLB mode or it fell back to SLB mode
921 because LACP negotiation failed.
924 <column name="other_config" key="bond-rebalance-interval"
925 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
926 For a load balanced bonded port, the number of milliseconds between
927 successive attempts to rebalance the bond, that is, to move flows
928 from one interface on the bond to another in an attempt to keep usage
929 of each interface roughly equal. If zero, load balancing is disabled
930 on the bond (carrier status changes still cause flows to move). If
931 less than 1000ms, the rebalance interval will be 1000ms.
935 <column name="bond_fake_iface">
936 For a bonded port, whether to create a fake internal interface with the
937 name of the port. Use only for compatibility with legacy software that
942 <group title="Spanning Tree Configuration">
943 <column name="other_config" key="stp-enable"
944 type='{"type": "boolean"}'>
945 If spanning tree is enabled on the bridge, member ports are
946 enabled by default (with the exception of bond, internal, and
947 mirror ports which do not work with STP). If this column's
948 value is <code>false</code> spanning tree is disabled on the
952 <column name="other_config" key="stp-port-num"
953 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
954 The port number used for the lower 8 bits of the port-id. By
955 default, the numbers will be assigned automatically. If any
956 port's number is manually configured on a bridge, then they
960 <column name="other_config" key="stp-port-priority"
961 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
962 The port's relative priority value for determining the root
963 port (the upper 8 bits of the port-id). A port with a lower
964 port-id will be chosen as the root port. By default, the
968 <column name="other_config" key="stp-path-cost"
969 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
970 Spanning tree path cost for the port. A lower number indicates
971 a faster link. By default, the cost is based on the maximum
976 <group title="Other Features">
978 Quality of Service configuration for this port.
982 The MAC address to use for this port for the purpose of choosing the
983 bridge's MAC address. This column does not necessarily reflect the
984 port's actual MAC address, nor will setting it change the port's actual
988 <column name="fake_bridge">
989 Does this port represent a sub-bridge for its tagged VLAN within the
990 Bridge? See ovs-vsctl(8) for more information.
993 <column name="external_ids" key="fake-bridge-id-*">
994 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
995 column) are defined by prefixing a <ref table="Bridge"/> <ref
996 table="Bridge" column="external_ids"/> key with
997 <code>fake-bridge-</code>,
998 e.g. <code>fake-bridge-xs-network-uuids</code>.
1002 <group title="Port Status">
1004 Status information about ports attached to bridges.
1006 <column name="status">
1007 Key-value pairs that report port status.
1009 <column name="status" key="stp_port_id">
1011 The port-id (in hex) used in spanning tree advertisements for
1012 this port. Configuring the port-id is described in the
1013 <code>stp-port-num</code> and <code>stp-port-priority</code>
1014 keys of the <code>other_config</code> section earlier.
1017 <column name="status" key="stp_state"
1018 type='{"type": "string", "enum": ["set",
1019 ["disabled", "listening", "learning",
1020 "forwarding", "blocking"]]}'>
1022 STP state of the port.
1025 <column name="status" key="stp_sec_in_state"
1026 type='{"type": "integer", "minInteger": 0}'>
1028 The amount of time (in seconds) port has been in the current
1032 <column name="status" key="stp_role"
1033 type='{"type": "string", "enum": ["set",
1034 ["root", "designated", "alternate"]]}'>
1036 STP role of the port.
1041 <group title="Port Statistics">
1043 Key-value pairs that report port statistics.
1045 <group title="Statistics: STP transmit and receive counters">
1046 <column name="statistics" key="stp_tx_count">
1047 Number of STP BPDUs sent on this port by the spanning
1050 <column name="statistics" key="stp_rx_count">
1051 Number of STP BPDUs received on this port and accepted by the
1052 spanning tree library.
1054 <column name="statistics" key="stp_error_count">
1055 Number of bad STP BPDUs received on this port. Bad BPDUs
1056 include runt packets and those with an unexpected protocol ID.
1061 <group title="Common Columns">
1062 The overall purpose of these columns is described under <code>Common
1063 Columns</code> at the beginning of this document.
1065 <column name="other_config"/>
1066 <column name="external_ids"/>
1070 <table name="Interface" title="One physical network device in a Port.">
1071 An interface within a <ref table="Port"/>.
1073 <group title="Core Features">
1074 <column name="name">
1075 Interface name. Should be alphanumeric and no more than about 8 bytes
1076 long. May be the same as the port name, for non-bonded ports. Must
1077 otherwise be unique among the names of ports, interfaces, and bridges
1082 <p>Ethernet address to set for this interface. If unset then the
1083 default MAC address is used:</p>
1085 <li>For the local interface, the default is the lowest-numbered MAC
1086 address among the other bridge ports, either the value of the
1087 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1088 if set, or its actual MAC (for bonded ports, the MAC of its slave
1089 whose name is first in alphabetical order). Internal ports and
1090 bridge ports that are used as port mirroring destinations (see the
1091 <ref table="Mirror"/> table) are ignored.</li>
1092 <li>For other internal interfaces, the default MAC is randomly
1094 <li>External interfaces typically have a MAC address associated with
1095 their hardware.</li>
1097 <p>Some interfaces may not have a software-controllable MAC
1101 <column name="ofport">
1102 <p>OpenFlow port number for this interface. Unlike most columns, this
1103 column's value should be set only by Open vSwitch itself. Other
1104 clients should set this column to an empty set (the default) when
1105 creating an <ref table="Interface"/>.</p>
1106 <p>Open vSwitch populates this column when the port number becomes
1107 known. If the interface is successfully added,
1108 <ref column="ofport"/> will be set to a number between 1 and 65535
1109 (generally either in the range 1 to 65279, inclusive, or 65534, the
1110 port number for the OpenFlow ``local port''). If the interface
1111 cannot be added then Open vSwitch sets this column
1116 <group title="System-Specific Details">
1117 <column name="type">
1119 The interface type, one of:
1123 <dt><code>system</code></dt>
1124 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1125 Sometimes referred to as ``external interfaces'' since they are
1126 generally connected to hardware external to that on which the Open
1127 vSwitch is running. The empty string is a synonym for
1128 <code>system</code>.</dd>
1130 <dt><code>internal</code></dt>
1131 <dd>A simulated network device that sends and receives traffic. An
1132 internal interface whose <ref column="name"/> is the same as its
1133 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1134 ``local interface.'' It does not make sense to bond an internal
1135 interface, so the terms ``port'' and ``interface'' are often used
1136 imprecisely for internal interfaces.</dd>
1138 <dt><code>tap</code></dt>
1139 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1141 <dt><code>gre</code></dt>
1143 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1144 tunnel. See <ref group="Tunnel Options"/> for information on
1145 configuring GRE tunnels.
1148 <dt><code>ipsec_gre</code></dt>
1150 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1154 <dt><code>capwap</code></dt>
1156 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1157 5415). This allows interoperability with certain switches that do
1158 not support GRE. Only the tunneling component of the protocol is
1159 implemented. UDP ports 58881 and 58882 are used as the source and
1160 destination ports respectively. CAPWAP is currently supported only
1161 with the Linux kernel datapath with kernel version 2.6.26 or later.
1164 <dt><code>patch</code></dt>
1166 A pair of virtual devices that act as a patch cable.
1169 <dt><code>null</code></dt>
1170 <dd>An ignored interface.</dd>
1175 <group title="Tunnel Options">
1177 These options apply to interfaces with <ref column="type"/> of
1178 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1182 Each tunnel must be uniquely identified by the combination of <ref
1183 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1184 column="options" key="local_ip"/>, and <ref column="options"
1185 key="in_key"/>. If two ports are defined that are the same except one
1186 has an optional identifier and the other does not, the more specific
1187 one is matched first. <ref column="options" key="in_key"/> is
1188 considered more specific than <ref column="options" key="local_ip"/> if
1189 a port defines one and another port defines the other.
1192 <column name="options" key="remote_ip">
1194 Required. The tunnel endpoint. Unicast and multicast endpoints are
1199 When a multicast endpoint is specified, a routing table lookup occurs
1200 only when the tunnel is created. Following a routing change, delete
1201 and then re-create the tunnel to force a new routing table lookup.
1205 <column name="options" key="local_ip">
1206 Optional. The destination IP that received packets must match.
1207 Default is to match all addresses. Must be omitted when <ref
1208 column="options" key="remote_ip"/> is a multicast address.
1211 <column name="options" key="in_key">
1212 <p>Optional. The key that received packets must contain, one of:</p>
1216 <code>0</code>. The tunnel receives packets with no key or with a
1217 key of 0. This is equivalent to specifying no <ref column="options"
1218 key="in_key"/> at all.
1221 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1222 tunnel receives only packets with the specified key.
1225 The word <code>flow</code>. The tunnel accepts packets with any
1226 key. The key will be placed in the <code>tun_id</code> field for
1227 matching in the flow table. The <code>ovs-ofctl</code> manual page
1228 contains additional information about matching fields in OpenFlow
1237 <column name="options" key="out_key">
1238 <p>Optional. The key to be set on outgoing packets, one of:</p>
1242 <code>0</code>. Packets sent through the tunnel will have no key.
1243 This is equivalent to specifying no <ref column="options"
1244 key="out_key"/> at all.
1247 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1248 sent through the tunnel will have the specified key.
1251 The word <code>flow</code>. Packets sent through the tunnel will
1252 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1253 vendor extension (0 is used in the absence of an action). The
1254 <code>ovs-ofctl</code> manual page contains additional information
1255 about the Nicira OpenFlow vendor extensions.
1260 <column name="options" key="key">
1261 Optional. Shorthand to set <code>in_key</code> and
1262 <code>out_key</code> at the same time.
1265 <column name="options" key="tos">
1266 Optional. The value of the ToS bits to be set on the encapsulating
1267 packet. It may also be the word <code>inherit</code>, in which case
1268 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1269 (otherwise it will be 0). The ECN fields are always inherited.
1273 <column name="options" key="ttl">
1274 Optional. The TTL to be set on the encapsulating packet. It may also
1275 be the word <code>inherit</code>, in which case the TTL will be copied
1276 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1277 system default, typically 64). Default is the system default TTL.
1280 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1281 Optional. If enabled, the Don't Fragment bit will be copied from the
1282 inner IP headers (those of the encapsulated traffic) to the outer
1283 (tunnel) headers. Default is disabled; set to <code>true</code> to
1287 <column name="options" key="df_default"
1288 type='{"type": "boolean"}'>
1289 Optional. If enabled, the Don't Fragment bit will be set by default on
1290 tunnel headers if the <code>df_inherit</code> option is not set, or if
1291 the encapsulated packet is not IP. Default is enabled; set to
1292 <code>false</code> to disable.
1295 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1296 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1297 Destination Unreachable - Fragmentation Needed'' messages will be
1298 generated for IPv4 packets with the DF bit set and IPv6 packets above
1299 the minimum MTU if the packet size exceeds the path MTU minus the size
1300 of the tunnel headers. Note that this option causes behavior that is
1301 typically reserved for routers and therefore is not entirely in
1302 compliance with the IEEE 802.1D specification for bridges. Default is
1303 enabled; set to <code>false</code> to disable.
1306 <group title="Tunnel Options: gre only">
1308 Only <code>gre</code> interfaces support these options.
1311 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1312 Enable caching of tunnel headers and the output path. This can lead
1313 to a significant performance increase without changing behavior. In
1314 general it should not be necessary to adjust this setting. However,
1315 the caching can bypass certain components of the IP stack (such as
1316 <code>iptables</code>) and it may be useful to disable it if these
1317 features are required or as a debugging measure. Default is enabled,
1318 set to <code>false</code> to disable.
1322 <group title="Tunnel Options: gre and ipsec_gre only">
1324 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1328 <column name="options" key="csum" type='{"type": "boolean"}'>
1330 Optional. Compute GRE checksums on outgoing packets. Default is
1331 disabled, set to <code>true</code> to enable. Checksums present on
1332 incoming packets will be validated regardless of this setting.
1336 GRE checksums impose a significant performance penalty because they
1337 cover the entire packet. The encapsulated L3, L4, and L7 packet
1338 contents typically have their own checksums, so this additional
1339 checksum only adds value for the GRE and encapsulated L2 headers.
1343 This option is supported for <code>ipsec_gre</code>, but not useful
1344 because GRE checksums are weaker than, and redundant with, IPsec
1345 payload authentication.
1350 <group title="Tunnel Options: ipsec_gre only">
1352 Only <code>ipsec_gre</code> interfaces support these options.
1355 <column name="options" key="peer_cert">
1356 Required for certificate authentication. A string containing the
1357 peer's certificate in PEM format. Additionally the host's
1358 certificate must be specified with the <code>certificate</code>
1362 <column name="options" key="certificate">
1363 Required for certificate authentication. The name of a PEM file
1364 containing a certificate that will be presented to the peer during
1368 <column name="options" key="private_key">
1369 Optional for certificate authentication. The name of a PEM file
1370 containing the private key associated with <code>certificate</code>.
1371 If <code>certificate</code> contains the private key, this option may
1375 <column name="options" key="psk">
1376 Required for pre-shared key authentication. Specifies a pre-shared
1377 key for authentication that must be identical on both sides of the
1383 <group title="Patch Options">
1385 Only <code>patch</code> interfaces support these options.
1388 <column name="options" key="peer">
1389 The <ref column="name"/> of the <ref table="Interface"/> for the other
1390 side of the patch. The named <ref table="Interface"/>'s own
1391 <code>peer</code> option must specify this <ref table="Interface"/>'s
1392 name. That is, the two patch interfaces must have reversed <ref
1393 column="name"/> and <code>peer</code> values.
1397 <group title="Interface Status">
1399 Status information about interfaces attached to bridges, updated every
1400 5 seconds. Not all interfaces have all of these properties; virtual
1401 interfaces don't have a link speed, for example. Non-applicable
1402 columns will have empty values.
1404 <column name="admin_state">
1406 The administrative state of the physical network link.
1410 <column name="link_state">
1412 The observed state of the physical network link. This is ordinarily
1413 the link's carrier status. If the interface's <ref table="Port"/> is
1414 a bond configured for miimon monitoring, it is instead the network
1415 link's miimon status.
1419 <column name="link_resets">
1421 The number of times Open vSwitch has observed the
1422 <ref column="link_state"/> of this <ref table="Interface"/> change.
1426 <column name="link_speed">
1428 The negotiated speed of the physical network link.
1429 Valid values are positive integers greater than 0.
1433 <column name="duplex">
1435 The duplex mode of the physical network link.
1441 The MTU (maximum transmission unit); i.e. the largest
1442 amount of data that can fit into a single Ethernet frame.
1443 The standard Ethernet MTU is 1500 bytes. Some physical media
1444 and many kinds of virtual interfaces can be configured with
1448 This column will be empty for an interface that does not
1449 have an MTU as, for example, some kinds of tunnels do not.
1453 <column name="lacp_current">
1454 Boolean value indicating LACP status for this interface. If true, this
1455 interface has current LACP information about its LACP partner. This
1456 information may be used to monitor the health of interfaces in a LACP
1457 enabled port. This column will be empty if LACP is not enabled.
1460 <column name="status">
1461 Key-value pairs that report port status. Supported status values are
1462 <ref column="type"/>-dependent; some interfaces may not have a valid
1463 <ref column="status" key="driver_name"/>, for example.
1466 <column name="status" key="driver_name">
1467 The name of the device driver controlling the network adapter.
1470 <column name="status" key="driver_version">
1471 The version string of the device driver controlling the network
1475 <column name="status" key="firmware_version">
1476 The version string of the network adapter's firmware, if available.
1479 <column name="status" key="source_ip">
1480 The source IP address used for an IPv4 tunnel end-point, such as
1481 <code>gre</code> or <code>capwap</code>.
1484 <column name="status" key="tunnel_egress_iface">
1485 Egress interface for tunnels. Currently only relevant for GRE and
1486 CAPWAP tunnels. On Linux systems, this column will show the name of
1487 the interface which is responsible for routing traffic destined for the
1488 configured <ref column="options" key="remote_ip"/>. This could be an
1489 internal interface such as a bridge port.
1492 <column name="status" key="tunnel_egress_iface_carrier"
1493 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1494 Whether carrier is detected on <ref column="status"
1495 key="tunnel_egress_iface"/>.
1499 <group title="Statistics">
1501 Key-value pairs that report interface statistics. The current
1502 implementation updates these counters periodically. Future
1503 implementations may update them when an interface is created, when they
1504 are queried (e.g. using an OVSDB <code>select</code> operation), and
1505 just before an interface is deleted due to virtual interface hot-unplug
1506 or VM shutdown, and perhaps at other times, but not on any regular
1510 These are the same statistics reported by OpenFlow in its <code>struct
1511 ofp_port_stats</code> structure. If an interface does not support a
1512 given statistic, then that pair is omitted.
1514 <group title="Statistics: Successful transmit and receive counters">
1515 <column name="statistics" key="rx_packets">
1516 Number of received packets.
1518 <column name="statistics" key="rx_bytes">
1519 Number of received bytes.
1521 <column name="statistics" key="tx_packets">
1522 Number of transmitted packets.
1524 <column name="statistics" key="tx_bytes">
1525 Number of transmitted bytes.
1528 <group title="Statistics: Receive errors">
1529 <column name="statistics" key="rx_dropped">
1530 Number of packets dropped by RX.
1532 <column name="statistics" key="rx_frame_err">
1533 Number of frame alignment errors.
1535 <column name="statistics" key="rx_over_err">
1536 Number of packets with RX overrun.
1538 <column name="statistics" key="rx_crc_err">
1539 Number of CRC errors.
1541 <column name="statistics" key="rx_errors">
1542 Total number of receive errors, greater than or equal to the sum of
1546 <group title="Statistics: Transmit errors">
1547 <column name="statistics" key="tx_dropped">
1548 Number of packets dropped by TX.
1550 <column name="statistics" key="collisions">
1551 Number of collisions.
1553 <column name="statistics" key="tx_errors">
1554 Total number of transmit errors, greater than or equal to the sum of
1560 <group title="Ingress Policing">
1562 These settings control ingress policing for packets received on this
1563 interface. On a physical interface, this limits the rate at which
1564 traffic is allowed into the system from the outside; on a virtual
1565 interface (one connected to a virtual machine), this limits the rate at
1566 which the VM is able to transmit.
1569 Policing is a simple form of quality-of-service that simply drops
1570 packets received in excess of the configured rate. Due to its
1571 simplicity, policing is usually less accurate and less effective than
1572 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1573 table="Queue"/> tables).
1576 Policing is currently implemented only on Linux. The Linux
1577 implementation uses a simple ``token bucket'' approach:
1581 The size of the bucket corresponds to <ref
1582 column="ingress_policing_burst"/>. Initially the bucket is full.
1585 Whenever a packet is received, its size (converted to tokens) is
1586 compared to the number of tokens currently in the bucket. If the
1587 required number of tokens are available, they are removed and the
1588 packet is forwarded. Otherwise, the packet is dropped.
1591 Whenever it is not full, the bucket is refilled with tokens at the
1592 rate specified by <ref column="ingress_policing_rate"/>.
1596 Policing interacts badly with some network protocols, and especially
1597 with fragmented IP packets. Suppose that there is enough network
1598 activity to keep the bucket nearly empty all the time. Then this token
1599 bucket algorithm will forward a single packet every so often, with the
1600 period depending on packet size and on the configured rate. All of the
1601 fragments of an IP packets are normally transmitted back-to-back, as a
1602 group. In such a situation, therefore, only one of these fragments
1603 will be forwarded and the rest will be dropped. IP does not provide
1604 any way for the intended recipient to ask for only the remaining
1605 fragments. In such a case there are two likely possibilities for what
1606 will happen next: either all of the fragments will eventually be
1607 retransmitted (as TCP will do), in which case the same problem will
1608 recur, or the sender will not realize that its packet has been dropped
1609 and data will simply be lost (as some UDP-based protocols will do).
1610 Either way, it is possible that no forward progress will ever occur.
1612 <column name="ingress_policing_rate">
1614 Maximum rate for data received on this interface, in kbps. Data
1615 received faster than this rate is dropped. Set to <code>0</code>
1616 (the default) to disable policing.
1620 <column name="ingress_policing_burst">
1621 <p>Maximum burst size for data received on this interface, in kb. The
1622 default burst size if set to <code>0</code> is 1000 kb. This value
1623 has no effect if <ref column="ingress_policing_rate"/>
1624 is <code>0</code>.</p>
1626 Specifying a larger burst size lets the algorithm be more forgiving,
1627 which is important for protocols like TCP that react severely to
1628 dropped packets. The burst size should be at least the size of the
1629 interface's MTU. Specifying a value that is numerically at least as
1630 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1631 closer to achieving the full rate.
1636 <group title="Connectivity Fault Management">
1638 802.1ag Connectivity Fault Management (CFM) allows a group of
1639 Maintenance Points (MPs) called a Maintenance Association (MA) to
1640 detect connectivity problems with each other. MPs within a MA should
1641 have complete and exclusive interconnectivity. This is verified by
1642 occasionally broadcasting Continuity Check Messages (CCMs) at a
1643 configurable transmission interval.
1647 According to the 802.1ag specification, each Maintenance Point should
1648 be configured out-of-band with a list of Remote Maintenance Points it
1649 should have connectivity to. Open vSwitch differs from the
1650 specification in this area. It simply assumes the link is faulted if
1651 no Remote Maintenance Points are reachable, and considers it not
1655 <column name="cfm_mpid">
1656 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1657 a Maintenance Association. The MPID is used to identify this endpoint
1658 to other Maintenance Points in the MA. Each end of a link being
1659 monitored should have a different MPID. Must be configured to enable
1660 CFM on this <ref table="Interface"/>.
1663 <column name="cfm_fault">
1665 Indicates a connectivity fault triggered by an inability to receive
1666 heartbeats from any remote endpoint. When a fault is triggered on
1667 <ref table="Interface"/>s participating in bonds, they will be
1671 Faults can be triggered for several reasons. Most importantly they
1672 are triggered when no CCMs are received for a period of 3.5 times the
1673 transmission interval. Faults are also triggered when any CCMs
1674 indicate that a Remote Maintenance Point is not receiving CCMs but
1675 able to send them. Finally, a fault is triggered if a CCM is
1676 received which indicates unexpected configuration. Notably, this
1677 case arises when a CCM is received which advertises the local MPID.
1681 <column name="cfm_fault_status" key="recv">
1682 Indicates a CFM fault was triggered due to a lack of CCMs received on
1683 the <ref table="Interface"/>.
1686 <column name="cfm_fault_status" key="rdi">
1687 Indicates a CFM fault was triggered due to the reception of a CCM with
1688 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1689 are not receiving CCMs themselves. This typically indicates a
1690 unidirectional connectivity failure.
1693 <column name="cfm_fault_status" key="maid">
1694 Indicates a CFM fault was triggered due to the reception of a CCM with
1695 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1696 with an identification number in addition to the MPID called the MAID.
1697 Open vSwitch only supports receiving CCM broadcasts tagged with the
1698 MAID it uses internally.
1701 <column name="cfm_fault_status" key="loopback">
1702 Indicates a CFM fault was triggered due to the reception of a CCM
1703 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1704 column of this <ref table="Interface"/>. This may indicate a loop in
1708 <column name="cfm_fault_status" key="overflow">
1709 Indicates a CFM fault was triggered because the CFM module received
1710 CCMs from more remote endpoints than it can keep track of.
1713 <column name="cfm_fault_status" key="override">
1714 Indicates a CFM fault was manually triggered by an administrator using
1715 an <code>ovs-appctl</code> command.
1718 <column name="cfm_fault_status" key="interval">
1719 Indicates a CFM fault was triggered due to the reception of a CCM
1720 frame having an invalid interval.
1723 <column name="cfm_fault_status" key="sequence">
1724 Indicates a CFM fault was triggered because the CFM module received
1725 a CCM frame with a sequence number that it was not expecting.
1728 <column name="cfm_health">
1730 Indicates the health of the interface as a percentage of CCM frames
1731 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1732 The health of an interface is undefined if it is communicating with
1733 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1734 healthy heartbeats are not received at the expected rate, and
1735 gradually improves as healthy heartbeats are received at the desired
1736 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1737 health of the interface is refreshed.
1740 As mentioned above, the faults can be triggered for several reasons.
1741 The link health will deteriorate even if heartbeats are received but
1742 they are reported to be unhealthy. An unhealthy heartbeat in this
1743 context is a heartbeat for which either some fault is set or is out
1744 of sequence. The interface health can be 100 only on receiving
1745 healthy heartbeats at the desired rate.
1749 <column name="cfm_remote_mpids">
1750 When CFM is properly configured, Open vSwitch will occasionally
1751 receive CCM broadcasts. These broadcasts contain the MPID of the
1752 sending Maintenance Point. The list of MPIDs from which this
1753 <ref table="Interface"/> is receiving broadcasts from is regularly
1754 collected and written to this column.
1757 <column name="other_config" key="cfm_interval"
1758 type='{"type": "integer"}'>
1760 The interval, in milliseconds, between transmissions of CFM
1761 heartbeats. Three missed heartbeat receptions indicate a
1766 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1767 60,000, or 600,000 ms are supported. Other values will be rounded
1768 down to the nearest value on the list. Extended mode (see <ref
1769 column="other_config" key="cfm_extended"/>) supports any interval up
1770 to 65,535 ms. In either mode, the default is 1000 ms.
1773 <p>We do not recommend using intervals less than 100 ms.</p>
1776 <column name="other_config" key="cfm_extended"
1777 type='{"type": "boolean"}'>
1778 When <code>true</code>, the CFM module operates in extended mode. This
1779 causes it to use a nonstandard destination address to avoid conflicting
1780 with compliant implementations which may be running concurrently on the
1781 network. Furthermore, extended mode increases the accuracy of the
1782 <code>cfm_interval</code> configuration parameter by breaking wire
1783 compatibility with 802.1ag compliant implementations. Defaults to
1786 <column name="other_config" key="cfm_opstate"
1787 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1788 When <code>down</code>, the CFM module marks all CCMs it generates as
1789 operationally down without triggering a fault. This allows remote
1790 maintenance points to choose not to forward traffic to the
1791 <ref table="Interface"/> on which this CFM module is running.
1792 Currently, in Open vSwitch, the opdown bit of CCMs affects
1793 <ref table="Interface"/>s participating in bonds, and the bundle
1794 OpenFlow action. This setting is ignored when CFM is not in extended
1795 mode. Defaults to <code>up</code>.
1798 <column name="other_config" key="cfm_ccm_vlan"
1799 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1800 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1801 with the given value. May be the string <code>random</code> in which
1802 case each CCM will be tagged with a different randomly generated VLAN.
1805 <column name="other_config" key="cfm_ccm_pcp"
1806 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1807 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1808 with the given PCP value. The VLAN ID of the tag is governed by the
1809 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1810 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1816 <group title="Bonding Configuration">
1817 <column name="other_config" key="bond-stable-id"
1818 type='{"type": "integer", "minInteger": 1}'>
1819 Used in <code>stable</code> bond mode to make slave
1820 selection decisions. Allocating <ref column="other_config"
1821 key="bond-stable-id"/> values consistently across interfaces
1822 participating in a bond will guarantee consistent slave selection
1823 decisions across <code>ovs-vswitchd</code> instances when using
1824 <code>stable</code> bonding mode.
1827 <column name="other_config" key="lacp-port-id"
1828 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1829 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1830 used in LACP negotiations to identify individual ports
1831 participating in a bond.
1834 <column name="other_config" key="lacp-port-priority"
1835 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1836 The LACP port priority of this <ref table="Interface"/>. In LACP
1837 negotiations <ref table="Interface"/>s with numerically lower
1838 priorities are preferred for aggregation.
1841 <column name="other_config" key="lacp-aggregation-key"
1842 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1843 The LACP aggregation key of this <ref table="Interface"/>. <ref
1844 table="Interface"/>s with different aggregation keys may not be active
1845 within a given <ref table="Port"/> at the same time.
1849 <group title="Virtual Machine Identifiers">
1851 These key-value pairs specifically apply to an interface that
1852 represents a virtual Ethernet interface connected to a virtual
1853 machine. These key-value pairs should not be present for other types
1854 of interfaces. Keys whose names end in <code>-uuid</code> have
1855 values that uniquely identify the entity in question. For a Citrix
1856 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1857 Other hypervisors may use other formats.
1860 <column name="external_ids" key="attached-mac">
1861 The MAC address programmed into the ``virtual hardware'' for this
1862 interface, in the form
1863 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1864 For Citrix XenServer, this is the value of the <code>MAC</code> field
1865 in the VIF record for this interface.
1868 <column name="external_ids" key="iface-id">
1869 A system-unique identifier for the interface. On XenServer, this will
1870 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1873 <column name="external_ids" key="iface-status"
1874 type='{"type": "string",
1875 "enum": ["set", ["active", "inactive"]]}'>
1877 Hypervisors may sometimes have more than one interface associated
1878 with a given <ref column="external_ids" key="iface-id"/>, only one of
1879 which is actually in use at a given time. For example, in some
1880 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1881 for a single <ref column="external_ids" key="iface-id"/>, but only
1882 uses one of them at a time. A hypervisor that behaves this way must
1883 mark the currently in use interface <code>active</code> and the
1884 others <code>inactive</code>. A hypervisor that never has more than
1885 one interface for a given <ref column="external_ids" key="iface-id"/>
1886 may mark that interface <code>active</code> or omit <ref
1887 column="external_ids" key="iface-status"/> entirely.
1891 During VM migration, a given <ref column="external_ids"
1892 key="iface-id"/> might transiently be marked <code>active</code> on
1893 two different hypervisors. That is, <code>active</code> means that
1894 this <ref column="external_ids" key="iface-id"/> is the active
1895 instance within a single hypervisor, not in a broader scope.
1899 <column name="external_ids" key="xs-vif-uuid">
1900 The virtual interface associated with this interface.
1903 <column name="external_ids" key="xs-network-uuid">
1904 The virtual network to which this interface is attached.
1907 <column name="external_ids" key="vm-id">
1908 The VM to which this interface belongs. On XenServer, this will be the
1909 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1912 <column name="external_ids" key="xs-vm-uuid">
1913 The VM to which this interface belongs.
1917 <group title="VLAN Splinters">
1919 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1920 with buggy network drivers in old versions of Linux that do not
1921 properly support VLANs when VLAN devices are not used, at some cost
1922 in memory and performance.
1926 When VLAN splinters are enabled on a particular interface, Open vSwitch
1927 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1928 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1929 received on the VLAN device is treated as if it had been received on
1930 the interface on the particular VLAN.
1934 VLAN splinters consider a VLAN to be in use if:
1939 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1940 table="Port"/> record.
1944 The VLAN is listed within the <ref table="Port" column="trunks"/>
1945 column of the <ref table="Port"/> record of an interface on which
1946 VLAN splinters are enabled.
1948 An empty <ref table="Port" column="trunks"/> does not influence the
1949 in-use VLANs: creating 4,096 VLAN devices is impractical because it
1950 will exceed the current 1,024 port per datapath limit.
1954 An OpenFlow flow within any bridge matches the VLAN.
1959 The same set of in-use VLANs applies to every interface on which VLAN
1960 splinters are enabled. That is, the set is not chosen separately for
1961 each interface but selected once as the union of all in-use VLANs based
1966 It does not make sense to enable VLAN splinters on an interface for an
1967 access port, or on an interface that is not a physical port.
1971 VLAN splinters are deprecated. When broken device drivers are no
1972 longer in widespread use, we will delete this feature.
1975 <column name="other_config" key="enable-vlan-splinters"
1976 type='{"type": "boolean"}'>
1978 Set to <code>true</code> to enable VLAN splinters on this interface.
1979 Defaults to <code>false</code>.
1983 VLAN splinters increase kernel and userspace memory overhead, so do
1984 not use them unless they are needed.
1988 VLAN splinters do not support 802.1p priority tags. Received
1989 priorities will appear to be 0, regardless of their actual values,
1990 and priorities on transmitted packets will also be cleared to 0.
1995 <group title="Common Columns">
1996 The overall purpose of these columns is described under <code>Common
1997 Columns</code> at the beginning of this document.
1999 <column name="other_config"/>
2000 <column name="external_ids"/>
2004 <table name="Flow_Table" title="OpenFlow table configuration">
2005 <p>Configuration for a particular OpenFlow table.</p>
2007 <column name="name">
2008 The table's name. Set this column to change the name that controllers
2009 will receive when they request table statistics, e.g. <code>ovs-ofctl
2010 dump-tables</code>. The name does not affect switch behavior.
2013 <column name="flow_limit">
2014 If set, limits the number of flows that may be added to the table. Open
2015 vSwitch may limit the number of flows in a table for other reasons,
2016 e.g. due to hardware limitations or for resource availability or
2017 performance reasons.
2020 <column name="overflow_policy">
2022 Controls the switch's behavior when an OpenFlow flow table modification
2023 request would add flows in excess of <ref column="flow_limit"/>. The
2024 supported values are:
2028 <dt><code>refuse</code></dt>
2030 Refuse to add the flow or flows. This is also the default policy
2031 when <ref column="overflow_policy"/> is unset.
2034 <dt><code>evict</code></dt>
2036 Delete the flow that will expire soonest. See <ref column="groups"/>
2042 <column name="groups">
2044 When <ref column="overflow_policy"/> is <code>evict</code>, this
2045 controls how flows are chosen for eviction when the flow table would
2046 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2047 of NXM fields or sub-fields, each of which takes one of the forms
2048 <code><var>field</var>[]</code> or
2049 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2050 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2051 <code>nicira-ext.h</code> for a complete list of NXM field names.
2055 When a flow must be evicted due to overflow, the flow to evict is
2056 chosen through an approximation of the following algorithm:
2061 Divide the flows in the table into groups based on the values of the
2062 specified fields or subfields, so that all of the flows in a given
2063 group have the same values for those fields. If a flow does not
2064 specify a given field, that field's value is treated as 0.
2068 Consider the flows in the largest group, that is, the group that
2069 contains the greatest number of flows. If two or more groups all
2070 have the same largest number of flows, consider the flows in all of
2075 Among the flows under consideration, choose the flow that expires
2076 soonest for eviction.
2081 The eviction process only considers flows that have an idle timeout or
2082 a hard timeout. That is, eviction never deletes permanent flows.
2083 (Permanent flows do count against <ref column="flow_limit"/>.
2087 Open vSwitch ignores any invalid or unknown field specifications.
2091 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2092 column has no effect.
2097 <table name="QoS" title="Quality of Service configuration">
2098 <p>Quality of Service (QoS) configuration for each Port that
2101 <column name="type">
2102 <p>The type of QoS to implement. The currently defined types are
2105 <dt><code>linux-htb</code></dt>
2107 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2108 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2109 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2110 for information on how this classifier works and how to configure it.
2114 <dt><code>linux-hfsc</code></dt>
2116 Linux "Hierarchical Fair Service Curve" classifier.
2117 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2118 information on how this classifier works.
2123 <column name="queues">
2124 <p>A map from queue numbers to <ref table="Queue"/> records. The
2125 supported range of queue numbers depend on <ref column="type"/>. The
2126 queue numbers are the same as the <code>queue_id</code> used in
2127 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2131 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2132 actions when no specific queue has been set. When no configuration for
2133 queue 0 is present, it is automatically configured as if a <ref
2134 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2135 and <ref table="Queue" column="other_config"/> columns had been
2137 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2138 this case. With some queuing disciplines, this dropped all packets
2139 destined for the default queue.)
2143 <group title="Configuration for linux-htb and linux-hfsc">
2145 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2146 the following key-value pair:
2149 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2150 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2151 specified, for physical interfaces, the default is the link rate. For
2152 other interfaces or if the link rate cannot be determined, the default
2153 is currently 100 Mbps.
2157 <group title="Common Columns">
2158 The overall purpose of these columns is described under <code>Common
2159 Columns</code> at the beginning of this document.
2161 <column name="other_config"/>
2162 <column name="external_ids"/>
2166 <table name="Queue" title="QoS output queue.">
2167 <p>A configuration for a port output queue, used in configuring Quality of
2168 Service (QoS) features. May be referenced by <ref column="queues"
2169 table="QoS"/> column in <ref table="QoS"/> table.</p>
2171 <column name="dscp">
2172 If set, Open vSwitch will mark all traffic egressing this
2173 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2174 default <ref table="Queue"/> is only marked if it was explicitly selected
2175 as the <ref table="Queue"/> at the time the packet was output. If unset,
2176 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2180 <group title="Configuration for linux-htb QoS">
2182 <ref table="QoS"/> <ref table="QoS" column="type"/>
2183 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2184 It has the following key-value pairs defined.
2187 <column name="other_config" key="min-rate"
2188 type='{"type": "integer", "minInteger": 1}'>
2189 Minimum guaranteed bandwidth, in bit/s.
2192 <column name="other_config" key="max-rate"
2193 type='{"type": "integer", "minInteger": 1}'>
2194 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2195 queue's rate will not be allowed to exceed the specified value, even
2196 if excess bandwidth is available. If unspecified, defaults to no
2200 <column name="other_config" key="burst"
2201 type='{"type": "integer", "minInteger": 1}'>
2202 Burst size, in bits. This is the maximum amount of ``credits'' that a
2203 queue can accumulate while it is idle. Optional. Details of the
2204 <code>linux-htb</code> implementation require a minimum burst size, so
2205 a too-small <code>burst</code> will be silently ignored.
2208 <column name="other_config" key="priority"
2209 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2210 A queue with a smaller <code>priority</code> will receive all the
2211 excess bandwidth that it can use before a queue with a larger value
2212 receives any. Specific priority values are unimportant; only relative
2213 ordering matters. Defaults to 0 if unspecified.
2217 <group title="Configuration for linux-hfsc QoS">
2219 <ref table="QoS"/> <ref table="QoS" column="type"/>
2220 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2221 It has the following key-value pairs defined.
2224 <column name="other_config" key="min-rate"
2225 type='{"type": "integer", "minInteger": 1}'>
2226 Minimum guaranteed bandwidth, in bit/s.
2229 <column name="other_config" key="max-rate"
2230 type='{"type": "integer", "minInteger": 1}'>
2231 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2232 queue's rate will not be allowed to exceed the specified value, even if
2233 excess bandwidth is available. If unspecified, defaults to no
2238 <group title="Common Columns">
2239 The overall purpose of these columns is described under <code>Common
2240 Columns</code> at the beginning of this document.
2242 <column name="other_config"/>
2243 <column name="external_ids"/>
2247 <table name="Mirror" title="Port mirroring.">
2248 <p>A port mirror within a <ref table="Bridge"/>.</p>
2249 <p>A port mirror configures a bridge to send selected frames to special
2250 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2251 traffic may also be referred to as SPAN or RSPAN, depending on how
2252 the mirrored traffic is sent.</p>
2254 <column name="name">
2255 Arbitrary identifier for the <ref table="Mirror"/>.
2258 <group title="Selecting Packets for Mirroring">
2260 To be selected for mirroring, a given packet must enter or leave the
2261 bridge through a selected port and it must also be in one of the
2265 <column name="select_all">
2266 If true, every packet arriving or departing on any port is
2267 selected for mirroring.
2270 <column name="select_dst_port">
2271 Ports on which departing packets are selected for mirroring.
2274 <column name="select_src_port">
2275 Ports on which arriving packets are selected for mirroring.
2278 <column name="select_vlan">
2279 VLANs on which packets are selected for mirroring. An empty set
2280 selects packets on all VLANs.
2284 <group title="Mirroring Destination Configuration">
2286 These columns are mutually exclusive. Exactly one of them must be
2290 <column name="output_port">
2291 <p>Output port for selected packets, if nonempty.</p>
2292 <p>Specifying a port for mirror output reserves that port exclusively
2293 for mirroring. No frames other than those selected for mirroring
2295 will be forwarded to the port, and any frames received on the port
2296 will be discarded.</p>
2298 The output port may be any kind of port supported by Open vSwitch.
2299 It may be, for example, a physical port (sometimes called SPAN) or a
2304 <column name="output_vlan">
2305 <p>Output VLAN for selected packets, if nonempty.</p>
2306 <p>The frames will be sent out all ports that trunk
2307 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2308 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2309 trunk port, the frame's VLAN tag will be set to
2310 <ref column="output_vlan"/>, replacing any existing tag; when it is
2311 sent out an implicit VLAN port, the frame will not be tagged. This
2312 type of mirroring is sometimes called RSPAN.</p>
2314 The following destination MAC addresses will not be mirrored to a
2315 VLAN to avoid confusing switches that interpret the protocols that
2319 <dt><code>01:80:c2:00:00:00</code></dt>
2320 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
2322 <dt><code>01:80:c2:00:00:01</code></dt>
2323 <dd>IEEE Pause frame.</dd>
2325 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
2326 <dd>Other reserved protocols.</dd>
2328 <dt><code>01:00:0c:cc:cc:cc</code></dt>
2330 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
2331 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
2335 <dt><code>01:00:0c:cc:cc:cd</code></dt>
2336 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
2338 <dt><code>01:00:0c:cd:cd:cd</code></dt>
2339 <dd>Cisco STP Uplink Fast.</dd>
2341 <dt><code>01:00:0c:00:00:00</code></dt>
2342 <dd>Cisco Inter Switch Link.</dd>
2344 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2345 contains unmanaged switches. Consider an unmanaged physical switch
2346 with two ports: port 1, connected to an end host, and port 2,
2347 connected to an Open vSwitch configured to mirror received packets
2348 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2349 port 1 that the physical switch forwards to port 2. The Open vSwitch
2350 forwards this packet to its destination and then reflects it back on
2351 port 2 in VLAN 123. This reflected packet causes the unmanaged
2352 physical switch to replace the MAC learning table entry, which
2353 correctly pointed to port 1, with one that incorrectly points to port
2354 2. Afterward, the physical switch will direct packets destined for
2355 the end host to the Open vSwitch on port 2, instead of to the end
2356 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2357 desired in this scenario, then the physical switch must be replaced
2358 by one that learns Ethernet addresses on a per-VLAN basis. In
2359 addition, learning should be disabled on the VLAN containing mirrored
2360 traffic. If this is not done then intermediate switches will learn
2361 the MAC address of each end host from the mirrored traffic. If
2362 packets being sent to that end host are also mirrored, then they will
2363 be dropped since the switch will attempt to send them out the input
2364 port. Disabling learning for the VLAN will cause the switch to
2365 correctly send the packet out all ports configured for that VLAN. If
2366 Open vSwitch is being used as an intermediate switch, learning can be
2367 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2368 in the appropriate <ref table="Bridge"/> table or tables.</p>
2370 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2371 VLAN and should generally be preferred.
2376 <group title="Statistics: Mirror counters">
2378 Key-value pairs that report mirror statistics.
2380 <column name="statistics" key="tx_packets">
2381 Number of packets transmitted through this mirror.
2383 <column name="statistics" key="tx_bytes">
2384 Number of bytes transmitted through this mirror.
2388 <group title="Common Columns">
2389 The overall purpose of these columns is described under <code>Common
2390 Columns</code> at the beginning of this document.
2392 <column name="external_ids"/>
2396 <table name="Controller" title="OpenFlow controller configuration.">
2397 <p>An OpenFlow controller.</p>
2400 Open vSwitch supports two kinds of OpenFlow controllers:
2404 <dt>Primary controllers</dt>
2407 This is the kind of controller envisioned by the OpenFlow 1.0
2408 specification. Usually, a primary controller implements a network
2409 policy by taking charge of the switch's flow table.
2413 Open vSwitch initiates and maintains persistent connections to
2414 primary controllers, retrying the connection each time it fails or
2415 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2416 <ref table="Bridge"/> table applies to primary controllers.
2420 Open vSwitch permits a bridge to have any number of primary
2421 controllers. When multiple controllers are configured, Open
2422 vSwitch connects to all of them simultaneously. Because
2423 OpenFlow 1.0 does not specify how multiple controllers
2424 coordinate in interacting with a single switch, more than
2425 one primary controller should be specified only if the
2426 controllers are themselves designed to coordinate with each
2427 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2428 vendor extension may be useful for this.)
2431 <dt>Service controllers</dt>
2434 These kinds of OpenFlow controller connections are intended for
2435 occasional support and maintenance use, e.g. with
2436 <code>ovs-ofctl</code>. Usually a service controller connects only
2437 briefly to inspect or modify some of a switch's state.
2441 Open vSwitch listens for incoming connections from service
2442 controllers. The service controllers initiate and, if necessary,
2443 maintain the connections from their end. The <ref table="Bridge"
2444 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2445 not apply to service controllers.
2449 Open vSwitch supports configuring any number of service controllers.
2455 The <ref column="target"/> determines the type of controller.
2458 <group title="Core Features">
2459 <column name="target">
2460 <p>Connection method for controller.</p>
2462 The following connection methods are currently supported for primary
2466 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2468 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2469 the given <var>ip</var>, which must be expressed as an IP address
2470 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2471 column in the <ref table="Open_vSwitch"/> table must point to a
2472 valid SSL configuration when this form is used.</p>
2473 <p>SSL support is an optional feature that is not always built as
2474 part of Open vSwitch.</p>
2476 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2477 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2478 the given <var>ip</var>, which must be expressed as an IP address
2479 (not a DNS name).</dd>
2482 The following connection methods are currently supported for service
2486 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2489 Listens for SSL connections on the specified TCP <var>port</var>
2490 (default: 6633). If <var>ip</var>, which must be expressed as an
2491 IP address (not a DNS name), is specified, then connections are
2492 restricted to the specified local IP address.
2495 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2496 table="Open_vSwitch"/> table must point to a valid SSL
2497 configuration when this form is used.
2499 <p>SSL support is an optional feature that is not always built as
2500 part of Open vSwitch.</p>
2502 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2504 Listens for connections on the specified TCP <var>port</var>
2505 (default: 6633). If <var>ip</var>, which must be expressed as an
2506 IP address (not a DNS name), is specified, then connections are
2507 restricted to the specified local IP address.
2510 <p>When multiple controllers are configured for a single bridge, the
2511 <ref column="target"/> values must be unique. Duplicate
2512 <ref column="target"/> values yield unspecified results.</p>
2515 <column name="connection_mode">
2516 <p>If it is specified, this setting must be one of the following
2517 strings that describes how Open vSwitch contacts this OpenFlow
2518 controller over the network:</p>
2521 <dt><code>in-band</code></dt>
2522 <dd>In this mode, this controller's OpenFlow traffic travels over the
2523 bridge associated with the controller. With this setting, Open
2524 vSwitch allows traffic to and from the controller regardless of the
2525 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2526 would never be able to connect to the controller, because it did
2527 not have a flow to enable it.) This is the most common connection
2528 mode because it is not necessary to maintain two independent
2530 <dt><code>out-of-band</code></dt>
2531 <dd>In this mode, OpenFlow traffic uses a control network separate
2532 from the bridge associated with this controller, that is, the
2533 bridge does not use any of its own network devices to communicate
2534 with the controller. The control network must be configured
2535 separately, before or after <code>ovs-vswitchd</code> is started.
2539 <p>If not specified, the default is implementation-specific.</p>
2543 <group title="Controller Failure Detection and Handling">
2544 <column name="max_backoff">
2545 Maximum number of milliseconds to wait between connection attempts.
2546 Default is implementation-specific.
2549 <column name="inactivity_probe">
2550 Maximum number of milliseconds of idle time on connection to
2551 controller before sending an inactivity probe message. If Open
2552 vSwitch does not communicate with the controller for the specified
2553 number of seconds, it will send a probe. If a response is not
2554 received for the same additional amount of time, Open vSwitch
2555 assumes the connection has been broken and attempts to reconnect.
2556 Default is implementation-specific. A value of 0 disables
2561 <group title="Asynchronous Message Configuration">
2563 OpenFlow switches send certain messages to controllers spontanenously,
2564 that is, not in response to any request from the controller. These
2565 messages are called ``asynchronous messages.'' These columns allow
2566 asynchronous messages to be limited or disabled to ensure the best use
2567 of network resources.
2570 <column name="enable_async_messages">
2571 The OpenFlow protocol enables asynchronous messages at time of
2572 connection establishment, which means that a controller can receive
2573 asynchronous messages, potentially many of them, even if it turns them
2574 off immediately after connecting. Set this column to
2575 <code>false</code> to change Open vSwitch behavior to disable, by
2576 default, all asynchronous messages. The controller can use the
2577 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2578 on any messages that it does want to receive, if any.
2581 <column name="controller_rate_limit">
2583 The maximum rate at which the switch will forward packets to the
2584 OpenFlow controller, in packets per second. This feature prevents a
2585 single bridge from overwhelming the controller. If not specified,
2586 the default is implementation-specific.
2590 In addition, when a high rate triggers rate-limiting, Open vSwitch
2591 queues controller packets for each port and transmits them to the
2592 controller at the configured rate. The <ref
2593 column="controller_burst_limit"/> value limits the number of queued
2594 packets. Ports on a bridge share the packet queue fairly.
2598 Open vSwitch maintains two such packet rate-limiters per bridge: one
2599 for packets sent up to the controller because they do not correspond
2600 to any flow, and the other for packets sent up to the controller by
2601 request through flow actions. When both rate-limiters are filled with
2602 packets, the actual rate that packets are sent to the controller is
2603 up to twice the specified rate.
2607 <column name="controller_burst_limit">
2608 In conjunction with <ref column="controller_rate_limit"/>,
2609 the maximum number of unused packet credits that the bridge will
2610 allow to accumulate, in packets. If not specified, the default
2611 is implementation-specific.
2615 <group title="Additional In-Band Configuration">
2616 <p>These values are considered only in in-band control mode (see
2617 <ref column="connection_mode"/>).</p>
2619 <p>When multiple controllers are configured on a single bridge, there
2620 should be only one set of unique values in these columns. If different
2621 values are set for these columns in different controllers, the effect
2624 <column name="local_ip">
2625 The IP address to configure on the local port,
2626 e.g. <code>192.168.0.123</code>. If this value is unset, then
2627 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2631 <column name="local_netmask">
2632 The IP netmask to configure on the local port,
2633 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2634 but this value is unset, then the default is chosen based on whether
2635 the IP address is class A, B, or C.
2638 <column name="local_gateway">
2639 The IP address of the gateway to configure on the local port, as a
2640 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2641 this network has no gateway.
2645 <group title="Controller Status">
2646 <column name="is_connected">
2647 <code>true</code> if currently connected to this controller,
2648 <code>false</code> otherwise.
2652 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2653 <p>The level of authority this controller has on the associated
2654 bridge. Possible values are:</p>
2656 <dt><code>other</code></dt>
2657 <dd>Allows the controller access to all OpenFlow features.</dd>
2658 <dt><code>master</code></dt>
2659 <dd>Equivalent to <code>other</code>, except that there may be at
2660 most one master controller at a time. When a controller configures
2661 itself as <code>master</code>, any existing master is demoted to
2662 the <code>slave</code>role.</dd>
2663 <dt><code>slave</code></dt>
2664 <dd>Allows the controller read-only access to OpenFlow features.
2665 Attempts to modify the flow table will be rejected with an
2666 error. Slave controllers do not receive OFPT_PACKET_IN or
2667 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2672 <column name="status" key="last_error">
2673 A human-readable description of the last error on the connection
2674 to the controller; i.e. <code>strerror(errno)</code>. This key
2675 will exist only if an error has occurred.
2678 <column name="status" key="state"
2679 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2681 The state of the connection to the controller:
2684 <dt><code>VOID</code></dt>
2685 <dd>Connection is disabled.</dd>
2687 <dt><code>BACKOFF</code></dt>
2688 <dd>Attempting to reconnect at an increasing period.</dd>
2690 <dt><code>CONNECTING</code></dt>
2691 <dd>Attempting to connect.</dd>
2693 <dt><code>ACTIVE</code></dt>
2694 <dd>Connected, remote host responsive.</dd>
2696 <dt><code>IDLE</code></dt>
2697 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2700 These values may change in the future. They are provided only for
2705 <column name="status" key="sec_since_connect"
2706 type='{"type": "integer", "minInteger": 0}'>
2707 The amount of time since this controller last successfully connected to
2708 the switch (in seconds). Value is empty if controller has never
2709 successfully connected.
2712 <column name="status" key="sec_since_disconnect"
2713 type='{"type": "integer", "minInteger": 1}'>
2714 The amount of time since this controller last disconnected from
2715 the switch (in seconds). Value is empty if controller has never
2720 <group title="Connection Parameters">
2722 Additional configuration for a connection between the controller
2723 and the Open vSwitch.
2726 <column name="other_config" key="dscp"
2727 type='{"type": "integer"}'>
2728 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2729 in the Type of Service (TOS) field in the IP header. DSCP provides a
2730 mechanism to classify the network traffic and provide Quality of
2731 Service (QoS) on IP networks.
2733 The DSCP value specified here is used when establishing the connection
2734 between the controller and the Open vSwitch. The connection must be
2735 reset for the new DSCP values to take effect. If no value is
2736 specified, a default value of 48 is chosen. Valid DSCP values must be
2737 in the range 0 to 63.
2742 <group title="Common Columns">
2743 The overall purpose of these columns is described under <code>Common
2744 Columns</code> at the beginning of this document.
2746 <column name="external_ids"/>
2747 <column name="other_config"/>
2751 <table name="Manager" title="OVSDB management connection.">
2753 Configuration for a database connection to an Open vSwitch database
2758 This table primarily configures the Open vSwitch database
2759 (<code>ovsdb-server</code>), not the Open vSwitch switch
2760 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2761 what connections should be treated as in-band.
2765 The Open vSwitch database server can initiate and maintain active
2766 connections to remote clients. It can also listen for database
2770 <group title="Core Features">
2771 <column name="target">
2772 <p>Connection method for managers.</p>
2774 The following connection methods are currently supported:
2777 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2780 The specified SSL <var>port</var> (default: 6632) on the host at
2781 the given <var>ip</var>, which must be expressed as an IP address
2782 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2783 column in the <ref table="Open_vSwitch"/> table must point to a
2784 valid SSL configuration when this form is used.
2787 SSL support is an optional feature that is not always built as
2788 part of Open vSwitch.
2792 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2794 The specified TCP <var>port</var> (default: 6632) on the host at
2795 the given <var>ip</var>, which must be expressed as an IP address
2798 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2801 Listens for SSL connections on the specified TCP <var>port</var>
2802 (default: 6632). If <var>ip</var>, which must be expressed as an
2803 IP address (not a DNS name), is specified, then connections are
2804 restricted to the specified local IP address.
2807 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2808 table="Open_vSwitch"/> table must point to a valid SSL
2809 configuration when this form is used.
2812 SSL support is an optional feature that is not always built as
2813 part of Open vSwitch.
2816 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2818 Listens for connections on the specified TCP <var>port</var>
2819 (default: 6632). If <var>ip</var>, which must be expressed as an
2820 IP address (not a DNS name), is specified, then connections are
2821 restricted to the specified local IP address.
2824 <p>When multiple managers are configured, the <ref column="target"/>
2825 values must be unique. Duplicate <ref column="target"/> values yield
2826 unspecified results.</p>
2829 <column name="connection_mode">
2831 If it is specified, this setting must be one of the following strings
2832 that describes how Open vSwitch contacts this OVSDB client over the
2837 <dt><code>in-band</code></dt>
2839 In this mode, this connection's traffic travels over a bridge
2840 managed by Open vSwitch. With this setting, Open vSwitch allows
2841 traffic to and from the client regardless of the contents of the
2842 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2843 to connect to the client, because it did not have a flow to enable
2844 it.) This is the most common connection mode because it is not
2845 necessary to maintain two independent networks.
2847 <dt><code>out-of-band</code></dt>
2849 In this mode, the client's traffic uses a control network separate
2850 from that managed by Open vSwitch, that is, Open vSwitch does not
2851 use any of its own network devices to communicate with the client.
2852 The control network must be configured separately, before or after
2853 <code>ovs-vswitchd</code> is started.
2858 If not specified, the default is implementation-specific.
2863 <group title="Client Failure Detection and Handling">
2864 <column name="max_backoff">
2865 Maximum number of milliseconds to wait between connection attempts.
2866 Default is implementation-specific.
2869 <column name="inactivity_probe">
2870 Maximum number of milliseconds of idle time on connection to the client
2871 before sending an inactivity probe message. If Open vSwitch does not
2872 communicate with the client for the specified number of seconds, it
2873 will send a probe. If a response is not received for the same
2874 additional amount of time, Open vSwitch assumes the connection has been
2875 broken and attempts to reconnect. Default is implementation-specific.
2876 A value of 0 disables inactivity probes.
2880 <group title="Status">
2881 <column name="is_connected">
2882 <code>true</code> if currently connected to this manager,
2883 <code>false</code> otherwise.
2886 <column name="status" key="last_error">
2887 A human-readable description of the last error on the connection
2888 to the manager; i.e. <code>strerror(errno)</code>. This key
2889 will exist only if an error has occurred.
2892 <column name="status" key="state"
2893 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2895 The state of the connection to the manager:
2898 <dt><code>VOID</code></dt>
2899 <dd>Connection is disabled.</dd>
2901 <dt><code>BACKOFF</code></dt>
2902 <dd>Attempting to reconnect at an increasing period.</dd>
2904 <dt><code>CONNECTING</code></dt>
2905 <dd>Attempting to connect.</dd>
2907 <dt><code>ACTIVE</code></dt>
2908 <dd>Connected, remote host responsive.</dd>
2910 <dt><code>IDLE</code></dt>
2911 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2914 These values may change in the future. They are provided only for
2919 <column name="status" key="sec_since_connect"
2920 type='{"type": "integer", "minInteger": 0}'>
2921 The amount of time since this manager last successfully connected
2922 to the database (in seconds). Value is empty if manager has never
2923 successfully connected.
2926 <column name="status" key="sec_since_disconnect"
2927 type='{"type": "integer", "minInteger": 0}'>
2928 The amount of time since this manager last disconnected from the
2929 database (in seconds). Value is empty if manager has never
2933 <column name="status" key="locks_held">
2934 Space-separated list of the names of OVSDB locks that the connection
2935 holds. Omitted if the connection does not hold any locks.
2938 <column name="status" key="locks_waiting">
2939 Space-separated list of the names of OVSDB locks that the connection is
2940 currently waiting to acquire. Omitted if the connection is not waiting
2944 <column name="status" key="locks_lost">
2945 Space-separated list of the names of OVSDB locks that the connection
2946 has had stolen by another OVSDB client. Omitted if no locks have been
2947 stolen from this connection.
2950 <column name="status" key="n_connections"
2951 type='{"type": "integer", "minInteger": 2}'>
2953 When <ref column="target"/> specifies a connection method that
2954 listens for inbound connections (e.g. <code>ptcp:</code> or
2955 <code>pssl:</code>) and more than one connection is actually active,
2956 the value is the number of active connections. Otherwise, this
2957 key-value pair is omitted.
2960 When multiple connections are active, status columns and key-value
2961 pairs (other than this one) report the status of one arbitrarily
2967 <group title="Connection Parameters">
2969 Additional configuration for a connection between the manager
2970 and the Open vSwitch Database.
2973 <column name="other_config" key="dscp"
2974 type='{"type": "integer"}'>
2975 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2976 in the Type of Service (TOS) field in the IP header. DSCP provides a
2977 mechanism to classify the network traffic and provide Quality of
2978 Service (QoS) on IP networks.
2980 The DSCP value specified here is used when establishing the connection
2981 between the manager and the Open vSwitch. The connection must be
2982 reset for the new DSCP values to take effect. If no value is
2983 specified, a default value of 48 is chosen. Valid DSCP values must be
2984 in the range 0 to 63.
2988 <group title="Common Columns">
2989 The overall purpose of these columns is described under <code>Common
2990 Columns</code> at the beginning of this document.
2992 <column name="external_ids"/>
2993 <column name="other_config"/>
2997 <table name="NetFlow">
2998 A NetFlow target. NetFlow is a protocol that exports a number of
2999 details about terminating IP flows, such as the principals involved
3002 <column name="targets">
3003 NetFlow targets in the form
3004 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3005 must be specified numerically, not as a DNS name.
3008 <column name="engine_id">
3009 Engine ID to use in NetFlow messages. Defaults to datapath index
3013 <column name="engine_type">
3014 Engine type to use in NetFlow messages. Defaults to datapath
3015 index if not specified.
3018 <column name="active_timeout">
3019 The interval at which NetFlow records are sent for flows that are
3020 still active, in seconds. A value of <code>0</code> requests the
3021 default timeout (currently 600 seconds); a value of <code>-1</code>
3022 disables active timeouts.
3025 <column name="add_id_to_interface">
3026 <p>If this column's value is <code>false</code>, the ingress and egress
3027 interface fields of NetFlow flow records are derived from OpenFlow port
3028 numbers. When it is <code>true</code>, the 7 most significant bits of
3029 these fields will be replaced by the least significant 7 bits of the
3030 engine id. This is useful because many NetFlow collectors do not
3031 expect multiple switches to be sending messages from the same host, so
3032 they do not store the engine information which could be used to
3033 disambiguate the traffic.</p>
3034 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3037 <group title="Common Columns">
3038 The overall purpose of these columns is described under <code>Common
3039 Columns</code> at the beginning of this document.
3041 <column name="external_ids"/>
3046 SSL configuration for an Open_vSwitch.
3048 <column name="private_key">
3049 Name of a PEM file containing the private key used as the switch's
3050 identity for SSL connections to the controller.
3053 <column name="certificate">
3054 Name of a PEM file containing a certificate, signed by the
3055 certificate authority (CA) used by the controller and manager,
3056 that certifies the switch's private key, identifying a trustworthy
3060 <column name="ca_cert">
3061 Name of a PEM file containing the CA certificate used to verify
3062 that the switch is connected to a trustworthy controller.
3065 <column name="bootstrap_ca_cert">
3066 If set to <code>true</code>, then Open vSwitch will attempt to
3067 obtain the CA certificate from the controller on its first SSL
3068 connection and save it to the named PEM file. If it is successful,
3069 it will immediately drop the connection and reconnect, and from then
3070 on all SSL connections must be authenticated by a certificate signed
3071 by the CA certificate thus obtained. <em>This option exposes the
3072 SSL connection to a man-in-the-middle attack obtaining the initial
3073 CA certificate.</em> It may still be useful for bootstrapping.
3076 <group title="Common Columns">
3077 The overall purpose of these columns is described under <code>Common
3078 Columns</code> at the beginning of this document.
3080 <column name="external_ids"/>
3084 <table name="sFlow">
3085 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3088 <column name="agent">
3089 Name of the network device whose IP address should be reported as the
3090 ``agent address'' to collectors. If not specified, the agent device is
3091 figured from the first target address and the routing table. If the
3092 routing table does not contain a route to the target, the IP address
3093 defaults to the <ref table="Controller" column="local_ip"/> in the
3094 collector's <ref table="Controller"/>. If an agent IP address cannot be
3095 determined any of these ways, sFlow is disabled.
3098 <column name="header">
3099 Number of bytes of a sampled packet to send to the collector.
3100 If not specified, the default is 128 bytes.
3103 <column name="polling">
3104 Polling rate in seconds to send port statistics to the collector.
3105 If not specified, defaults to 30 seconds.
3108 <column name="sampling">
3109 Rate at which packets should be sampled and sent to the collector.
3110 If not specified, defaults to 400, which means one out of 400
3111 packets, on average, will be sent to the collector.
3114 <column name="targets">
3115 sFlow targets in the form
3116 <code><var>ip</var>:<var>port</var></code>.
3119 <group title="Common Columns">
3120 The overall purpose of these columns is described under <code>Common
3121 Columns</code> at the beginning of this document.
3123 <column name="external_ids"/>