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