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 Sets the \fBnice\fR(1) level used for \fBovsdb\-server\fR and
 183 \fBovs\-vswitchd\fR, respectively.  Both default to \fB\-10\fR.
 184 .
 185 .PP
 186 The following options control file locations.  They should only be
 187 used if the default locations cannot be used.  See \fBFILES\fR, below,
 188 for more information.
 189 .
 190 .IP "\fB\-\-db\-file=\fIfile\fR"
 191 Overrides the file name for the OVS database.
 192 .
 193 .IP "\fB\-\-db\-sock=\fIsocket\fR"
 194 Overrides the file name for the Unix domain socket used to connect to
 195 \fBovsdb\-server\fR.
 196 .
 197 .IP "\fB\-\-db\-schema=\fIschema\fR"
 198 Overrides the file name for the OVS database schema.
 199 .
 200 .SH "The ``stop'' command"
 201 .
 202 .PP
 203 The \fBstop\fR command shuts down Open vSwitch.  It kills any running
 204 \fBovs\-brcompatd\fR, \fBovs\-vswitchd\fR, or \fBovsdb\-server\fR
 205 daemons and waits for them to terminate.
 206 .
 207 .PP
 208 The \fBstop\fR command does not unload the Open vSwitch kernel
 209 modules.
 210 .
 211 .PP
 212 This command does nothing and finishes successfully if the OVS daemons
 213 aren't running.
 214 .
 215 .SH "The ``status'' command"
 216 .
 217 .PP
 218 The \fBstatus\fR command checks whether the OVS daemons
 219 \fBovs-vswitchd\fR and \fBovsdb\-server\fR are running and prints
 220 messages with that information.  If \fB\-\-brcompat\fR is specified,
 221 it also checks for \fBovs\-brcompatd\fR.  It exits with status 0 if
 222 the daemons are running, 1 otherwise.
 223 .
 224 .SH "The ``version'' command"
 225 .
 226 .PP
 227 The \fBversion\fR command runs \fBovsdb\-server \-\-version\fR and
 228 \fBovs\-vswitchd \-\-version\fR.  If \fB\-\-brcompat\fR is specified,
 229 it also runs \fBovs\-brcompatd \-\-version\fR.
 230 .
 231 .SH "The ``force\-reload\-kmod'' command"
 232 .
 233 .PP
 234 The \fBforce\-reload\-kmod\fR command allows upgrading the Open
 235 vSwitch kernel module without rebooting.  It performs the following
 236 tasks:
 237 .
 238 .IP 1.
 239 Gets a list of OVS ``internal'' interfaces, that is, network devices
 240 implemented by Open vSwitch.  The most common examples of these are
 241 bridge ``local ports''.
 242 .
 243 .IP 2.
 244 Stops the Open vSwitch daemons, as if by a call to \fBovs\-ctl
 245 stop\fR.
 246 .
 247 .IP 3.
 248 Saves the kernel configuration state of the OVS internal interfaces
 249 listed in step 1, including IP and IPv6 addresses and routing table
 250 entries.
 251 .
 252 .IP 4.
 253 Unloads the Open vSwitch kernel module (including the bridge
 254 compatibility module if it is loaded).
 255 .
 256 .IP 5.
 257 Starts OVS back up, as if by a call to \fBovs\-ctl start\fR.  This
 258 reloads the kernel module and restarts the OVS daemons (including
 259 \fBovs\-brcompatd\fR, if \fB\-\-brcompat\fR is specified).
 260 .
 261 .IP 6.
 262 Restores the kernel configuration state that was saved in step 3.
 263 .
 264 .PP
 265 The steps above are often enough to hot-upgrade a new kernel module
 266 with only a few seconds of downtime.  DHCP is a common problem: if the
 267 ISC DHCP client is running on an OVS internal interface, then it will
 268 have to be restarted after completing the above procedure.
 269 .
 270 .PP
 271 \fBforce\-kmod\-reload\fR internally stops and starts OVS, so it
 272 accepts all of the options accepted by the \fBstart\fR command.
 273 .
 274 .SH "The ``load\-kmod'' command"
 275 .
 276 .PP
 277 The \fBload\-kmod\fR command loads the openvswitch kernel modules if
 278 they are not already loaded. This operation also occurs as part of
 279 the \fBstart\fR command. The motivation for providing the \fBload\-kmod\fR
 280 command is to allow errors when loading modules to be handled separatetly
 281 from other errors that may occur when running the \fBstart\fR command.
 282 .
 283 .PP
 284 By default the \fBload\-kmod\fR command attempts to load the
 285 openvswitch_mod kernel module. If the \fB\-\-brcompat\fR option is
 286 specified then the brcompat_mod kernel module is also loaded.
 287 .
 288 .SH "The ``enable\-protocol'' command"
 289 .
 290 .PP
 291 The \fBenable\-protocol\fR command checks for rules related to a
 292 specified protocol in the system's \fBiptables\fR(8) configuration.  If there
 293 are no rules specifically related to that protocol, then it inserts a
 294 rule to accept the specified protocol.
 295 .
 296 .PP
 297 More specifically:
 298 .
 299 .IP \(bu
 300 If \fBiptables\fR is not installed or not enabled, this command does
 301 nothing, assuming that lack of filtering means that the protocol is
 302 enabled.
 303 .
 304 .IP \(bu
 305 If the \fBINPUT\fR chain has a rule that matches the specified
 306 protocol, then this command does nothing, assuming that whatever rule
 307 is installed reflects the system administrator's decisions.
 308 .
 309 .IP \(bu
 310 Otherwise, this command installs a rule that accepts traffic of the
 311 specified protocol.
 312 .
 313 .PP
 314 This command normally completes successfully, even if it does
 315 nothing.  Only the failure of an attempt to insert a rule normally
 316 causes it to return an exit code other than 0.
 317 .
 318 The following options control the protocol to be enabled:
 319 .
 320 .IP "\fB\-\-protocol=\fIprotocol\fR"
 321 The name of the IP protocol to be enabled, such as \fBgre\fR or
 322 \fBtcp\fR.  The default is \fBgre\fR.
 323 .
 324 .IP "\fB\-\-sport=\fIsport\fR"
 325 .IQ "\fB\-\-dport=\fIdport\fR"
 326 TCP or UDP source or destination port to match.  These are optional
 327 and allowed only with \fB\-\-protocol=tcp\fR or
 328 \fB\-\-protocol=udp\fR.
 329 .
 330 .SH "The ``help'' command"
 331 .
 332 Prints a usage message and exits successfully.
 333 .
 334 .SH "OPTIONS"
 335 .PP
 336 In addition to the options listed for each command above, this option
 337 controls the behavior of several of \fBovs\-ctl\fR's commands.
 338 .
 339 .IP "\fB\-\-brcompat\fR"
 340 By default, \fBovs\-ctl\fR does not load the Open vSwitch bridge
 341 compatibility module and does not start or check the status or report
 342 the version of the \fBovs\-brcompatd\fR daemon.  This option enables
 343 all of those behaviors.
 344 .
 345 .IP
 346 The \fBstop\fR command always stops \fBovs\-brcompatd\fR, if it is
 347 running, regardless of this option.
 348 .
 349 .SH "EXIT STATUS"
 350 .
 351 \fBovs\-ctl\fR exits with status 0 on success and nonzero on failure.
 352 The \fBstart\fR command is considered to succeed if OVS is already
 353 started; the \fBstop\fR command is considered to succeed if OVS is
 354 already stopped.
 355 .
 356 .SH "ENVIRONMENT"
 357 .
 358 The following environment variables affect \fBovs\-ctl\fR:
 359 .
 360 .IP "\fBPATH\fR"
 361 \fBovs\-ctl\fR does not hardcode the location of any of the programs
 362 that it runs.  \fBovs\-ctl\fR will add the \fIsbindir\fR and
 363 \fIbindir\fR that were specified at \fBconfigure\fR time to
 364 \fBPATH\fR, if they are not already present.
 365 .
 366 .IP "\fBOVS_LOGDIR\fR"
 367 .IQ "\fBOVS_RUNDIR\fR"
 368 .IQ "\fBOVS_SYSCONFDIR\fR"
 369 .IQ "\fBOVS_PKGDATADIR\fR"
 370 .IQ "\fBOVS_BINDIR\fR"
 371 .IQ "\fBOVS_SBINDIR\fR"
 372 Setting one of these variables in the environment overrides the
 373 respective \fBconfigure\fR option, both for \fBovs\-ctl\fR itself and
 374 for the other Open vSwitch programs that it runs.
 375 .
 376 .SH "FILES"
 377 .
 378 \fBovs\-ctl\fR uses the following files:
 379 .
 380 .IP "\fBovs\-lib.sh"
 381 Shell function library used internally by \fBovs\-ctl\fR.  It must be
 382 installed in the same directory as \fBovs\-ctl\fR.
 383 .
 384 .IP "\fIlogdir\fB/\fIdaemon\fB.log\fR"
 385 Per-daemon logfiles.
 386 .
 387 .IP "\fIrundir\fB/\fIdaemon\fB.pid\fR"
 388 Per-daemon pidfiles to track whether a daemon is running and with what
 389 process ID.
 390 .
 391 .IP "\fIpkgdatadir\fB/vswitch.ovsschema\fR"
 392 The OVS database schema used to initialize the database (use
 393 \fB\-\-db\-schema to override this location).
 394 .
 395 .IP "\fIsysconfdir\fB/openvswitch/conf.db\fR"
 396 The OVS database (use \fB\-\-db\-file\fR to override this location).
 397 .
 398 .IP "\fIrundir\fB/openvswitch/db.sock\fR"
 399 The Unix domain socket used for local communication with
 400 \fBovsdb\-server\fR (use \fB\-\-db\-sock\fR to override this
 401 location).
 402 .
 403 .IP "\fIsysconfdir\fB/openvswitch/system-id.conf\fR"
 404 The persistent system UUID created and read by
 405 \fB\-\-system\-id=random\fR.
 406 .
 407 .IP "\fIsysconfdir\fB/openvswitch/system\-type.conf\fR"
 408 .IQ "\fIsysconfdir\fB/openvswitch/system\-version.conf\fR"
 409 The \fBsystem\-type\fR  and \fBsystem\-version\fR values stored in the database's
 410 \fBOpen_vSwitch\fR table when not specified as a command-line option.
 411 .
 412 .SH "EXAMPLE"
 413 .
 414 .PP
 415 The files \fBdebian/openvswitch\-switch.init\fR and
 416 \fBxenserver/etc_init.d_openvswitch\fR in the Open vSwitch source
 417 distribution are good examples of how to use \fBovs\-ctl\fR.
 418 .
 419 .SH "SEE ALSO"
 420 .
 421 \fBREADME\fR, \fBINSTALL.Linux\fR, \fBovsdb\-server\fR(8),
 422 \fBovs\-vswitchd\fR(8).