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 .ds PN ovs\-vsctl
  15 .
  16 .SH NAME
  17 ovs\-vsctl \- utility for querying and configuring \fBovs\-vswitchd\fR
  18 .
  19 .SH SYNOPSIS
  20 \fBovs\-vsctl\fR [\fIoptions\fR] \fB\-\-\fR [\fIoptions\fR] \fIcommand
  21 \fR[\fIargs\fR] [\fB\-\-\fR [\fIoptions\fR] \fIcommand \fR[\fIargs\fR]]...
  22 .
  23 .SH DESCRIPTION
  24 The \fBovs\-vsctl\fR program configures \fBovs\-vswitchd\fR(8) by
  25 providing a high\-level interface to its configuration
  26 database.  This program is mainly intended for use when
  27 \fBovs\-vswitchd\fR is running.  If it is used when
  28 \fBovs\-vswitchd\fR is not running, then \fB\-\-no\-wait\fR should be
  29 specified and configuration changes will only take effect when
  30 \fBovs\-vswitchd\fR is started.
  31 .PP
  32 By default, each time \fBovs\-vsctl\fR runs, it connects to an
  33 \fBovsdb\-server\fR process that maintains an Open vSwitch
  34 configuration database.  Using this connection, it queries and
  35 possibly applies changes to the database, depending on the supplied
  36 commands.  Then, if it applied any changes, it waits until
  37 \fBovs\-vswitchd\fR has finished reconfiguring itself before it exits.
  38 .PP
  39 \fBovs\-vsctl\fR can perform any number of commands in a single run,
  40 implemented as a single atomic transaction against the database.
  41 .PP
  42 The \fBovs\-vsctl\fR command line begins with global options (see
  43 \fBOPTIONS\fR below for details).  The global options are followed by
  44 one or more commands.  Each command should begin with \fB\-\-\fR by
  45 itself as a command-line argument, to separate it from the global
  46 options and following commands.  (If the first command does not have
  47 any options, then the first \fB\-\-\fR may be omitted.)  The command
  48 itself starts with command-specific options, if any, followed by the
  49 command name and any arguments.  See \fBEXAMPLES\fR below for syntax
  50 examples.
  51 .
  52 .SS "Linux VLAN Bridging Compatibility"
  53 The \fBovs\-vsctl\fR program supports the model of a bridge
  54 implemented by Open vSwitch, in which a single bridge supports ports
  55 on multiple VLANs.  In this model, each port on a bridge is either a
  56 trunk port that potentially passes packets tagged with 802.1Q headers
  57 that designate VLANs or it is assigned a single implicit VLAN that is
  58 never tagged with an 802.1Q header.
  59 .PP
  60 For compatibility with software designed for the Linux bridge,
  61 \fBovs\-vsctl\fR also supports a model in which traffic associated
  62 with a given 802.1Q VLAN is segregated into a separate bridge.  A
  63 special form of the \fBadd\-br\fR command (see below) creates a ``fake
  64 bridge'' within an Open vSwitch bridge to simulate this behavior.
  65 When such a ``fake bridge'' is active, \fBovs\-vsctl\fR will treat it
  66 much like a bridge separate from its ``parent bridge,'' but the actual
  67 implementation in Open vSwitch uses only a single bridge, with ports on
  68 the fake bridge assigned the implicit VLAN of the fake bridge of which
  69 they are members.
  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=vvsctl: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 .
 113 .IP "\fB\-\-dry\-run\fR"
 114 Prevents \fBovs\-vsctl\fR from actually modifying the database.
 115 .
 116 .IP "\fB-t \fIsecs\fR"
 117 .IQ "\fB--timeout=\fIsecs\fR"
 118 Limits runtime to approximately \fIsecs\fR seconds.  A value of
 119 zero will cause \fBovs\-vsctl\fR to wait forever.  If the timeout expires,
 120 \fBovs\-vsctl\fR will exit with a \fBSIGALRM\fR signal.  If this option is
 121 not used, \fBovs\-vsctl\fR uses a timeout of five seconds.
 122 (A timeout would normally happen only if the database cannot be contacted.)
 123 .
 124 .SS "Public Key Infrastructure Options"
 125 .so lib/ssl.man
 126 .so lib/vlog.man
 127 .
 128 .SH COMMANDS
 129 The commands implemented by \fBovs\-vsctl\fR are described in the
 130 sections below.
 131 .SS "Open vSwitch Commands"
 132 These commands work with an Open vSwitch as a whole.
 133 .
 134 .IP "\fBinit\fR"
 135 Initializes the Open vSwitch database, if it is empty.  If the
 136 database has already been initialized, this command has no effect.
 137 .IP
 138 Any successful \fBovs\-vsctl\fR command automatically initializes the
 139 Open vSwitch database if it is empty.  This command is provided to
 140 initialize the database without executing any other command.
 141 .
 142 .IP "\fBemer\-reset\fR"
 143 Reset the configuration into a clean state.  This will clear the
 144 configuration of items likely to have been configured by a manager.
 145 The core networking configuration will be left as is.
 146 .
 147 .SS "Bridge Commands"
 148 These commands examine and manipulate Open vSwitch bridges.
 149 .
 150 .IP "[\fB\-\-may\-exist\fR] \fBadd\-br \fIbridge\fR"
 151 Creates a new bridge named \fIbridge\fR.  Initially the bridge will
 152 have no ports (other than \fIbridge\fR itself).
 153 .IP
 154 Without \fB\-\-may\-exist\fR, attempting to create a bridge that
 155 exists is an error.  With \fB\-\-may\-exist\fR, \fIbridge\fR may
 156 already exist (but it must be a real bridge, not a VLAN bridge).
 157 .
 158 .IP "[\fB\-\-may\-exist\fR] \fBadd\-br \fIbridge parent vlan\fR"
 159 Creates a ``fake bridge'' named \fIbridge\fR within the existing Open
 160 vSwitch bridge \fIparent\fR, which must already exist and must not
 161 itself be a fake bridge.  The new fake bridge will be on 802.1Q VLAN
 162 \fIvlan\fR, which must be an integer between 1 and 4095.  Initially
 163 \fIbridge\fR will have no ports (other than \fIbridge\fR itself).
 164 .IP
 165 Without \fB\-\-may\-exist\fR, attempting to create a bridge that
 166 exists is an error.  With \fB\-\-may\-exist\fR, \fIbridge\fR may
 167 already exist (but it must have the specified \fIvlan\fR and
 168 \fIparent\fR).
 169 .
 170 .IP "[\fB\-\-if\-exists\fR] \fBdel\-br \fIbridge\fR"
 171 Deletes \fIbridge\fR and all of its ports.  If \fIbridge\fR is a real
 172 bridge, this command also deletes any fake bridges that were created
 173 with \fIbridge\fR as parent, including all of their ports.
 174 .IP
 175 Without \fB\-\-if\-exists\fR, attempting to delete a bridge that does
 176 not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
 177 delete a bridge that does not exist has no effect.
 178 .
 179 .IP "\fBlist\-br\fR"
 180 Lists all existing real and fake bridges on standard output, one per
 181 line.
 182 .
 183 .IP "\fBbr\-exists \fIbridge\fR"
 184 Tests whether \fIbridge\fR exists as a real or fake bridge.  If so,
 185 \fBovs\-vsctl\fR exits successfully with exit code 0.  If not,
 186 \fBovs\-vsctl\fR exits unsuccessfully with exit code 2.
 187 .
 188 .IP "\fBbr\-to\-vlan \fIbridge\fR"
 189 If \fIbridge\fR is a fake bridge, prints the bridge's 802.1Q VLAN as a
 190 decimal integer.  If \fIbridge\fR is a real bridge, prints 0.
 191 .
 192 .IP "\fBbr\-to\-parent \fIbridge\fR"
 193 If \fIbridge\fR is a fake bridge, prints the name of its parent
 194 bridge.  If \fIbridge\fR is a real bridge, print \fIbridge\fR.
 195 .
 196 .IP "\fBbr\-set\-external\-id \fIbridge key\fR [\fIvalue\fR]"
 197 Sets or clears an ``external ID'' value on \fIbridge\fR.  These values
 198 are intended to identify entities external to Open vSwitch with which
 199 \fIbridge\fR is associated, e.g. the bridge's identifier in a
 200 virtualization management platform.  The Open vSwitch database schema
 201 specifies well-known \fIkey\fR values, but \fIkey\fR and \fIvalue\fR
 202 are otherwise arbitrary strings.
 203 .IP
 204 If \fIvalue\fR is specified, then \fIkey\fR is set to \fIvalue\fR for
 205 \fIbridge\fR, overwriting any previous value.  If \fIvalue\fR is
 206 omitted, then \fIkey\fR is removed from \fIbridge\fR's set of external
 207 IDs (if it was present).
 208 .IP
 209 For real bridges, the effect of this command is similar to that of a
 210 \fBset\fR or \fBremove\fR command in the \fBexternal\-ids\fR column of
 211 the \fBBridge\fR table.  For fake bridges, it actually modifies keys
 212 with names prefixed by \fBfake\-bridge\-\fR in the \fBPort\fR table.
 213 .
 214 .IP "\fBbr\-get\-external\-id \fIbridge\fR [\fIkey\fR]"
 215 Queries the external IDs on \fIbridge\fR.  If \fIkey\fR is specified,
 216 the output is the value for that \fIkey\fR or the empty string if
 217 \fIkey\fR is unset.  If \fIkey\fR is omitted, the output is
 218 \fIkey\fB=\fIvalue\fR, one per line, for each key-value pair.
 219 .IP
 220 For real bridges, the effect of this command is similar to that of a
 221 \fBget\fR command in the \fBexternal\-ids\fR column of the
 222 \fBBridge\fR table.  For fake bridges, it queries keys with names
 223 prefixed by \fBfake\-bridge\-\fR in the \fBPort\fR table.
 224 .
 225 .SS "Port Commands"
 226 .
 227 These commands examine and manipulate Open vSwitch ports.  These
 228 commands treat a bonded port as a single entity.
 229 .
 230 .IP "\fBlist\-ports \fIbridge\fR"
 231 Lists all of the ports within \fIbridge\fR on standard output, one per
 232 line.  The local port \fIbridge\fR is not included in the list.
 233 .
 234 .IP "[\fB\-\-may\-exist\fR] \fBadd\-port \fIbridge port \fR[\fIcolumn\fR[\fB:\fIkey\fR]\fR=\fIvalue\fR]\&...\fR"
 235 Creates on \fIbridge\fR a new port named \fIport\fR from the network
 236 device of the same name.
 237 .IP
 238 Optional arguments set values of column in the Port record created by
 239 the command.  For example, \fBtag=9\fR would make the port an access
 240 port for VLAN 9.  The syntax is the same as that for the \fBset\fR
 241 command (see \fBDatabase Commands\fR below).
 242 .IP
 243 Without \fB\-\-may\-exist\fR, attempting to create a port that exists
 244 is an error.  With \fB\-\-may\-exist\fR, \fIport\fR may already exist
 245 (but it must be on \fIbridge\fR and not be a bonded port).
 246 .
 247 .IP "[\fB\-\-fake\-iface\fR] \fBadd\-bond \fIbridge port iface\fR\&... [\fIcolumn\fR[\fB:\fIkey\fR]\fR=\fIvalue\fR]\&...\fR"
 248 Creates on \fIbridge\fR a new port named \fIport\fR that bonds
 249 together the network devices given as each \fIiface\fR.  At least two
 250 interfaces must be named.
 251 .IP
 252 Optional arguments set values of column in the Port record created by
 253 the command.  The syntax is the same as that for the \fBset\fR command
 254 (see \fBDatabase Commands\fR below).
 255 .IP
 256 With \fB\-\-fake\-iface\fR, a fake interface with the name \fIport\fR is
 257 created.  This should only be used for compatibility with legacy
 258 software that requires it.
 259 .IP
 260 Without \fB\-\-may\-exist\fR, attempting to create a port that exists
 261 is an error.  With \fB\-\-may\-exist\fR, \fIport\fR may already exist
 262 (but it must be on \fIbridge\fR and bond together exactly the
 263 specified interface).
 264 .
 265 .IP "[\fB\-\-if\-exists\fR] \fBdel\-port \fR[\fIbridge\fR] \fIport\fR"
 266 Deletes \fIport\fR.  If \fIbridge\fR is omitted, \fIport\fR is removed
 267 from whatever bridge contains it; if \fIbridge\fR is specified, it
 268 must be the real or fake bridge that contains \fIport\fR.
 269 .IP
 270 Without \fB\-\-if\-exists\fR, attempting to delete a port that does
 271 not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
 272 delete a port that does not exist has no effect.
 273 .
 274 .IP "[\fB\-\-if\-exists\fR] \fB\-\-with\-iface del\-port \fR[\fIbridge\fR] \fIiface\fR"
 275 Deletes the port named \fIiface\fR or that has an interface named
 276 \fIiface\fR.  If \fIbridge\fR is omitted, the port is removed from
 277 whatever bridge contains it; if \fIbridge\fR is specified, it must be
 278 the real or fake bridge that contains the port.
 279 .IP
 280 Without \fB\-\-if\-exists\fR, attempting to delete the port for an
 281 interface that does not exist is an error.  With \fB\-\-if\-exists\fR,
 282 attempting to delete the port for an interface that does not exist has
 283 no effect.
 284 .
 285 .IP "\fBport\-to\-br \fIport\fR"
 286 Prints the name of the bridge that contains \fIport\fR on standard
 287 output.
 288 .
 289 .SS "Interface Commands"
 290 .
 291 These commands examine the interfaces attached to an Open vSwitch
 292 bridge.  These commands treat a bonded port as a collection of two or
 293 more interfaces, rather than as a single port.
 294 .
 295 .IP "\fBlist\-ifaces \fIbridge\fR"
 296 Lists all of the interfaces within \fIbridge\fR on standard output,
 297 one per line.  The local port \fIbridge\fR is not included in the
 298 list.
 299 .
 300 .IP "\fBiface\-to\-br \fIiface\fR"
 301 Prints the name of the bridge that contains \fIiface\fR on standard
 302 output.
 303 .
 304 .SS "OpenFlow Controller Connectivity"
 305 .
 306 \fBovs\-vswitchd\fR can perform all configured bridging and switching
 307 locally, or it can be configured to connect a given bridge to one or
 308 more external OpenFlow controllers, such as NOX.
 309 .
 310 For each of these commands, a \fIbridge\fR of \fBdefault\fR applies
 311 the configuration as the default for any bridge that has not been
 312 explicitly configured.  Otherwise, \fIbridge\fR must name a bridge,
 313 and the settings apply only to that bridge.  (Omitting \fIbridge\fR
 314 entirely usually has the same effect as specifying \fBdefault\fR.)
 315 .
 316 .IP "\fBget\-controller\fR [\fIbridge\fR]"
 317 Prints the configured controller target.
 318 .
 319 .IP "\fBdel\-controller\fR [\fIbridge\fR]"
 320 Deletes the configured controller target.
 321 .
 322 .IP "\fBset\-controller\fR [\fIbridge\fR] \fItarget\fR\&..."
 323 Sets the configured controller target or targets.  If more than one
 324 \fItarget\fR is specified, then \fIbridge\fR may not be omitted.  Each
 325 \fItarget\fR may use any of the following forms:
 326 .
 327 .RS
 328 .so lib/vconn-active.man
 329 .RE
 330 .
 331 .ST "Controller Failure Settings"
 332 .PP
 333 When a controller is configured, it is, ordinarily, responsible for
 334 setting up all flows on the switch.  Thus, if the connection to
 335 the controller fails, no new network connections can be set up.  If
 336 the connection to the controller stays down long enough, no packets
 337 can pass through the switch at all.
 338 .PP
 339 If the value is \fBstandalone\fR, or if neither of these settings
 340 is set, \fBovs\-vswitchd\fR will take over
 341 responsibility for setting up
 342 flows when no message has been received from the controller for three
 343 times the inactivity probe interval (xxx needs to be exposed).  In this mode,
 344 \fBovs\-vswitchd\fR causes the datapath to act like an ordinary
 345 MAC-learning switch.  \fBovs\-vswitchd\fR will continue to retry connecting
 346 to the controller in the background and, when the connection succeeds,
 347 it discontinues its standalone behavior.
 348 .PP
 349 If this option is set to \fBsecure\fR, \fBovs\-vswitchd\fR will not
 350 set up flows on its own when the controller connection fails.
 351 .
 352 .IP "\fBget\-fail\-mode\fR [\fIbridge\fR]"
 353 Prints the configured failure mode.
 354 .
 355 .IP "\fBdel\-fail\-mode\fR [\fIbridge\fR]"
 356 Deletes the configured failure mode.
 357 .
 358 .IP "\fBset\-fail\-mode\fR [\fIbridge\fR] \fBstandalone\fR|\fBsecure\fR"
 359 Sets the configured failure mode.
 360 .
 361 .SS "SSL Configuration"
 362 When \fBovs\-vswitchd\fR is configured to connect over SSL for management or
 363 controller connectivity, the following parameters are required:
 364 .TP
 365 \fBprivate-key\fR
 366 Specifies a PEM file containing the private key used as the virtual
 367 switch's identity for SSL connections to the controller.
 368 .TP
 369 \fBcertificate\fR
 370 Specifies a PEM file containing a certificate, signed by the
 371 certificate authority (CA) used by the controller and manager, that
 372 certifies the virtual switch's private key, identifying a trustworthy
 373 switch.
 374 .TP
 375 \fBca-cert\fR
 376 Specifies a PEM file containing the CA certificate used to verify that
 377 the virtual switch is connected to a trustworthy controller.
 378 .PP
 379 These files are read only once, at \fBovs\-vswitchd\fR startup time.  If
 380 their contents change, \fBovs\-vswitchd\fR must be killed and restarted.
 381 .PP
 382 These SSL settings apply to all SSL connections made by the virtual
 383 switch.
 384 .
 385 .IP "\fBget\-ssl\fR"
 386 Prints the SSL configuration.
 387 .
 388 .IP "\fBdel\-ssl\fR"
 389 Deletes the current SSL configuration.
 390 .
 391 .IP "[\fB\-\-bootstrap\fR] \fBset\-ssl\fR \fIprivate-key\fR \fIcertificate\fR \fIca-cert\fR"
 392 Sets the SSL configuration.  The \fB\-\-bootstrap\fR option is described
 393 below.
 394 .
 395 .ST "CA Certificate Bootstrap"
 396 .PP
 397 Ordinarily, all of the files named in the SSL configuration must exist
 398 when \fBovs\-vswitchd\fR starts.  However, if the \fB\-\-bootstrap\fR
 399 option is given, then \fBovs\-vswitchd\fR will attempt to obtain the
 400 CA certificate from the controller on its first SSL connection and
 401 save it to the named PEM file.  If it is successful, it will
 402 immediately drop the connection and reconnect, and from then on all
 403 SSL connections must be authenticated by a certificate signed by the
 404 CA certificate thus obtained.
 405 .PP
 406 \fBThis option exposes the SSL connection to a man-in-the-middle
 407 attack obtaining the initial CA certificate\fR, but it may be useful
 408 for bootstrapping.
 409 .PP
 410 This option is only useful if the controller sends its CA certificate
 411 as part of the SSL certificate chain.  The SSL protocol does not
 412 require the controller to send the CA certificate, but
 413 \fBcontroller\fR(8) can be configured to do so with the
 414 \fB--peer-ca-cert\fR option.
 415 .
 416 .SS "Database Commands"
 417 .
 418 These commands query and modify the contents of \fBovsdb\fR tables.
 419 They are a slight abstraction of the \fBovsdb\fR interface and as such
 420 they operate at a lower level than other \fBovs\-vsctl\fR commands.
 421 .PP
 422 .ST "Identifying Tables, Records, and Columns"
 423 .PP
 424 Each of these commands has a \fItable\fR parameter to identify a table
 425 within the database.  Many of them also take a \fIrecord\fR parameter
 426 that identifies a particular record within a table.  The \fIrecord\fR
 427 parameter may be the UUID for a record, and many tables offer
 428 additional ways to identify records.  Some commands also take
 429 \fIcolumn\fR parameters that identify a particular field within the
 430 records in a table.
 431 .PP
 432 The following tables are currently defined:
 433 .IP "\fBOpen_vSwitch\fR"
 434 Global configuration for an \fBovs\-vswitchd\fR.  This table contains
 435 exactly one record, identified by specifying \fB.\fR as the record
 436 name.
 437 .IP "\fBBridge\fR"
 438 Configuration for a bridge within an Open vSwitch.  Records may be
 439 identified by bridge name.
 440 .IP "\fBPort\fR"
 441 A bridge port.  Records may be identified by port name.
 442 .IP "\fBInterface\fR"
 443 A network device attached to a port.  Records may be identified by
 444 name.
 445 .IP "\fBMirror\fR"
 446 A port mirroring configuration attached to a bridge.  Records may be
 447 identified by mirror name.
 448 .IP "\fBController\fR"
 449 Configuration for an OpenFlow controller.  A controller attached to a
 450 particular bridge may be identified by the bridge's name.  The default
 451 controller controller for an Open vSwitch may be identified by
 452 specifying \fB.\fR as the record name.
 453 .IP "\fBNetFlow\fR"
 454 A NetFlow configuration attached to a bridge.  Records may be
 455 identified by bridge name.
 456 .IP "\fBSSL\fR"
 457 The global SSL configuration for \fBovs\-vswitchd\fR.  The record
 458 attached to the \fBOpen_vSwitch\fR table may be identified by
 459 specifying \fB.\fR as the record name.
 460 .IP "\fBsFlow\fR"
 461 An sFlow configuration attached to a bridge.  Records may be
 462 identified by bridge name.
 463 .PP
 464 Names of tables, records, and columns are not case-sensitive, and
 465 \fB--\fR and \fB_\fR are treated interchangeably.  Unique
 466 abbreviations are acceptable, e.g. \fBnet\fR or \fBn\fR is sufficient
 467 to identify the \fBNetFlow\fR table.
 468 .
 469 .ST "Database Values"
 470 .PP
 471 Each column in the database accepts a fixed type of data.  The
 472 currently defined basic types, and their representations, are:
 473 .IP "integer"
 474 A decimal integer in the range \-2**63 to 2**63\-1, inclusive.
 475 .IP "real"
 476 A floating-point number.
 477 .IP "Boolean"
 478 True or false, written \fBtrue\fR or \fBfalse\fR, respectively.
 479 .IP "string"
 480 An arbitrary Unicode string, except that null bytes are not allowed.
 481 Quotes are optional for most strings that begin with an English letter
 482 or underscore and consist only of letters, underscores, hyphens, and
 483 periods.  However, \fBtrue\fR and \fBfalse\fR and strings that match
 484 the syntax of UUIDs (see below) must be enclosed in double quotes to
 485 distinguish them from other basic types.  When double quotes are used,
 486 the syntax is that of strings in JSON, e.g. backslashes may be used to
 487 escape special characters.  The empty string must be represented as a
 488 pair of double quotes (\fB""\fR).
 489 .IP "UUID"
 490 Either a universally unique identifier in the style of RFC 4122,
 491 e.g. \fBf81d4fae\-7dec\-11d0\-a765\-00a0c91e6bf6\fR, or an \fB@\fIname\fR
 492 defined by the \fBcreate\fR command within the same \fBovs\-vsctl\fR
 493 invocation.
 494 .PP
 495 Multiple values in a single column may be separated by spaces or a
 496 single comma.  When multiple values are present, duplicates are not
 497 allowed, and order is not important.  Conversely, some database
 498 columns can have an empty set of values, represented as \fB[]\fR, and
 499 square brackets may optionally enclose other non-empty sets or single
 500 values as well.
 501 .PP
 502 A few database columns are ``maps'' of key-value pairs, where the key
 503 and the value are each some fixed database type.  These are specified
 504 in the form \fIkey\fB=\fIvalue\fR, where \fIkey\fR and \fIvalue\fR
 505 follow the syntax for the column's key type and value type,
 506 respectively.  When multiple pairs are present (separated by spaces or
 507 a comma), duplicate keys are not allowed, and again the order is not
 508 important.  Duplicate values are allowed.  An empty map is represented
 509 as \fB{}\fR, and curly braces may be optionally enclose non-empty maps
 510 as well.
 511 .
 512 .ST "Database Command Syntax"
 513 .IP "\fBlist \fItable \fR[\fIrecord\fR]..."
 514 List the values of all columns of each specified \fIrecord\fR.  If no
 515 records are specified, lists all the records in \fItable\fR.
 516 .IP
 517 The UUIDs shown for rows created in the same \fBovs\-vsctl\fR
 518 invocation will be wrong.
 519 .
 520 .IP "[\fB\-\-if\-exists\fR] \fBget \fItable record column\fR[\fB:\fIkey\fR]..."
 521 Prints the value of each specified \fIcolumn\fR in the given
 522 \fIrecord\fR in \fItable\fR.  For map columns, a \fIkey\fR may
 523 optionally be specified, in which case the value associated with
 524 \fIkey\fR in the column is printed, instead of the entire map.
 525 .IP
 526 For a map column, without \fB\-\-if\-exists\fR it is an error if
 527 \fIkey\fR does not exist; with it, a blank line is printed.  If
 528 \fIcolumn\fR is not a map column or if \fIkey\fR is not specified,
 529 \fB\-\-if\-exists\fR has no effect.
 530 .
 531 .IP "\fBset \fItable record column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
 532 Sets the value of each specified \fIcolumn\fR in the given
 533 \fIrecord\fR in \fItable\fR to \fIvalue\fR.  For map columns, a
 534 \fIkey\fR may optionally be specified, in which case the value
 535 associated with \fIkey\fR in that column is changed (or added, if none
 536 exists), instead of the entire map.
 537 .
 538 .IP "\fBadd \fItable record column \fR[\fIkey\fB=\fR]\fIvalue\fR..."
 539 Adds the specified value or key-value pair to \fIcolumn\fR in
 540 \fIrecord\fR in \fItable\fR.  If \fIcolumn\fR is a map, then \fIkey\fR
 541 is required, otherwise it is prohibited.  If \fIkey\fR already exists
 542 in a map column, then the current \fIvalue\fR is not replaced (use the
 543 \fBset\fR command to replace an existing value).
 544 .
 545 .IP "\fBremove \fItable record column \fR\fIvalue\fR..."
 546 .IQ "\fBremove \fItable record column \fR\fIkey\fR..."
 547 .IQ "\fBremove \fItable record column \fR\fIkey\fB=\fR\fIvalue\fR..."
 548 Removes the specified values or key-value pairs from \fIcolumn\fR in
 549 \fIrecord\fR in \fItable\fR.  The first form applies to columns that
 550 are not maps: each specified \fIvalue\fR is removed from the column.
 551 The second and third forms apply to map columns: if only a \fIkey\fR
 552 is specified, then any key-value pair with the given \fIkey\fR is
 553 removed, regardless of its value; if a \fIvalue\fR is given then a
 554 pair is removed only if both key and value match.
 555 .IP
 556 It is not an error if the column does not contain the specified key or
 557 value or pair.
 558 .
 559 .IP "\fBclear\fR \fItable record column\fR..."
 560 Sets each \fIcolumn\fR in \fIrecord\fR in \fItable\fR to the empty set
 561 or empty map, as appropriate.  This command applies only to columns
 562 that are allowed to be empty.
 563 .
 564 .IP "[\fB--id=@\fIname\fR] \fBcreate\fR \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
 565 Creates a new record in \fItable\fR and sets the initial values of
 566 each \fIcolumn\fR.  Columns not explicitly set will receive their
 567 default values.  Outputs the UUID of the new row.
 568 .IP
 569 If \fB@\fIname\fR is specified, then the UUID for the new row may be
 570 referred to by that name elsewhere in the same \fBovs\-vsctl\fR
 571 invocation in contexts where a UUID is expected.  Such references may
 572 precede or follow the \fBcreate\fR command.
 573 .
 574 .IP "\fR[\fB\-\-if\-exists\fR] \fBdestroy \fItable record\fR..."
 575 Deletes each specified \fIrecord\fR from \fItable\fR.  Unless
 576 \fB\-\-if\-exists\fR is specified, each \fIrecord\fRs must exist.
 577 .SH "EXAMPLES"
 578 Create a new bridge named br0 and add port eth0 to it:
 579 .IP
 580 .B "ovs-vsctl add\-br br0"
 581 .br
 582 .B "ovs-vsctl add\-port br0 eth0"
 583 .PP
 584 Alternatively, perform both operations in a single atomic transaction:
 585 .IP
 586 .B "ovs-vsctl add\-br br0 \-\- add\-port br0 eth0"
 587 .PP
 588 Delete bridge \fBbr0\fR, reporting an error if it does not exist:
 589 .IP
 590 .B "ovs\-vsctl del\-br br0"
 591 .PP
 592 Delete bridge \fBbr0\fR if it exists (the \fB\-\-\fR is required to
 593 separate \fBdel\-br\fR's options from the global options):
 594 .IP
 595 .B "ovs\-vsctl \-\- \-\-if\-exists del\-br br0"
 596 .PP
 597 Set the \fBqos\fR column of the \fBPort\fR record for \fBeth0\fR to
 598 point to a new \fBQoS\fR record, which in turn points with its queue 0
 599 to a new \fBQueue\fR record:
 600 .IP
 601 .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"
 602 .
 603 .SH "EXIT STATUS"
 604 .IP "0"
 605 Successful program execution.
 606 .IP "1"
 607 Usage, syntax, or configuration file error.
 608 .IP "2"
 609 The \fIbridge\fR argument to \fBbr\-exists\fR specified the name of a
 610 bridge that does not exist.
 611 .SH "SEE ALSO"
 612 .
 613 .BR ovsdb\-server (1),
 614 .BR ovs\-vswitchd (8).
 615 \