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