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 "\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 .
 139 .IP "\fBadd\-br \fIbridge parent vlan\fR"
 140 Creates a ``fake bridge'' named \fIbridge\fR within the existing Open
 141 vSwitch bridge \fIparent\fR, which must already exist and must not
 142 itself be a fake bridge.  The new fake bridge will be on 802.1Q VLAN
 143 \fIvlan\fR, which must be an integer between 1 and 4095.  Initially
 144 \fIbridge\fR will have no ports (other than \fIbridge\fR itself).
 145 .
 146 .IP "[\fB\-\-if\-exists\fR] \fBdel\-br \fIbridge\fR"
 147 Deletes \fIbridge\fR and all of its ports.  If \fIbridge\fR is a real
 148 bridge, this command also deletes any fake bridges that were created
 149 with \fIbridge\fR as parent, including all of their ports.
 150 .IP
 151 Without \fB\-\-if\-exists\fR, attempting to delete a bridge that does
 152 not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
 153 delete a bridge that does not exist has no effect.
 154 .
 155 .IP "\fBlist\-br\fR"
 156 Lists all existing real and fake bridges on standard output, one per
 157 line.
 158 .
 159 .IP "\fBbr\-exists \fIbridge\fR"
 160 Tests whether \fIbridge\fR exists as a real or fake bridge.  If so,
 161 \fBovs\-vsctl\fR exits successfully with exit code 0.  If not,
 162 \fBovs\-vsctl\fR exits unsuccessfully with exit code 2.
 163 .
 164 .IP "\fBbr\-to\-vlan \fIbridge\fR"
 165 If \fIbridge\fR is a fake bridge, prints the bridge's 802.1Q VLAN as a
 166 decimal integer.  If \fIbridge\fR is a real bridge, prints 0.
 167 .
 168 .IP "\fBbr\-to\-parent \fIbridge\fR"
 169 If \fIbridge\fR is a fake bridge, prints the name of its parent
 170 bridge.  If \fIbridge\fR is a real bridge, print \fIbridge\fR.
 171 .
 172 .IP "\fBbr\-set\-external\-id \fIbridge key\fR [\fIvalue\fR]"
 173 Sets or clears an ``external ID'' value on \fIbridge\fR.  These values
 174 are intended to identify entities external to Open vSwitch with which
 175 \fIbridge\fR is associated, e.g. the bridge's identifier in a
 176 virtualization management platform.  The Open vSwitch database schema
 177 specifies well-known \fIkey\fR values, but \fIkey\fR and \fIvalue\fR
 178 are otherwise arbitrary strings.
 179 .IP
 180 If \fIvalue\fR is specified, then \fIkey\fR is set to \fIvalue\fR for
 181 \fIbridge\fR, overwriting any previous value.  If \fIvalue\fR is
 182 omitted, then \fIkey\fR is removed from \fIbridge\fR's set of external
 183 IDs (if it was present).
 184 .
 185 .IP "\fBbr\-get\-external\-id \fIbridge\fR [\fIkey\fR]"
 186 Queries the external IDs on \fIbridge\fR.  If \fIkey\fR is specified,
 187 the output is the value for that \fIkey\fR or the empty string if
 188 \fIkey\fR is unset.  If \fIkey\fR is omitted, the output is
 189 \fIkey\fB=\fIvalue\fR, one per line, for each key-value pair.
 190 .
 191 .SS "Port Commands"
 192 .
 193 These commands examine and manipulate Open vSwitch ports.  These
 194 commands treat a bonded port as a single entity.
 195 .
 196 .IP "\fBlist\-ports \fIbridge\fR"
 197 Lists all of the ports within \fIbridge\fR on standard output, one per
 198 line.  The local port \fIbridge\fR is not included in the list.
 199 .
 200 .IP "\fBadd\-port \fIbridge port\fR"
 201 Creates on \fIbridge\fR a new port named \fIport\fR from the network
 202 device of the same name.
 203 .
 204 .IP "\fBadd\-bond \fIbridge port iface\fR\&..."
 205 Creates on \fIbridge\fR a new port named \fIport\fR that bonds
 206 together the network devices given as each \fIiface\fR.  At least two
 207 interfaces must be named.
 208 .
 209 .IP "[\fB\-\-if\-exists\fR] \fBdel\-port \fR[\fIbridge\fR] \fIport\fR"
 210 Deletes \fIport\fR.  If \fIbridge\fR is omitted, \fIport\fR is removed
 211 from whatever bridge contains it; if \fIbridge\fR is specified, it
 212 must be the real or fake bridge that contains \fIport\fR.
 213 .IP
 214 Without \fB\-\-if\-exists\fR, attempting to delete a port that does
 215 not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
 216 delete a port that does not exist has no effect.
 217 .
 218 .IP "\fBport\-to\-br \fIport\fR"
 219 Prints the name of the bridge that contains \fIport\fR on standard
 220 output.
 221 .
 222 .IP "\fBport\-set\-external\-id \fIport key\fR [\fIvalue\fR]"
 223 Sets or clears an ``external ID'' value on \fIport\fR.  These value
 224 are intended to identify entities external to Open vSwitch with which
 225 \fIport\fR is associated, e.g. the port's identifier in a
 226 virtualization management platform.  The Open vSwitch database schema
 227 specifies well-known \fIkey\fR values, but \fIkey\fR and \fIvalue\fR
 228 are otherwise arbitrary strings.
 229 .IP
 230 If \fIvalue\fR is specified, then \fIkey\fR is set to \fIvalue\fR for
 231 \fIport\fR, overwriting any previous value.  If \fIvalue\fR is
 232 omitted, then \fIkey\fR is removed from \fIport\fR's set of external
 233 IDs (if it was present).
 234 .
 235 .IP "\fBbr\-get\-external\-id \fIport\fR [\fIkey\fR]"
 236 Queries the external IDs on \fIport\fR.  If \fIkey\fR is specified,
 237 the output is the value for that \fIkey\fR or the empty string if
 238 \fIkey\fR is unset.  If \fIkey\fR is omitted, the output is
 239 \fIkey\fB=\fIvalue\fR, one per line, for each key-value pair.
 240 .
 241 .SS "Interface Commands"
 242 .
 243 These commands examine the interfaces attached to an Open vSwitch
 244 bridge.  These commands treat a bonded port as a collection of two or
 245 more interfaces, rather than as a single port.
 246 .
 247 .IP "\fBlist\-ifaces \fIbridge\fR"
 248 Lists all of the interfaces within \fIbridge\fR on standard output,
 249 one per line.  The local port \fIbridge\fR is not included in the
 250 list.
 251 .
 252 .IP "\fBiface\-to\-br \fIiface\fR"
 253 Prints the name of the bridge that contains \fIiface\fR on standard
 254 output.
 255 .
 256 .IP "\fBiface\-set\-external\-id \fIiface key\fR [\fIvalue\fR]"
 257 Sets or clears an ``external ID'' value on \fIiface\fR.  These value
 258 are intended to identify entities external to Open vSwitch with which
 259 \fIiface\fR is associated, e.g. the interface's identifier in a
 260 virtualization management platform.  The Open vSwitch database schema
 261 specifies well-known \fIkey\fR values, but \fIkey\fR and \fIvalue\fR
 262 are otherwise arbitrary strings.
 263 .IP
 264 If \fIvalue\fR is specified, then \fIkey\fR is set to \fIvalue\fR for
 265 \fIiface\fR, overwriting any previous value.  If \fIvalue\fR is
 266 omitted, then \fIkey\fR is removed from \fIiface\fR's set of external
 267 IDs (if it was present).
 268 .
 269 .IP "\fBbr\-get\-external\-id \fIiface\fR [\fIkey\fR]"
 270 Queries the external IDs on \fIiface\fR.  If \fIkey\fR is specified,
 271 the output is the value for that \fIkey\fR or the empty string if
 272 \fIkey\fR is unset.  If \fIkey\fR is omitted, the output is
 273 \fIkey\fB=\fIvalue\fR, one per line, for each key-value pair.
 274 .
 275 .SS "OpenFlow Controller Connectivity"
 276 .
 277 \fBovs\-vswitchd\fR can perform all configured bridging and switching
 278 locally, or it can be configured to connect a given bridge to an
 279 external OpenFlow controller, such as NOX.
 280 .
 281 If a \fIbridge\fR argument is given, the settings apply only to the
 282 specified bridge.  Otherwise, they apply to the Open vSwitch instance,
 283 and its configuration applies to any bridge that has not been explicitly
 284 configured through a \fIbridge\fR argument.
 285 .
 286 .IP "\fBget\-controller\fR [\fIbridge\fR]"
 287 Prints the configured controller target.
 288 .
 289 .IP "\fBdel\-controller\fR [\fIbridge\fR]"
 290 Deletes the configured controller target.
 291 .
 292 .IP "\fBset\-controller\fR [\fIbridge\fR] \fItarget\fR"
 293 Sets the configured controller target.  The \fItarget\fR may use any of
 294 the following forms:
 295 .
 296 .RS
 297 .TP
 298 .so lib/vconn-active.man
 299 .RE
 300 .
 301 .ST "Controller Failure Settings"
 302 .
 303 When a controller is configured, it is, ordinarily, responsible for
 304 setting up all flows on the switch.  Thus, if the connection to
 305 the controller fails, no new network connections can be set up.  If
 306 the connection to the controller stays down long enough, no packets
 307 can pass through the switch at all.
 308 .ST
 309 If the value is \fBstandalone\fR, or if neither of these settings
 310 is set, \fBovs\-vswitchd\fR will take over
 311 responsibility for setting up
 312 flows when no message has been received from the controller for three
 313 times the inactivity probe interval (xxx needs to be exposed).  In this mode,
 314 \fBovs\-vswitchd\fR causes the datapath to act like an ordinary
 315 MAC-learning switch.  \fBovs\-vswitchd\fR will continue to retry connecting
 316 to the controller in the background and, when the connection succeeds,
 317 it discontinues its standalone behavior.
 318 .ST
 319 If this option is set to \fBsecure\fR, \fBovs\-vswitchd\fR will not
 320 set up flows on its own when the controller connection fails.
 321 .
 322 .IP "\fBget\-fail\-mode\fR [\fIbridge\fR]"
 323 Prints the configured failure mode.
 324 .
 325 .IP "\fBdel\-fail\-mode\fR [\fIbridge\fR]"
 326 Deletes the configured failure mode.
 327 .
 328 .IP "\fBset\-fail\-mode\fR [\fIbridge\fR] \fBstandalone\fR|\fBsecure\fR"
 329 Sets the configured failure mode.
 330 .
 331 .SS "SSL Configuration"
 332 When \fBovs\-vswitchd\fR is configured to connect over SSL for management or
 333 controller connectivity, the following parameters are required:
 334 .TP
 335 \fBprivate-key\fR
 336 Specifies a PEM file containing the private key used as the virtual
 337 switch's identity for SSL connections to the controller.
 338 .TP
 339 \fBcertificate\fR
 340 Specifies a PEM file containing a certificate, signed by the
 341 certificate authority (CA) used by the controller and manager, that
 342 certifies the virtual switch's private key, identifying a trustworthy
 343 switch.
 344 .TP
 345 \fBca-cert\fR
 346 Specifies a PEM file containing the CA certificate used to verify that
 347 the virtual switch is connected to a trustworthy controller.
 348 .PP
 349 These files are read only once, at \fBovs\-vswitchd\fR startup time.  If
 350 their contents change, \fBovs\-vswitchd\fR must be killed and restarted.
 351 .PP
 352 These SSL settings apply to all SSL connections made by the virtual
 353 switch.
 354 .
 355 .IP "\fBget\-ssl\fR"
 356 Prints the SSL configuration.
 357 .
 358 .IP "\fBdel\-ssl\fR"
 359 Deletes the current SSL configuration.
 360 .
 361 .IP "[\fB\-\-bootstrap\fR] \fBset\-ssl\fR \fIprivate-key\fR \fIcertificate\fR \fIca-cert\fR"
 362 Sets the SSL configuration.  The \fB\-\-bootstrap\fR option is described
 363 below.
 364 .
 365 .ST "CA Certificate Bootstrap"
 366 Ordinarily, all of the files named in the SSL configuration must exist
 367 when \fBovs\-vswitchd\fR starts.  However, if the \fB\-\-bootstrap\fR
 368 option is given, then \fBovs\-vswitchd\fR will attempt to obtain the
 369 CA certificate from the controller on its first SSL connection and
 370 save it to the named PEM file.  If it is successful, it will
 371 immediately drop the connection and reconnect, and from then on all
 372 SSL connections must be authenticated by a certificate signed by the
 373 CA certificate thus obtained.
 374 .PP
 375 \fBThis option exposes the SSL connection to a man-in-the-middle
 376 attack obtaining the initial CA certificate\fR, but it may be useful
 377 for bootstrapping.
 378 .PP
 379 This option is only useful if the controller sends its CA certificate
 380 as part of the SSL certificate chain.  The SSL protocol does not
 381 require the controller to send the CA certificate, but
 382 \fBcontroller\fR(8) can be configured to do so with the
 383 \fB--peer-ca-cert\fR option.
 384 .
 385 .SH "EXAMPLES"
 386 Create a new bridge named br0 and add port eth0 to it:
 387 .IP
 388 .B "ovs-vsctl add\-br br0"
 389 .br
 390 .B "ovs-vsctl add\-port br0 eth0"
 391 .PP
 392 Alternatively, perform both operations in a single atomic transaction:
 393 .IP
 394 .B "ovs-vsctl add\-br br0 \-\- add\-port br0 eth0"
 395 .PP
 396 Delete bridge \fBbr0\fR, reporting an error if it does not exist:
 397 .IP
 398 .B "ovs\-vsctl del\-br br0"
 399 .PP
 400 Delete bridge \fBbr0\fR if it exists (the \fB\-\-\fR is required to
 401 separate \fBdel\-br\fR's options from the global options):
 402 .IP
 403 .B "ovs\-vsctl \-\- \-\-if\-exists del\-br br0"
 404 .
 405 .SH "EXIT STATUS"
 406 .IP "0"
 407 Successful program execution.
 408 .IP "1"
 409 Usage, syntax, or configuration file error.
 410 .IP "2"
 411 The \fIbridge\fR argument to \fBbr\-exists\fR specified the name of a
 412 bridge that does not exist.
 413 .SH "SEE ALSO"
 414 .
 415 .BR ovsdb\-server (1),
 416 .BR ovs\-vswitchd (8).