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