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