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