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