utilities/ovs-vsctl.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .de ST
   8 .  PP
   9 .  RS -0.15in
  10 .  I "\\$1"
  11 .  RE
  12 ..
  13 .TH ovs\-vsctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
  14 .\" This program's name:
  15 .ds PN ovs\-vsctl
  16 .
  17 .SH NAME
  18 ovs\-vsctl \- utility for querying and configuring \fBovs\-vswitchd\fR
  19 .
  20 .SH SYNOPSIS
  21 \fBovs\-vsctl\fR [\fIoptions\fR] \fB\-\-\fR [\fIoptions\fR] \fIcommand
  22 \fR[\fIargs\fR] [\fB\-\-\fR [\fIoptions\fR] \fIcommand \fR[\fIargs\fR]]...
  23 .
  24 .SH DESCRIPTION
  25 The \fBovs\-vsctl\fR program configures \fBovs\-vswitchd\fR(8) by
  26 providing a high\-level interface to its configuration database.
  27 See \fBovs\-vswitchd.conf.db\fR(5) for comprehensive documentation of
  28 the database schema.
  29 .PP
  30 \fBovs\-vsctl\fR connects to an \fBovsdb\-server\fR process that
  31 maintains an Open vSwitch configuration database.  Using this
  32 connection, it queries and possibly applies changes to the database,
  33 depending on the supplied commands.  Then, if it applied any changes,
  34 by default it waits until \fBovs\-vswitchd\fR has finished
  35 reconfiguring itself before it exits.  (If you use \fBovs\-vsctl\fR
  36 when \fBovs\-vswitchd\fR is not running, use \fB\-\-no\-wait\fR.)
  37 .PP
  38 \fBovs\-vsctl\fR can perform any number of commands in a single run,
  39 implemented as a single atomic transaction against the database.
  40 .PP
  41 The \fBovs\-vsctl\fR command line begins with global options (see
  42 \fBOPTIONS\fR below for details).  The global options are followed by
  43 one or more commands.  Each command should begin with \fB\-\-\fR by
  44 itself as a command-line argument, to separate it from the following
  45 commands.  (The \fB\-\-\fR before the first command is optional.)  The
  46 command
  47 itself starts with command-specific options, if any, followed by the
  48 command name and any arguments.  See \fBEXAMPLES\fR below for syntax
  49 examples.
  50 .
  51 .SS "Linux VLAN Bridging Compatibility"
  52 The \fBovs\-vsctl\fR program supports the model of a bridge
  53 implemented by Open vSwitch, in which a single bridge supports ports
  54 on multiple VLANs.  In this model, each port on a bridge is either a
  55 trunk port that potentially passes packets tagged with 802.1Q headers
  56 that designate VLANs or it is assigned a single implicit VLAN that is
  57 never tagged with an 802.1Q header.
  58 .PP
  59 For compatibility with software designed for the Linux bridge,
  60 \fBovs\-vsctl\fR also supports a model in which traffic associated
  61 with a given 802.1Q VLAN is segregated into a separate bridge.  A
  62 special form of the \fBadd\-br\fR command (see below) creates a ``fake
  63 bridge'' within an Open vSwitch bridge to simulate this behavior.
  64 When such a ``fake bridge'' is active, \fBovs\-vsctl\fR will treat it
  65 much like a bridge separate from its ``parent bridge,'' but the actual
  66 implementation in Open vSwitch uses only a single bridge, with ports on
  67 the fake bridge assigned the implicit VLAN of the fake bridge of which
  68 they are members.  (A fake bridge for VLAN 0 receives packets that
  69 have no 802.1Q tag or a tag with VLAN 0.)
  70 .
  71 .SH OPTIONS
  72 .
  73 The following options affect the behavior \fBovs\-vsctl\fR as a whole.
  74 Some individual commands also accept their own options, which are
  75 given just before the command name.  If the first command on the
  76 command line has options, then those options must be separated from
  77 the global options by \fB\-\-\fR.
  78 .
  79 .IP "\fB\-\-db=\fIserver\fR"
  80 Sets \fIserver\fR as the database server that \fBovs\-vsctl\fR
  81 contacts to query or modify configuration.  The default is
  82 \fBunix:@RUNDIR@/db.sock\fR.  \fIserver\fR must take one of the
  83 following forms:
  84 .RS
  85 .so ovsdb/remote-active.man
  86 .so ovsdb/remote-passive.man
  87 .RE
  88 .
  89 .IP "\fB\-\-no\-wait\fR"
  90 Prevents \fBovs\-vsctl\fR from waiting for \fBovs\-vswitchd\fR to
  91 reconfigure itself according to the the modified database.  This
  92 option should be used if \fBovs\-vswitchd\fR is not running;
  93 otherwise, \fBovs\-vsctl\fR will not exit until \fBovs\-vswitchd\fR
  94 starts.
  95 .IP
  96 This option has no effect if the commands specified do not change the
  97 database.
  98 .
  99 .IP "\fB\-\-no\-syslog\fR"
 100 By default, \fBovs\-vsctl\fR logs its arguments and the details of any
 101 changes that it makes to the system log.  This option disables this
 102 logging.
 103 .IP
 104 This option is equivalent to \fB\-\-verbose=vsctl:syslog:warn\fR.
 105 .
 106 .IP "\fB\-\-oneline\fR"
 107 Modifies the output format so that the output for each command is printed
 108 on a single line.  New-line characters that would otherwise separate
 109 lines are printed as \fB\\n\fR, and any instances of \fB\\\fR that
 110 would otherwise appear in the output are doubled.
 111 Prints a blank line for each command that has no output.
 112 This option does not affect the formatting of output from the
 113 \fBlist\fR or \fBfind\fR commands; see \fBTable Formatting Options\fR
 114 below.
 115 .
 116 .IP "\fB\-\-dry\-run\fR"
 117 Prevents \fBovs\-vsctl\fR from actually modifying the database.
 118 .
 119 .IP "\fB\-t \fIsecs\fR"
 120 .IQ "\fB\-\-timeout=\fIsecs\fR"
 121 By default, or with a \fIsecs\fR of \fB0\fR, \fBovs\-vsctl\fR waits
 122 forever for a response from the database.  This option limits runtime
 123 to approximately \fIsecs\fR seconds.  If the timeout expires,
 124 \fBovs\-vsctl\fR will exit with a \fBSIGALRM\fR signal.  (A timeout
 125 would normally happen only if the database cannot be contacted, or if
 126 the system is overloaded.)
 127 .
 128 .IP "\fB\-\-retry\fR"
 129 Without this option, if \fBovs\-vsctl\fR connects outward to the
 130 database server (the default) then \fBovs\-vsctl\fR will try to
 131 connect once and exit with an error if the connection fails (which
 132 usually means that \fBovsdb\-server\fR is not running).
 133 .IP
 134 With this option, or if \fB\-\-db\fR specifies that \fBovs\-vsctl\fR
 135 should listen for an incoming connection from the database server,
 136 then \fBovs\-vsctl\fR will wait for a connection to the database
 137 forever.
 138 .IP
 139 Regardless of this setting, \fB\-\-timeout\fR always limits how long
 140 \fBovs\-vsctl\fR will wait.
 141 .
 142 .SS "Table Formatting Options"
 143 These options control the format of output from the \fBlist\fR and
 144 \fBfind\fR commands.
 145 .so lib/table.man
 146 .
 147 .SS "Public Key Infrastructure Options"
 148 .so lib/ssl.man
 149 .so lib/ssl-bootstrap.man
 150 .so lib/ssl-peer-ca-cert.man
 151 .so lib/vlog.man
 152 .so lib/common.man
 153 .
 154 .SH COMMANDS
 155 The commands implemented by \fBovs\-vsctl\fR are described in the
 156 sections below.
 157 .SS "Open vSwitch Commands"
 158 These commands work with an Open vSwitch as a whole.
 159 .
 160 .IP "\fBinit\fR"
 161 Initializes the Open vSwitch database, if it is empty.  If the
 162 database has already been initialized, this command has no effect.
 163 .IP
 164 Any successful \fBovs\-vsctl\fR command automatically initializes the
 165 Open vSwitch database if it is empty.  This command is provided to
 166 initialize the database without executing any other command.
 167 .
 168 .IP "\fBshow\fR"
 169 Prints a brief overview of the database contents.
 170 .
 171 .IP "\fBemer\-reset\fR"
 172 Reset the configuration into a clean state.  It deconfigures OpenFlow
 173 controllers, OVSDB servers, and SSL, and deletes port mirroring,
 174 \fBfail_mode\fR, NetFlow, sFlow, and IPFIX configuration.  This
 175 command also removes all \fBother\-config\fR keys from all database
 176 records, except that \fBother\-config:hwaddr\fR is preserved if it is
 177 present in a Bridge record.  Other networking configuration is left
 178 as-is.
 179 .
 180 .SS "Bridge Commands"
 181 These commands examine and manipulate Open vSwitch bridges.
 182 .
 183 .IP "[\fB\-\-may\-exist\fR] \fBadd\-br \fIbridge\fR"
 184 Creates a new bridge named \fIbridge\fR.  Initially the bridge will
 185 have no ports (other than \fIbridge\fR itself).
 186 .IP
 187 Without \fB\-\-may\-exist\fR, attempting to create a bridge that
 188 exists is an error.  With \fB\-\-may\-exist\fR, this command does
 189 nothing if \fIbridge\fR already exists as a real bridge.
 190 .
 191 .IP "[\fB\-\-may\-exist\fR] \fBadd\-br \fIbridge parent vlan\fR"
 192 Creates a ``fake bridge'' named \fIbridge\fR within the existing Open
 193 vSwitch bridge \fIparent\fR, which must already exist and must not
 194 itself be a fake bridge.  The new fake bridge will be on 802.1Q VLAN
 195 \fIvlan\fR, which must be an integer between 0 and 4095.  Initially
 196 \fIbridge\fR will have no ports (other than \fIbridge\fR itself).
 197 .IP
 198 Without \fB\-\-may\-exist\fR, attempting to create a bridge that
 199 exists is an error.  With \fB\-\-may\-exist\fR, this command does
 200 nothing if \fIbridge\fR already exists as a VLAN bridge under
 201 \fIparent\fR for \fIvlan\fR.
 202 .
 203 .IP "[\fB\-\-if\-exists\fR] \fBdel\-br \fIbridge\fR"
 204 Deletes \fIbridge\fR and all of its ports.  If \fIbridge\fR is a real
 205 bridge, this command also deletes any fake bridges that were created
 206 with \fIbridge\fR as parent, including all of their ports.
 207 .IP
 208 Without \fB\-\-if\-exists\fR, attempting to delete a bridge that does
 209 not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
 210 delete a bridge that does not exist has no effect.
 211 .
 212 .IP "[\fB\-\-real\fR|\fB\-\-fake\fR] \fBlist\-br\fR"
 213 Lists all existing real and fake bridges on standard output, one per
 214 line.  With \fB\-\-real\fR or \fB\-\-fake\fR, only bridges of that type
 215 are returned.
 216 .
 217 .IP "\fBbr\-exists \fIbridge\fR"
 218 Tests whether \fIbridge\fR exists as a real or fake bridge.  If so,
 219 \fBovs\-vsctl\fR exits successfully with exit code 0.  If not,
 220 \fBovs\-vsctl\fR exits unsuccessfully with exit code 2.
 221 .
 222 .IP "\fBbr\-to\-vlan \fIbridge\fR"
 223 If \fIbridge\fR is a fake bridge, prints the bridge's 802.1Q VLAN as a
 224 decimal integer.  If \fIbridge\fR is a real bridge, prints 0.
 225 .
 226 .IP "\fBbr\-to\-parent \fIbridge\fR"
 227 If \fIbridge\fR is a fake bridge, prints the name of its parent
 228 bridge.  If \fIbridge\fR is a real bridge, print \fIbridge\fR.
 229 .
 230 .IP "\fBbr\-set\-external\-id \fIbridge key\fR [\fIvalue\fR]"
 231 Sets or clears an ``external ID'' value on \fIbridge\fR.  These values
 232 are intended to identify entities external to Open vSwitch with which
 233 \fIbridge\fR is associated, e.g. the bridge's identifier in a
 234 virtualization management platform.  The Open vSwitch database schema
 235 specifies well-known \fIkey\fR values, but \fIkey\fR and \fIvalue\fR
 236 are otherwise arbitrary strings.
 237 .IP
 238 If \fIvalue\fR is specified, then \fIkey\fR is set to \fIvalue\fR for
 239 \fIbridge\fR, overwriting any previous value.  If \fIvalue\fR is
 240 omitted, then \fIkey\fR is removed from \fIbridge\fR's set of external
 241 IDs (if it was present).
 242 .IP
 243 For real bridges, the effect of this command is similar to that of a
 244 \fBset\fR or \fBremove\fR command in the \fBexternal\-ids\fR column of
 245 the \fBBridge\fR table.  For fake bridges, it actually modifies keys
 246 with names prefixed by \fBfake\-bridge\-\fR in the \fBPort\fR table.
 247 .
 248 .IP "\fBbr\-get\-external\-id \fIbridge\fR [\fIkey\fR]"
 249 Queries the external IDs on \fIbridge\fR.  If \fIkey\fR is specified,
 250 the output is the value for that \fIkey\fR or the empty string if
 251 \fIkey\fR is unset.  If \fIkey\fR is omitted, the output is
 252 \fIkey\fB=\fIvalue\fR, one per line, for each key-value pair.
 253 .IP
 254 For real bridges, the effect of this command is similar to that of a
 255 \fBget\fR command in the \fBexternal\-ids\fR column of the
 256 \fBBridge\fR table.  For fake bridges, it queries keys with names
 257 prefixed by \fBfake\-bridge\-\fR in the \fBPort\fR table.
 258 .
 259 .SS "Port Commands"
 260 .
 261 These commands examine and manipulate Open vSwitch ports.  These
 262 commands treat a bonded port as a single entity.
 263 .
 264 .IP "\fBlist\-ports \fIbridge\fR"
 265 Lists all of the ports within \fIbridge\fR on standard output, one per
 266 line.  The local port \fIbridge\fR is not included in the list.
 267 .
 268 .IP "[\fB\-\-may\-exist\fR] \fBadd\-port \fIbridge port \fR[\fIcolumn\fR[\fB:\fIkey\fR]\fR=\fIvalue\fR]\&...\fR"
 269 Creates on \fIbridge\fR a new port named \fIport\fR from the network
 270 device of the same name.
 271 .IP
 272 Optional arguments set values of column in the Port record created by
 273 the command.  For example, \fBtag=9\fR would make the port an access
 274 port for VLAN 9.  The syntax is the same as that for the \fBset\fR
 275 command (see \fBDatabase Commands\fR below).
 276 .IP
 277 Without \fB\-\-may\-exist\fR, attempting to create a port that exists
 278 is an error.  With \fB\-\-may\-exist\fR, this command does nothing if
 279 \fIport\fR already exists on \fIbridge\fR and is not a bonded port.
 280 .
 281 .IP "[\fB\-\-fake\-iface\fR] \fBadd\-bond \fIbridge port iface\fR\&... [\fIcolumn\fR[\fB:\fIkey\fR]\fR=\fIvalue\fR]\&...\fR"
 282 Creates on \fIbridge\fR a new port named \fIport\fR that bonds
 283 together the network devices given as each \fIiface\fR.  At least two
 284 interfaces must be named.
 285 .IP
 286 Optional arguments set values of column in the Port record created by
 287 the command.  The syntax is the same as that for the \fBset\fR command
 288 (see \fBDatabase Commands\fR below).
 289 .IP
 290 With \fB\-\-fake\-iface\fR, a fake interface with the name \fIport\fR is
 291 created.  This should only be used for compatibility with legacy
 292 software that requires it.
 293 .IP
 294 Without \fB\-\-may\-exist\fR, attempting to create a port that exists
 295 is an error.  With \fB\-\-may\-exist\fR, this command does nothing if
 296 \fIport\fR already exists on \fIbridge\fR and bonds together exactly
 297 the specified interfaces.
 298 .
 299 .IP "[\fB\-\-if\-exists\fR] \fBdel\-port \fR[\fIbridge\fR] \fIport\fR"
 300 Deletes \fIport\fR.  If \fIbridge\fR is omitted, \fIport\fR is removed
 301 from whatever bridge contains it; if \fIbridge\fR is specified, it
 302 must be the real or fake bridge that contains \fIport\fR.
 303 .IP
 304 Without \fB\-\-if\-exists\fR, attempting to delete a port that does
 305 not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
 306 delete a port that does not exist has no effect.
 307 .
 308 .IP "[\fB\-\-if\-exists\fR] \fB\-\-with\-iface del\-port \fR[\fIbridge\fR] \fIiface\fR"
 309 Deletes the port named \fIiface\fR or that has an interface named
 310 \fIiface\fR.  If \fIbridge\fR is omitted, the port is removed from
 311 whatever bridge contains it; if \fIbridge\fR is specified, it must be
 312 the real or fake bridge that contains the port.
 313 .IP
 314 Without \fB\-\-if\-exists\fR, attempting to delete the port for an
 315 interface that does not exist is an error.  With \fB\-\-if\-exists\fR,
 316 attempting to delete the port for an interface that does not exist has
 317 no effect.
 318 .
 319 .IP "\fBport\-to\-br \fIport\fR"
 320 Prints the name of the bridge that contains \fIport\fR on standard
 321 output.
 322 .
 323 .SS "Interface Commands"
 324 .
 325 These commands examine the interfaces attached to an Open vSwitch
 326 bridge.  These commands treat a bonded port as a collection of two or
 327 more interfaces, rather than as a single port.
 328 .
 329 .IP "\fBlist\-ifaces \fIbridge\fR"
 330 Lists all of the interfaces within \fIbridge\fR on standard output,
 331 one per line.  The local port \fIbridge\fR is not included in the
 332 list.
 333 .
 334 .IP "\fBiface\-to\-br \fIiface\fR"
 335 Prints the name of the bridge that contains \fIiface\fR on standard
 336 output.
 337 .
 338 .SS "OpenFlow Controller Connectivity"
 339 .
 340 \fBovs\-vswitchd\fR can perform all configured bridging and switching
 341 locally, or it can be configured to communicate with one or more
 342 external OpenFlow controllers.  The switch is typically configured to
 343 connect to a primary controller that takes charge of the bridge's flow
 344 table to implement a network policy.  In addition, the switch can be
 345 configured to listen to connections from service controllers.  Service
 346 controllers are typically used for occasional support and maintenance,
 347 e.g. with \fBovs\-ofctl\fR.
 348 .
 349 .IP "\fBget\-controller\fR \fIbridge\fR"
 350 Prints the configured controller target.
 351 .
 352 .IP "\fBdel\-controller\fR \fIbridge\fR"
 353 Deletes the configured controller target.
 354 .
 355 .IP "\fBset\-controller\fR \fIbridge\fR \fItarget\fR\&..."
 356 Sets the configured controller target or targets.  Each \fItarget\fR may
 357 use any of the following forms:
 358 .
 359 .RS
 360 .so lib/vconn-active.man
 361 .so lib/vconn-passive.man
 362 .RE
 363 .
 364 .ST "Controller Failure Settings"
 365 .PP
 366 When a controller is configured, it is, ordinarily, responsible for
 367 setting up all flows on the switch.  Thus, if the connection to
 368 the controller fails, no new network connections can be set up.  If
 369 the connection to the controller stays down long enough, no packets
 370 can pass through the switch at all.
 371 .PP
 372 If the value is \fBstandalone\fR, or if neither of these settings
 373 is set, \fBovs\-vswitchd\fR will take over
 374 responsibility for setting up
 375 flows when no message has been received from the controller for three
 376 times the inactivity probe interval.  In this mode,
 377 \fBovs\-vswitchd\fR causes the datapath to act like an ordinary
 378 MAC-learning switch.  \fBovs\-vswitchd\fR will continue to retry connecting
 379 to the controller in the background and, when the connection succeeds,
 380 it discontinues its standalone behavior.
 381 .PP
 382 If this option is set to \fBsecure\fR, \fBovs\-vswitchd\fR will not
 383 set up flows on its own when the controller connection fails.
 384 .
 385 .IP "\fBget\-fail\-mode\fR \fIbridge\fR"
 386 Prints the configured failure mode.
 387 .
 388 .IP "\fBdel\-fail\-mode\fR \fIbridge\fR"
 389 Deletes the configured failure mode.
 390 .
 391 .IP "\fBset\-fail\-mode\fR \fIbridge\fR \fBstandalone\fR|\fBsecure\fR"
 392 Sets the configured failure mode.
 393 .
 394 .SS "Manager Connectivity"
 395 .
 396 These commands manipulate the \fBmanager_options\fR column in the
 397 \fBOpen_vSwitch\fR table and rows in the \fBManagers\fR table.  When
 398 \fBovsdb\-server\fR is configured to use the \fBmanager_options\fR column for
 399 OVSDB connections (as described in \fBINSTALL.Linux\fR and in the startup
 400 scripts provided with Open vSwitch), this allows the administrator to use
 401 \fBovs\-vsctl\fR to configure database connections.
 402 .
 403 .IP "\fBget\-manager\fR"
 404 Prints the configured manager(s).
 405 .
 406 .IP "\fBdel\-manager\fR"
 407 Deletes the configured manager(s).
 408 .
 409 .IP "\fBset\-manager\fR \fItarget\fR\&..."
 410 Sets the configured manager target or targets.  Each \fItarget\fR may
 411 use any of the following forms:
 412 .
 413 .RS
 414 .so ovsdb/remote-active.man
 415 .so ovsdb/remote-passive.man
 416 .RE
 417 .
 418 .SS "SSL Configuration"
 419 When \fBovs\-vswitchd\fR is configured to connect over SSL for management or
 420 controller connectivity, the following parameters are required:
 421 .TP
 422 \fIprivate-key\fR
 423 Specifies a PEM file containing the private key used as the virtual
 424 switch's identity for SSL connections to the controller.
 425 .TP
 426 \fIcertificate\fR
 427 Specifies a PEM file containing a certificate, signed by the
 428 certificate authority (CA) used by the controller and manager, that
 429 certifies the virtual switch's private key, identifying a trustworthy
 430 switch.
 431 .TP
 432 \fIca-cert\fR
 433 Specifies a PEM file containing the CA certificate used to verify that
 434 the virtual switch is connected to a trustworthy controller.
 435 .PP
 436 These files are read only once, at \fBovs\-vswitchd\fR startup time.  If
 437 their contents change, \fBovs\-vswitchd\fR must be killed and restarted.
 438 .PP
 439 These SSL settings apply to all SSL connections made by the virtual
 440 switch.
 441 .
 442 .IP "\fBget\-ssl\fR"
 443 Prints the SSL configuration.
 444 .
 445 .IP "\fBdel\-ssl\fR"
 446 Deletes the current SSL configuration.
 447 .
 448 .IP "[\fB\-\-bootstrap\fR] \fBset\-ssl\fR \fIprivate-key\fR \fIcertificate\fR \fIca-cert\fR"
 449 Sets the SSL configuration.  The \fB\-\-bootstrap\fR option is described
 450 below.
 451 .
 452 .ST "CA Certificate Bootstrap"
 453 .PP
 454 Ordinarily, all of the files named in the SSL configuration must exist
 455 when \fBovs\-vswitchd\fR starts.  However, if the \fIca-cert\fR file
 456 does not exist and the \fB\-\-bootstrap\fR
 457 option is given, then \fBovs\-vswitchd\fR will attempt to obtain the
 458 CA certificate from the controller on its first SSL connection and
 459 save it to the named PEM file.  If it is successful, it will
 460 immediately drop the connection and reconnect, and from then on all
 461 SSL connections must be authenticated by a certificate signed by the
 462 CA certificate thus obtained.
 463 .PP
 464 \fBThis option exposes the SSL connection to a man-in-the-middle
 465 attack obtaining the initial CA certificate\fR, but it may be useful
 466 for bootstrapping.
 467 .PP
 468 This option is only useful if the controller sends its CA certificate
 469 as part of the SSL certificate chain.  The SSL protocol does not
 470 require the controller to send the CA certificate.
 471 .
 472 .SS "Database Commands"
 473 .
 474 These commands query and modify the contents of \fBovsdb\fR tables.
 475 They are a slight abstraction of the \fBovsdb\fR interface and as such
 476 they operate at a lower level than other \fBovs\-vsctl\fR commands.
 477 .PP
 478 .ST "Identifying Tables, Records, and Columns"
 479 .PP
 480 Each of these commands has a \fItable\fR parameter to identify a table
 481 within the database.  Many of them also take a \fIrecord\fR parameter
 482 that identifies a particular record within a table.  The \fIrecord\fR
 483 parameter may be the UUID for a record, and many tables offer
 484 additional ways to identify records.  Some commands also take
 485 \fIcolumn\fR parameters that identify a particular field within the
 486 records in a table.
 487 .PP
 488 The following tables are currently defined:
 489 .IP "\fBOpen_vSwitch\fR"
 490 Global configuration for an \fBovs\-vswitchd\fR.  This table contains
 491 exactly one record, identified by specifying \fB.\fR as the record
 492 name.
 493 .IP "\fBBridge\fR"
 494 Configuration for a bridge within an Open vSwitch.  Records may be
 495 identified by bridge name.
 496 .IP "\fBPort\fR"
 497 A bridge port.  Records may be identified by port name.
 498 .IP "\fBInterface\fR"
 499 A network device attached to a port.  Records may be identified by
 500 name.
 501 .IP "\fBFlow_Table\fR"
 502 Configuration for a particular OpenFlow flow table.  Records may be
 503 identified by name.
 504 .IP "\fBQoS\fR"
 505 Quality-of-service configuration for a \fBPort\fR.  Records may be
 506 identified by port name.
 507 .IP "\fBQueue\fR"
 508 Configuration for one queue within a \fBQoS\fR configuration.  Records
 509 may only be identified by UUID.
 510 .IP "\fBMirror\fR"
 511 A port mirroring configuration attached to a bridge.  Records may be
 512 identified by mirror name.
 513 .IP "\fBController\fR"
 514 Configuration for an OpenFlow controller.  A controller attached to a
 515 particular bridge may be identified by the bridge's name.
 516 .IP "\fBManager\fR"
 517 Configuration for an OVSDB connection.  Records may be identified
 518 by target (e.g. \fBtcp:1.2.3.4\fR).
 519 .IP "\fBNetFlow\fR"
 520 A NetFlow configuration attached to a bridge.  Records may be
 521 identified by bridge name.
 522 .IP "\fBSSL\fR"
 523 The global SSL configuration for \fBovs\-vswitchd\fR.  The record
 524 attached to the \fBOpen_vSwitch\fR table may be identified by
 525 specifying \fB.\fR as the record name.
 526 .IP "\fBsFlow\fR"
 527 An sFlow exporter configuration attached to a bridge.  Records may be
 528 identified by bridge name.
 529 .IP "\fBIPFIX\fR"
 530 An IPFIX exporter configuration attached to a bridge.  Records may be
 531 identified by bridge name.
 532 .IP "\fBFlow_Sample_Collector_Set\fR"
 533 An IPFIX exporter configuration attached to a bridge for sampling
 534 packets on a per-flow basis using OpenFlow \fBsample\fR actions.
 535 .PP
 536 Record names must be specified in full and with correct
 537 capitalization.  Names of tables and columns are not case-sensitive,
 538 and \fB\-\-\fR and \fB_\fR are treated interchangeably.  Unique
 539 abbreviations are acceptable, e.g. \fBnet\fR or \fBn\fR is sufficient
 540 to identify the \fBNetFlow\fR table.
 541 .
 542 .ST "Database Values"
 543 .PP
 544 Each column in the database accepts a fixed type of data.  The
 545 currently defined basic types, and their representations, are:
 546 .IP "integer"
 547 A decimal integer in the range \-2**63 to 2**63\-1, inclusive.
 548 .IP "real"
 549 A floating-point number.
 550 .IP "Boolean"
 551 True or false, written \fBtrue\fR or \fBfalse\fR, respectively.
 552 .IP "string"
 553 An arbitrary Unicode string, except that null bytes are not allowed.
 554 Quotes are optional for most strings that begin with an English letter
 555 or underscore and consist only of letters, underscores, hyphens, and
 556 periods.  However, \fBtrue\fR and \fBfalse\fR and strings that match
 557 the syntax of UUIDs (see below) must be enclosed in double quotes to
 558 distinguish them from other basic types.  When double quotes are used,
 559 the syntax is that of strings in JSON, e.g. backslashes may be used to
 560 escape special characters.  The empty string must be represented as a
 561 pair of double quotes (\fB""\fR).
 562 .IP "UUID"
 563 Either a universally unique identifier in the style of RFC 4122,
 564 e.g. \fBf81d4fae\-7dec\-11d0\-a765\-00a0c91e6bf6\fR, or an \fB@\fIname\fR
 565 defined by a \fBget\fR or \fBcreate\fR command within the same \fBovs\-vsctl\fR
 566 invocation.
 567 .PP
 568 Multiple values in a single column may be separated by spaces or a
 569 single comma.  When multiple values are present, duplicates are not
 570 allowed, and order is not important.  Conversely, some database
 571 columns can have an empty set of values, represented as \fB[]\fR, and
 572 square brackets may optionally enclose other non-empty sets or single
 573 values as well.
 574 .PP
 575 A few database columns are ``maps'' of key-value pairs, where the key
 576 and the value are each some fixed database type.  These are specified
 577 in the form \fIkey\fB=\fIvalue\fR, where \fIkey\fR and \fIvalue\fR
 578 follow the syntax for the column's key type and value type,
 579 respectively.  When multiple pairs are present (separated by spaces or
 580 a comma), duplicate keys are not allowed, and again the order is not
 581 important.  Duplicate values are allowed.  An empty map is represented
 582 as \fB{}\fR.  Curly braces may optionally enclose non-empty maps as
 583 well (but use quotes to prevent the shell from expanding
 584 \fBother-config={0=x,1=y}\fR into \fBother-config=0=x
 585 other-config=1=y\fR, which may not have the desired effect).
 586 .
 587 .ST "Database Command Syntax"
 588 .
 589 .IP "[\fB\-\-if\-exists\fR] [\fB\-\-columns=\fIcolumn\fR[\fB,\fIcolumn\fR]...] \fBlist \fItable \fR[\fIrecord\fR]..."
 590 Lists the data in each specified \fIrecord\fR.  If no
 591 records are specified, lists all the records in \fItable\fR.
 592 .IP
 593 If \fB\-\-columns\fR is specified, only the requested columns are
 594 listed, in the specified order.  Otherwise, all columns are listed, in
 595 alphabetical order by column name.
 596 .IP
 597 Without \fB\-\-if-exists\fR, it is an error if any specified
 598 \fIrecord\fR does not exist.  With \fB\-\-if-exists\fR, the command
 599 ignores any \fIrecord\fR that does not exist, without producing any
 600 output.
 601 .
 602 .IP "[\fB\-\-columns=\fIcolumn\fR[\fB,\fIcolumn\fR]...] \fBfind \fItable \fR[\fIcolumn\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR]..."
 603 Lists the data in each record in \fItable\fR whose \fIcolumn\fR equals
 604 \fIvalue\fR or, if \fIkey\fR is specified, whose \fIcolumn\fR contains
 605 a \fIkey\fR with the specified \fIvalue\fR.  The following operators
 606 may be used where \fB=\fR is written in the syntax summary:
 607 .RS
 608 .IP "\fB= != < > <= >=\fR"
 609 Selects records in which \fIcolumn\fR[\fB:\fIkey\fR] equals, does not
 610 equal, is less than, is greater than, is less than or equal to, or is
 611 greater than or equal to \fIvalue\fR, respectively.
 612 .IP
 613 Consider \fIcolumn\fR[\fB:\fIkey\fR] and \fIvalue\fR as sets of
 614 elements.  Identical sets are considered equal.  Otherwise, if the
 615 sets have different numbers of elements, then the set with more
 616 elements is considered to be larger.  Otherwise, consider a element
 617 from each set pairwise, in increasing order within each set.  The
 618 first pair that differs determines the result.  (For a column that
 619 contains key-value pairs, first all the keys are compared, and values
 620 are considered only if the two sets contain identical keys.)
 621 .IP "\fB{=} {!=}\fR"
 622 Test for set equality or inequality, respectively.
 623 .IP "\fB{<=}\fR"
 624 Selects records in which \fIcolumn\fR[\fB:\fIkey\fR] is a subset of
 625 \fIvalue\fR.  For example, \fBflood-vlans{<=}1,2\fR selects records in
 626 which the \fBflood-vlans\fR column is the empty set or contains 1 or 2
 627 or both.
 628 .IP "\fB{<}\fR"
 629 Selects records in which \fIcolumn\fR[\fB:\fIkey\fR] is a proper
 630 subset of \fIvalue\fR.  For example, \fBflood-vlans{<}1,2\fR selects
 631 records in which the \fBflood-vlans\fR column is the empty set or
 632 contains 1 or 2 but not both.
 633 .IP "\fB{>=} {>}\fR"
 634 Same as \fB{<=}\fR and \fB{<}\fR, respectively, except that the
 635 relationship is reversed.  For example, \fBflood-vlans{>=}1,2\fR
 636 selects records in which the \fBflood-vlans\fR column contains both 1
 637 and 2.
 638 .RE
 639 .IP
 640 For arithmetic operators (\fB= != < > <= >=\fR), when \fIkey\fR is
 641 specified but a particular record's \fIcolumn\fR does not contain
 642 \fIkey\fR, the record is always omitted from the results.  Thus, the
 643 condition \fBother-config:mtu!=1500\fR matches records that have a
 644 \fBmtu\fR key whose value is not 1500, but not those that lack an
 645 \fBmtu\fR key.
 646 .IP
 647 For the set operators, when \fIkey\fR is specified but a particular
 648 record's \fIcolumn\fR does not contain \fIkey\fR, the comparison is
 649 done against an empty set.  Thus, the condition
 650 \fBother-config:mtu{!=}1500\fR matches records that have a \fBmtu\fR
 651 key whose value is not 1500 and those that lack an \fBmtu\fR key.
 652 .IP
 653 Don't forget to escape \fB<\fR or \fB>\fR from interpretation by the
 654 shell.
 655 .IP
 656 If \fB\-\-columns\fR is specified, only the requested columns are
 657 listed, in the specified order.  Otherwise all columns are listed, in
 658 alphabetical order by column name.
 659 .IP
 660 The UUIDs shown for rows created in the same \fBovs\-vsctl\fR
 661 invocation will be wrong.
 662 .
 663 .IP "[\fB\-\-if\-exists\fR] [\fB\-\-id=@\fIname\fR] \fBget \fItable record \fR[\fIcolumn\fR[\fB:\fIkey\fR]]..."
 664 Prints the value of each specified \fIcolumn\fR in the given
 665 \fIrecord\fR in \fItable\fR.  For map columns, a \fIkey\fR may
 666 optionally be specified, in which case the value associated with
 667 \fIkey\fR in the column is printed, instead of the entire map.
 668 .IP
 669 Without \fB\-\-if\-exists\fR, it is an error if \fIrecord\fR does not
 670 exist or \fIkey\fR is specified, if \fIkey\fR does not exist in
 671 \fIrecord\fR.  With \fB\-\-if\-exists\fR, a missing \fIrecord\fR
 672 yields no output and a missing \fIkey\fR prints a blank line.
 673 .IP
 674 If \fB@\fIname\fR is specified, then the UUID for \fIrecord\fR may be
 675 referred to by that name later in the same \fBovs\-vsctl\fR
 676 invocation in contexts where a UUID is expected.
 677 .IP
 678 Both \fB\-\-id\fR and the \fIcolumn\fR arguments are optional, but
 679 usually at least one or the other should be specified.  If both are
 680 omitted, then \fBget\fR has no effect except to verify that
 681 \fIrecord\fR exists in \fItable\fR.
 682 .IP
 683 \fB\-\-id\fR and \fB\-\-if\-exists\fR cannot be used together.
 684 .
 685 .IP "[\fB\-\-if\-exists\fR] \fBset \fItable record column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
 686 Sets the value of each specified \fIcolumn\fR in the given
 687 \fIrecord\fR in \fItable\fR to \fIvalue\fR.  For map columns, a
 688 \fIkey\fR may optionally be specified, in which case the value
 689 associated with \fIkey\fR in that column is changed (or added, if none
 690 exists), instead of the entire map.
 691 .IP
 692 Without \fB\-\-if-exists\fR, it is an error if \fIrecord\fR does not
 693 exist.  With \fB\-\-if-exists\fR, this command does nothing if
 694 \fIrecord\fR does not exist.
 695 .
 696 .IP "[\fB\-\-if\-exists\fR] \fBadd \fItable record column \fR[\fIkey\fB=\fR]\fIvalue\fR..."
 697 Adds the specified value or key-value pair to \fIcolumn\fR in
 698 \fIrecord\fR in \fItable\fR.  If \fIcolumn\fR is a map, then \fIkey\fR
 699 is required, otherwise it is prohibited.  If \fIkey\fR already exists
 700 in a map column, then the current \fIvalue\fR is not replaced (use the
 701 \fBset\fR command to replace an existing value).
 702 .IP
 703 Without \fB\-\-if-exists\fR, it is an error if \fIrecord\fR does not
 704 exist.  With \fB\-\-if-exists\fR, this command does nothing if
 705 \fIrecord\fR does not exist.
 706 .
 707 .IP "[\fB\-\-if\-exists\fR] \fBremove \fItable record column \fR\fIvalue\fR..."
 708 .IQ "[\fB\-\-if\-exists\fR] \fBremove \fItable record column \fR\fIkey\fR..."
 709 .IQ "[\fB\-\-if\-exists\fR] \fBremove \fItable record column \fR\fIkey\fB=\fR\fIvalue\fR..."
 710 Removes the specified values or key-value pairs from \fIcolumn\fR in
 711 \fIrecord\fR in \fItable\fR.  The first form applies to columns that
 712 are not maps: each specified \fIvalue\fR is removed from the column.
 713 The second and third forms apply to map columns: if only a \fIkey\fR
 714 is specified, then any key-value pair with the given \fIkey\fR is
 715 removed, regardless of its value; if a \fIvalue\fR is given then a
 716 pair is removed only if both key and value match.
 717 .IP
 718 It is not an error if the column does not contain the specified key or
 719 value or pair.
 720 .IP
 721 Without \fB\-\-if-exists\fR, it is an error if \fIrecord\fR does not
 722 exist.  With \fB\-\-if-exists\fR, this command does nothing if
 723 \fIrecord\fR does not exist.
 724 .
 725 .IP "[\fB\-\-if\-exists\fR] \fBclear\fR \fItable record column\fR..."
 726 Sets each \fIcolumn\fR in \fIrecord\fR in \fItable\fR to the empty set
 727 or empty map, as appropriate.  This command applies only to columns
 728 that are allowed to be empty.
 729 .IP
 730 Without \fB\-\-if-exists\fR, it is an error if \fIrecord\fR does not
 731 exist.  With \fB\-\-if-exists\fR, this command does nothing if
 732 \fIrecord\fR does not exist.
 733 .
 734 .IP "[\fB\-\-id=@\fIname\fR] \fBcreate\fR \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
 735 Creates a new record in \fItable\fR and sets the initial values of
 736 each \fIcolumn\fR.  Columns not explicitly set will receive their
 737 default values.  Outputs the UUID of the new row.
 738 .IP
 739 If \fB@\fIname\fR is specified, then the UUID for the new row may be
 740 referred to by that name elsewhere in the same \fBovs\-vsctl\fR
 741 invocation in contexts where a UUID is expected.  Such references may
 742 precede or follow the \fBcreate\fR command.
 743 .IP
 744 Records in the Open vSwitch database are significant only when they
 745 can be reached directly or indirectly from the \fBOpen_vSwitch\fR
 746 table.  Except for records in the \fBQoS\fR or \fBQueue\fR tables,
 747 records that are not reachable from the \fBOpen_vSwitch\fR table are
 748 automatically deleted from the database.  This deletion happens
 749 immediately, without waiting for additional \fBovs\-vsctl\fR commands
 750 or other database activity.  Thus, a \fBcreate\fR command must
 751 generally be accompanied by additional commands \fIwithin the same
 752 \fBovs\-vsctl\fI invocation\fR to add a chain of references to the
 753 newly created record from the top-level \fBOpen_vSwitch\fR record.
 754 The \fBEXAMPLES\fR section gives some examples that show how to do
 755 this.
 756 .
 757 .IP "\fR[\fB\-\-if\-exists\fR] \fBdestroy \fItable record\fR..."
 758 Deletes each specified \fIrecord\fR from \fItable\fR.  Unless
 759 \fB\-\-if\-exists\fR is specified, each \fIrecord\fRs must exist.
 760 .IP "\fB\-\-all destroy \fItable\fR"
 761 Deletes all records from the \fItable\fR.
 762 .IP
 763 The \fBdestroy\fR command is only useful for records in the \fBQoS\fR
 764 or \fBQueue\fR tables.  Records in other tables are automatically
 765 deleted from the database when they become unreachable from the
 766 \fBOpen_vSwitch\fR table.  This means that deleting the last reference
 767 to a record is sufficient for deleting the record itself.  For records
 768 in these tables, \fBdestroy\fR is silently ignored.  See the
 769 \fBEXAMPLES\fR section below for more information.
 770 .
 771 .IP "\fBwait\-until \fItable record \fR[\fIcolumn\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR]..."
 772 Waits until \fItable\fR contains a record named \fIrecord\fR whose
 773 \fIcolumn\fR equals \fIvalue\fR or, if \fIkey\fR is specified, whose
 774 \fIcolumn\fR contains a \fIkey\fR with the specified \fIvalue\fR.  Any
 775 of the operators \fB!=\fR, \fB<\fR, \fB>\fR, \fB<=\fR, or \fB>=\fR may
 776 be substituted for \fB=\fR to test for inequality, less than, greater
 777 than, less than or equal to, or greater than or equal to,
 778 respectively.  (Don't forget to escape \fB<\fR or \fB>\fR from
 779 interpretation by the shell.)
 780 .IP
 781 If no \fIcolumn\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR arguments are given,
 782 this command waits only until \fIrecord\fR exists.  If more than one
 783 such argument is given, the command waits until all of them are
 784 satisfied.
 785 .IP
 786 Usually \fBwait\-until\fR should be placed at the beginning of a set
 787 of \fBovs\-vsctl\fR commands.  For example, \fBwait\-until bridge br0
 788 \-\- get bridge br0 datapath_id\fR waits until a bridge named
 789 \fBbr0\fR is created, then prints its \fBdatapath_id\fR column,
 790 whereas \fBget bridge br0 datapath_id \-\- wait\-until bridge br0\fR
 791 will abort if no bridge named \fBbr0\fR exists when \fBovs\-vsctl\fR
 792 initially connects to the database.
 793 .IP
 794 Consider specifying \fB\-\-timeout=0\fR along with
 795 \fB\-\-wait\-until\fR, to prevent \fBovs\-vsctl\fR from terminating
 796 after waiting only at most 5 seconds.
 797 .IP "\fBcomment \fR[\fIarg\fR]..."
 798 This command has no effect on behavior, but any database log record
 799 created by the command will include the command and its arguments.
 800 .SH "EXAMPLES"
 801 Create a new bridge named br0 and add port eth0 to it:
 802 .IP
 803 .B "ovs\-vsctl add\-br br0"
 804 .br
 805 .B "ovs\-vsctl add\-port br0 eth0"
 806 .PP
 807 Alternatively, perform both operations in a single atomic transaction:
 808 .IP
 809 .B "ovs\-vsctl add\-br br0 \-\- add\-port br0 eth0"
 810 .PP
 811 Delete bridge \fBbr0\fR, reporting an error if it does not exist:
 812 .IP
 813 .B "ovs\-vsctl del\-br br0"
 814 .PP
 815 Delete bridge \fBbr0\fR if it exists:
 816 .IP
 817 .B "ovs\-vsctl \-\-if\-exists del\-br br0"
 818 .PP
 819 Set the \fBqos\fR column of the \fBPort\fR record for \fBeth0\fR to
 820 point to a new \fBQoS\fR record, which in turn points with its queue 0
 821 to a new \fBQueue\fR record:
 822 .IP
 823 .B "ovs\-vsctl \-\- set port eth0 qos=@newqos \-\- \-\-id=@newqos create qos type=linux\-htb other\-config:max\-rate=1000000 queues:0=@newqueue \-\- \-\-id=@newqueue create queue other\-config:min\-rate=1000000 other\-config:max\-rate=1000000"
 824 .SH "CONFIGURATION COOKBOOK"
 825 .SS "Port Configuration"
 826 .PP
 827 Add an ``internal port'' \fBvlan10\fR to bridge \fBbr0\fR as a VLAN
 828 access port for VLAN 10, and configure it with an IP address:
 829 .IP
 830 .B "ovs\-vsctl add\-port br0 vlan10 tag=10 \-\- set Interface vlan10 type=internal"
 831 .IP
 832 .B "ifconfig vlan10 192.168.0.123"
 833 .
 834 .PP
 835 Add a GRE tunnel port \fBgre0\fR to remote IP address 1.2.3.4 to
 836 bridge \fBbr0\fR:
 837 .IP
 838 .B "ovs\-vsctl add\-port br0 gre0 \-\- set Interface gre0 type=gre options:remote_ip=1.2.3.4"
 839 .
 840 .SS "Port Mirroring"
 841 .PP
 842 Mirror all packets received or sent on \fBeth0\fR or \fBeth1\fR onto
 843 \fBeth2\fR, assuming that all of those ports exist on bridge \fBbr0\fR
 844 (as a side-effect this causes any packets received on \fBeth2\fR to be
 845 ignored):
 846 .IP
 847 .B "ovs\-vsctl \-\- set Bridge br0 mirrors=@m \(rs"
 848 .IP
 849 .B "\-\- \-\-id=@eth0 get Port eth0 \(rs"
 850 .IP
 851 .B "\-\- \-\-id=@eth1 get Port eth1 \(rs"
 852 .IP
 853 .B "\-\- \-\-id=@eth2 get Port eth2 \(rs"
 854 .IP
 855 .B "\-\- \-\-id=@m create Mirror name=mymirror select-dst-port=@eth0,@eth1 select-src-port=@eth0,@eth1 output-port=@eth2"
 856 .PP
 857 Remove the mirror created above from \fBbr0\fR, which also destroys
 858 the Mirror record (since it is now unreferenced):
 859 .IP
 860 .B "ovs\-vsctl \-\- \-\-id=@rec get Mirror mymirror \(rs"
 861 .IP
 862 .B "\-\- remove Bridge br0 mirrors @rec"
 863 .PP
 864 The following simpler command also works:
 865 .IP
 866 .B "ovs\-vsctl clear Bridge br0 mirrors"
 867 .SS "Quality of Service (QoS)"
 868 .PP
 869 Create a \fBlinux\-htb\fR QoS record that points to a few queues and
 870 use it on \fBeth0\fR and \fBeth1\fR:
 871 .IP
 872 .B "ovs\-vsctl \-\- set Port eth0 qos=@newqos \(rs"
 873 .IP
 874 .B "\-\- set Port eth1 qos=@newqos \(rs"
 875 .IP
 876 .B "\-\- \-\-id=@newqos create QoS type=linux\-htb other\-config:max\-rate=1000000000 queues=0=@q0,1=@q1 \(rs"
 877 .IP
 878 .B "\-\- \-\-id=@q0 create Queue other\-config:min\-rate=100000000 other\-config:max\-rate=100000000 \(rs"
 879 .IP
 880 .B "\-\- \-\-id=@q1 create Queue other\-config:min\-rate=500000000"
 881 .PP
 882 Deconfigure the QoS record above from \fBeth1\fR only:
 883 .IP
 884 .B "ovs\-vsctl clear Port eth1 qos"
 885 .PP
 886 To deconfigure the QoS record from both \fBeth0\fR and \fBeth1\fR and
 887 then delete the QoS record (which must be done explicitly because
 888 unreferenced QoS records are not automatically destroyed):
 889 .IP
 890 .B "ovs\-vsctl \-\- destroy QoS eth0 \-\- clear Port eth0 qos \-\- clear Port eth1 qos"
 891 .PP
 892 (This command will leave two unreferenced Queue records in the
 893 database.  To delete them, use "\fBovs\-vsctl list Queue\fR" to find
 894 their UUIDs, then "\fBovs\-vsctl destroy Queue \fIuuid1\fR
 895 \fIuuid2\fR" to destroy each of them or use
 896 "\fBovs\-vsctl -- --all destroy Queue\fR" to delete all records.)
 897 .SS "Connectivity Monitoring"
 898 .PP
 899 Monitor connectivity to a remote maintenance point on eth0.
 900 .IP
 901 .B "ovs\-vsctl set Interface eth0 cfm_mpid=1"
 902 .PP
 903 Deconfigure connectivity monitoring from above:
 904 .IP
 905 .B "ovs\-vsctl clear Interface eth0 cfm_mpid"
 906 .SS "NetFlow"
 907 .PP
 908 Configure bridge \fBbr0\fR to send NetFlow records to UDP port 5566 on
 909 host 192.168.0.34, with an active timeout of 30 seconds:
 910 .IP
 911 .B "ovs\-vsctl \-\- set Bridge br0 netflow=@nf \(rs"
 912 .IP
 913 .B "\-\- \-\-id=@nf create NetFlow targets=\(rs\(dq192.168.0.34:5566\(rs\(dq active\-timeout=30"
 914 .PP
 915 Update the NetFlow configuration created by the previous command to
 916 instead use an active timeout of 60 seconds:
 917 .IP
 918 .B "ovs\-vsctl set NetFlow br0 active_timeout=60"
 919 .PP
 920 Deconfigure the NetFlow settings from \fBbr0\fR, which also destroys
 921 the NetFlow record (since it is now unreferenced):
 922 .IP
 923 .B "ovs\-vsctl clear Bridge br0 netflow"
 924 .SS "sFlow"
 925 .PP
 926 Configure bridge \fBbr0\fR to send sFlow records to a collector on
 927 10.0.0.1 at port 6343, using \fBeth1\fR\'s IP address as the source,
 928 with specific sampling parameters:
 929 .IP
 930 .B "ovs\-vsctl \-\- \-\-id=@s create sFlow agent=eth1 target=\(rs\(dq10.0.0.1:6343\(rs\(dq header=128 sampling=64 polling=10 \(rs"
 931 .IP
 932 .B "\-\- set Bridge br0 sflow=@s"
 933 .PP
 934 Deconfigure sFlow from \fBbr0\fR, which also destroys the sFlow record
 935 (since it is now unreferenced):
 936 .IP
 937 .B "ovs\-vsctl \-\- clear Bridge br0 sflow"
 938 .SS "IPFIX"
 939 .PP
 940 Configure bridge \fBbr0\fR to send one IPFIX flow record per packet
 941 sample to UDP port 4739 on host 192.168.0.34, with Observation Domain
 942 ID 123 and Observation Point ID 456, a flow cache active timeout of 1
 943 minute (60 seconds), and a maximum flow cache size of 13 flows:
 944 .IP
 945 .B "ovs\-vsctl \-\- set Bridge br0 ipfix=@i \(rs"
 946 .IP
 947 .B "\-\- \-\-id=@i create IPFIX targets=\(rs\(dq192.168.0.34:4739\(rs\(dq obs_domain_id=123 obs_point_id=456 cache_active_timeout=60 cache_max_flows=13"
 948 .PP
 949 Deconfigure the IPFIX settings from \fBbr0\fR, which also destroys the
 950 IPFIX record (since it is now unreferenced):
 951 .IP
 952 .B "ovs\-vsctl clear Bridge br0 ipfix"
 953 .SS "802.1D Spanning Tree Protocol (STP)"
 954 .PP
 955 Configure bridge \fBbr0\fR to participate in an 802.1D spanning tree:
 956 .IP
 957 .B "ovs\-vsctl set Bridge br0 stp_enable=true"
 958 .PP
 959 Set the bridge priority of \fBbr0\fR to 0x7800:
 960 .IP
 961 .B "ovs\-vsctl set Bridge br0 other_config:stp-priority=0x7800"
 962 .PP
 963 Set the path cost of port \fBeth0\fR to 10:
 964 .IP
 965 .B "ovs\-vsctl set Port eth0 other_config:stp-path-cost=10"
 966 .PP
 967 Deconfigure STP from above:
 968 .IP
 969 .B "ovs\-vsctl set Bridge br0 stp_enable=false"
 970 .PP
 971 .SS "OpenFlow Version"
 972 .PP
 973 Configure bridge \fBbr0\fR to support OpenFlow versions 1.0, 1.2, and
 974 1.3:
 975 .IP
 976 .B "ovs\-vsctl set bridge br0 protocols=openflow10,openflow12,openflow13"
 977 .
 978 .SH "EXIT STATUS"
 979 .IP "0"
 980 Successful program execution.
 981 .IP "1"
 982 Usage, syntax, or configuration file error.
 983 .IP "2"
 984 The \fIbridge\fR argument to \fBbr\-exists\fR specified the name of a
 985 bridge that does not exist.
 986 .SH "SEE ALSO"
 987 .
 988 .BR ovsdb\-server (1),
 989 .BR ovs\-vswitchd (8),
 990 .BR ovs\-vswitchd.conf.db (5).