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