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