utilities/ovs-ctl.8

   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\-ctl 8 "June 2011" "Open vSwitch" "Open vSwitch Manual"
  14 .ds PN ovs\-ctl
  15 .
  16 .SH NAME
  17 ovs\-ctl \- OVS startup helper script
  18 .
  19 .SH SYNOPSIS
  20 \fBovs\-ctl\fR \fB\-\-system\-id=random\fR|\fIuuid\fR
  21 [\fIoptions\fR] \fBstart
  22 .br
  23 \fBovs\-ctl stop
  24 .br
  25 \fBovs\-ctl status
  26 .br
  27 \fBovs\-ctl version
  28 .br
  29 \fBovs\-ctl
  30 [\fIoptions\fR]
  31 \fBload\-kmod\fR
  32 .br
  33 \fBovs\-ctl
  34 \fB\-\-system\-id=random\fR|\fIuuid\fR
  35 [\fIoptions\fR]
  36 \fBforce\-reload\-kmod\fR
  37 .br
  38 \fBovs\-ctl
  39 \fR[\fB\-\-protocol=\fIprotocol\fR]
  40 [\fB\-\-sport=\fIsport\fR]
  41 [\fB\-\-dport=\fIdport\fR]
  42 \fBenable\-protocol\fR
  43 .br
  44 \fBovs\-ctl help \fR| \fB\-h \fR| \fB\-\-help
  45 .br
  46 \fBovs\-ctl \-\-version
  47 .
  48 .SH DESCRIPTION
  49 .
  50 .PP
  51 The \fBovs\-ctl\fR program starts, stops, and checks the status of
  52 Open vSwitch daemons.  It is not meant to be invoked directly by
  53 system administrators but to be called internally by system startup
  54 scripts.
  55 .
  56 .PP
  57 Each of \fBovs\-ctl\fR's commands is described separately below.
  58 .
  59 .SH "The ``start'' command"
  60 .
  61 .PP
  62 The \fBstart\fR command starts Open vSwitch.  It performs the
  63 following tasks:
  64 .
  65 .IP 1.
  66 Loads the Open vSwitch kernel module.  If this fails, and the Linux
  67 bridge module is loaded but no bridges exist, it tries to unload the
  68 bridge module and tries loading the Open vSwitch kernel module again.
  69 (This is because the Open vSwitch kernel module cannot coexist with
  70 the Linux bridge module before 2.6.37.)
  71 .
  72 .IP 2.
  73 If \fB\-\-brcompat\fR was specified, loads the Open vSwitch bridge
  74 compatibility module.
  75 .
  76 .PP
  77 The \fBstart\fR command skips the following steps if
  78 \fBovsdb\-server\fR is already running:
  79 .IP 3.
  80 If the Open vSwitch database file does not exist, it creates it.
  81 If the database does exist, but it has an obsolete version, it
  82 upgrades it to the latest schema.
  83 .
  84 .IP 4.
  85 Starts \fBovsdb-server\fR.
  86 .
  87 .IP 5.
  88 Initializes a few values inside the database.
  89 .
  90 .IP 6.
  91 If the \fB\-\-delete\-bridges\fR option was used, deletes all of the
  92 bridges from the database.
  93 .
  94 .PP
  95 The \fBstart\fR command skips the following step if
  96 \fBovs\-vswitchd\fR is already running:
  97 .IP 7.
  98 Starts \fBovs\-vswitchd\fR.
  99 .
 100 .PP
 101 The \fBstart\fR command skips the following step if
 102 \fBovs\-brcompatd\fR is already running or if \fB\-\-brcompat\fR is
 103 not specified:
 104 .IP 8.
 105 Starts \fBovs\-brcompatd\fR.
 106 .
 107 .SS "Options"
 108 .PP
 109 Several command-line options influence the \fBstart\fR command's
 110 behavior.  Some form of the following option should ordinarily be
 111 specified:
 112 .
 113 .IP "\fB\-\-system\-id=\fIuuid\fR"
 114 .IQ "\fB\-\-system\-id=random\fR"
 115 This specifies a unique system identifier to store into
 116 \fBexternal-ids:system-id\fR in the database's \fBOpen_vSwitch\fR
 117 table.  Remote managers that talk to the Open vSwitch database server
 118 over network protocols use this value to identify and distinguish Open
 119 vSwitch instances, so it should be unique (at least) within OVS
 120 instances that will connect to a single controller.
 121 .IP
 122 When \fBrandom\fR is specified, \fBovs\-ctl\fR will generate a random
 123 ID that persists from one run to another (stored in a file).  When
 124 another string is specified \fBovs\-ctl\fR uses it literally.
 125 .
 126 .PP
 127 The following options should be specified if the defaults are not
 128 suitable:
 129 .
 130 .IP "\fB\-\-system\-type=\fItype\fR"
 131 .IQ "\fB\-\-system\-version=\fIversion\fR"
 132 Sets the value to store in the \fBsystem-type\fR and
 133 \fBsystem-version\fR columns, respectively, in the database's
 134 \fBOpen_vSwitch\fR table.  Remote managers may use these values to
 135 determine the kind of system to which they are connected (primarily
 136 for display to human administrators).
 137 .IP
 138 When not specified, \fBovs\-ctl\fR uses values from the optional
 139 \fBsystem\-type.conf\fR and \fBsystem\-version.conf\fR files(see section
 140 \fBFILES\fR) or it uses the \fBlsb_release\fR program, if present, to
 141 provide reasonable defaults.
 142 .
 143 .PP
 144 The following options are also likely to be useful:
 145 .
 146 .IP "\fB\-\-external\-id=\(dq\fIname\fB=\fIvalue\fB\(dq"
 147 Sets \fBexternal-ids:\fIname\fR to \fIvalue\fR in the database's
 148 \fBOpen_vSwitch\fR table.  Specifying this option multiple times adds
 149 multiple key-value pairs.
 150 .
 151 .IP "\fB\-\-delete\-bridges\fR"
 152 Ordinarily Open vSwitch bridges persist from one system boot to the
 153 next, as long as the database is preserved.  Some environments instead
 154 expect to re-create all of the bridges and other configuration state
 155 on every boot.  This option supports that, by deleting all Open
 156 vSwitch bridges after starting \fBovsdb\-server\fR but before starting
 157 \fBovs\-vswitchd\fR.
 158 .
 159 .PP
 160 The following options are less important:
 161 .
 162 .IP "\fB\-\-daemon-cwd=\fIdirectory\fR"
 163 Specifies the current working directory that the OVS daemons should
 164 run from.  The default is \fB/\fR (the root directory) if this option
 165 is not specified.  (This option is useful because most systems create
 166 core files in a process's current working directory and because a file
 167 system that is in use as a process's current working directory cannot
 168 be unmounted.)
 169 .
 170 .IP "\fB\-\-no\-force\-corefiles\fR"
 171 By default, \fBovs\-ctl\fR enables core dumps for the OVS daemons.
 172 This option disables that behavior.
 173 .
 174 .IP "\fB\-\-no\-mlockall\fR"
 175 By default \fBovs\-ctl\fR passes \fB\-\-mlockall\fR to
 176 \fBovs\-vswitchd\fR, requesting that it lock all of its virtual
 177 memory, preventing it from being paged to disk.  This option
 178 suppresses that behavior.
 179 .
 180 .IP "\fB\-\-ovsdb\-server\-priority=\fIniceness\fR"
 181 .IQ "\fB\-\-ovs\-vswitchd\-priority=\fIniceness\fR"
 182 .IQ "\fB\-\-ovs\-brcompatd\-priority=\fIniceness\fR"
 183 Sets the \fBnice\fR(1) level used for each daemon.  All of them
 184 default to \fB\-10\fR.
 185 .
 186 .PP
 187 The following options control file locations.  They should only be
 188 used if the default locations cannot be used.  See \fBFILES\fR, below,
 189 for more information.
 190 .
 191 .IP "\fB\-\-db\-file=\fIfile\fR"
 192 Overrides the file name for the OVS database.
 193 .
 194 .IP "\fB\-\-db\-sock=\fIsocket\fR"
 195 Overrides the file name for the Unix domain socket used to connect to
 196 \fBovsdb\-server\fR.
 197 .
 198 .IP "\fB\-\-db\-schema=\fIschema\fR"
 199 Overrides the file name for the OVS database schema.
 200 .
 201 .SH "The ``stop'' command"
 202 .
 203 .PP
 204 The \fBstop\fR command shuts down Open vSwitch.  It kills any running
 205 \fBovs\-brcompatd\fR, \fBovs\-vswitchd\fR, or \fBovsdb\-server\fR
 206 daemons and waits for them to terminate.
 207 .
 208 .PP
 209 The \fBstop\fR command does not unload the Open vSwitch kernel
 210 modules.
 211 .
 212 .PP
 213 This command does nothing and finishes successfully if the OVS daemons
 214 aren't running.
 215 .
 216 .SH "The ``status'' command"
 217 .
 218 .PP
 219 The \fBstatus\fR command checks whether the OVS daemons
 220 \fBovs-vswitchd\fR and \fBovsdb\-server\fR are running and prints
 221 messages with that information.  If \fB\-\-brcompat\fR is specified,
 222 it also checks for \fBovs\-brcompatd\fR.  It exits with status 0 if
 223 the daemons are running, 1 otherwise.
 224 .
 225 .SH "The ``version'' command"
 226 .
 227 .PP
 228 The \fBversion\fR command runs \fBovsdb\-server \-\-version\fR and
 229 \fBovs\-vswitchd \-\-version\fR.  If \fB\-\-brcompat\fR is specified,
 230 it also runs \fBovs\-brcompatd \-\-version\fR.
 231 .
 232 .SH "The ``force\-reload\-kmod'' command"
 233 .
 234 .PP
 235 The \fBforce\-reload\-kmod\fR command allows upgrading the Open
 236 vSwitch kernel module without rebooting.  It performs the following
 237 tasks:
 238 .
 239 .IP 1.
 240 Gets a list of OVS ``internal'' interfaces, that is, network devices
 241 implemented by Open vSwitch.  The most common examples of these are
 242 bridge ``local ports''.
 243 .
 244 .IP 2.
 245 Stops the Open vSwitch daemons, as if by a call to \fBovs\-ctl
 246 stop\fR.
 247 .
 248 .IP 3.
 249 Saves the kernel configuration state of the OVS internal interfaces
 250 listed in step 1, including IP and IPv6 addresses and routing table
 251 entries.
 252 .
 253 .IP 4.
 254 Unloads the Open vSwitch kernel module (including the bridge
 255 compatibility module if it is loaded).
 256 .
 257 .IP 5.
 258 Starts OVS back up, as if by a call to \fBovs\-ctl start\fR.  This
 259 reloads the kernel module and restarts the OVS daemons (including
 260 \fBovs\-brcompatd\fR, if \fB\-\-brcompat\fR is specified).
 261 .
 262 .IP 6.
 263 Restores the kernel configuration state that was saved in step 3.
 264 .
 265 .IP 7.
 266 Checks for daemons that may need to be restarted because they have
 267 packet sockets that are listening on old instances of Open vSwitch
 268 kernel interfaces and, if it finds any, prints a warning on stdout.
 269 DHCP is a common example: if the ISC DHCP client is running on an OVS
 270 internal interface, then it will have to be restarted after completing
 271 the above procedure.  (It would be nice if \fBovs\-ctl\fR could restart
 272 daemons automatically, but the details are far too specific to a
 273 particular distribution and installation.)
 274 .
 275 .PP
 276 \fBforce\-kmod\-reload\fR internally stops and starts OVS, so it
 277 accepts all of the options accepted by the \fBstart\fR command.
 278 .
 279 .SH "The ``load\-kmod'' command"
 280 .
 281 .PP
 282 The \fBload\-kmod\fR command loads the openvswitch kernel modules if
 283 they are not already loaded. This operation also occurs as part of
 284 the \fBstart\fR command. The motivation for providing the \fBload\-kmod\fR
 285 command is to allow errors when loading modules to be handled separatetly
 286 from other errors that may occur when running the \fBstart\fR command.
 287 .
 288 .PP
 289 By default the \fBload\-kmod\fR command attempts to load the
 290 openvswitch kernel module. If the \fB\-\-brcompat\fR option is
 291 specified then the brcompat kernel module is also loaded.
 292 .
 293 .SH "The ``enable\-protocol'' command"
 294 .
 295 .PP
 296 The \fBenable\-protocol\fR command checks for rules related to a
 297 specified protocol in the system's \fBiptables\fR(8) configuration.  If there
 298 are no rules specifically related to that protocol, then it inserts a
 299 rule to accept the specified protocol.
 300 .
 301 .PP
 302 More specifically:
 303 .
 304 .IP \(bu
 305 If \fBiptables\fR is not installed or not enabled, this command does
 306 nothing, assuming that lack of filtering means that the protocol is
 307 enabled.
 308 .
 309 .IP \(bu
 310 If the \fBINPUT\fR chain has a rule that matches the specified
 311 protocol, then this command does nothing, assuming that whatever rule
 312 is installed reflects the system administrator's decisions.
 313 .
 314 .IP \(bu
 315 Otherwise, this command installs a rule that accepts traffic of the
 316 specified protocol.
 317 .
 318 .PP
 319 This command normally completes successfully, even if it does
 320 nothing.  Only the failure of an attempt to insert a rule normally
 321 causes it to return an exit code other than 0.
 322 .
 323 The following options control the protocol to be enabled:
 324 .
 325 .IP "\fB\-\-protocol=\fIprotocol\fR"
 326 The name of the IP protocol to be enabled, such as \fBgre\fR or
 327 \fBtcp\fR.  The default is \fBgre\fR.
 328 .
 329 .IP "\fB\-\-sport=\fIsport\fR"
 330 .IQ "\fB\-\-dport=\fIdport\fR"
 331 TCP or UDP source or destination port to match.  These are optional
 332 and allowed only with \fB\-\-protocol=tcp\fR or
 333 \fB\-\-protocol=udp\fR.
 334 .
 335 .SH "The ``help'' command"
 336 .
 337 Prints a usage message and exits successfully.
 338 .
 339 .SH "OPTIONS"
 340 .PP
 341 In addition to the options listed for each command above, this option
 342 controls the behavior of several of \fBovs\-ctl\fR's commands.
 343 .
 344 .IP "\fB\-\-brcompat\fR"
 345 By default, \fBovs\-ctl\fR does not load the Open vSwitch bridge
 346 compatibility module and does not start or check the status or report
 347 the version of the \fBovs\-brcompatd\fR daemon.  This option enables
 348 all of those behaviors.
 349 .
 350 .IP
 351 The \fBstop\fR command always stops \fBovs\-brcompatd\fR, if it is
 352 running, regardless of this option.
 353 .
 354 .SH "EXIT STATUS"
 355 .
 356 \fBovs\-ctl\fR exits with status 0 on success and nonzero on failure.
 357 The \fBstart\fR command is considered to succeed if OVS is already
 358 started; the \fBstop\fR command is considered to succeed if OVS is
 359 already stopped.
 360 .
 361 .SH "ENVIRONMENT"
 362 .
 363 The following environment variables affect \fBovs\-ctl\fR:
 364 .
 365 .IP "\fBPATH\fR"
 366 \fBovs\-ctl\fR does not hardcode the location of any of the programs
 367 that it runs.  \fBovs\-ctl\fR will add the \fIsbindir\fR and
 368 \fIbindir\fR that were specified at \fBconfigure\fR time to
 369 \fBPATH\fR, if they are not already present.
 370 .
 371 .IP "\fBOVS_LOGDIR\fR"
 372 .IQ "\fBOVS_RUNDIR\fR"
 373 .IQ "\fBOVS_SYSCONFDIR\fR"
 374 .IQ "\fBOVS_PKGDATADIR\fR"
 375 .IQ "\fBOVS_BINDIR\fR"
 376 .IQ "\fBOVS_SBINDIR\fR"
 377 Setting one of these variables in the environment overrides the
 378 respective \fBconfigure\fR option, both for \fBovs\-ctl\fR itself and
 379 for the other Open vSwitch programs that it runs.
 380 .
 381 .SH "FILES"
 382 .
 383 \fBovs\-ctl\fR uses the following files:
 384 .
 385 .IP "\fBovs\-lib.sh"
 386 Shell function library used internally by \fBovs\-ctl\fR.  It must be
 387 installed in the same directory as \fBovs\-ctl\fR.
 388 .
 389 .IP "\fIlogdir\fB/\fIdaemon\fB.log\fR"
 390 Per-daemon logfiles.
 391 .
 392 .IP "\fIrundir\fB/\fIdaemon\fB.pid\fR"
 393 Per-daemon pidfiles to track whether a daemon is running and with what
 394 process ID.
 395 .
 396 .IP "\fIpkgdatadir\fB/vswitch.ovsschema\fR"
 397 The OVS database schema used to initialize the database (use
 398 \fB\-\-db\-schema to override this location).
 399 .
 400 .IP "\fIsysconfdir\fB/openvswitch/conf.db\fR"
 401 The OVS database (use \fB\-\-db\-file\fR to override this location).
 402 .
 403 .IP "\fIrundir\fB/openvswitch/db.sock\fR"
 404 The Unix domain socket used for local communication with
 405 \fBovsdb\-server\fR (use \fB\-\-db\-sock\fR to override this
 406 location).
 407 .
 408 .IP "\fIsysconfdir\fB/openvswitch/system-id.conf\fR"
 409 The persistent system UUID created and read by
 410 \fB\-\-system\-id=random\fR.
 411 .
 412 .IP "\fIsysconfdir\fB/openvswitch/system\-type.conf\fR"
 413 .IQ "\fIsysconfdir\fB/openvswitch/system\-version.conf\fR"
 414 The \fBsystem\-type\fR  and \fBsystem\-version\fR values stored in the database's
 415 \fBOpen_vSwitch\fR table when not specified as a command-line option.
 416 .
 417 .SH "EXAMPLE"
 418 .
 419 .PP
 420 The files \fBdebian/openvswitch\-switch.init\fR and
 421 \fBxenserver/etc_init.d_openvswitch\fR in the Open vSwitch source
 422 distribution are good examples of how to use \fBovs\-ctl\fR.
 423 .
 424 .SH "SEE ALSO"
 425 .
 426 \fBREADME\fR, \fBINSTALL.Linux\fR, \fBovsdb\-server\fR(8),
 427 \fBovs\-vswitchd\fR(8).