utilities/ovs-kmod-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 "February 2018" "Open vSwitch" "Open vSwitch Manual"
  14 .ds PN ovs\-ctl
  15 .
  16 .SH NAME
  17 ovs\-kmod\-ctl \- OVS startup helper script for loading kernel modules
  18 .
  19 .SH SYNOPSIS
  20 \fBovs\-kmod\-ctl\fR \fBinsert
  21 .br
  22 \fBovs\-kmod\-ctl \fBremove
  23 .br
  24 \fBovs\-kmod\-ctl help \fR| \fB\-h \fR| \fB\-\-help
  25 .br
  26 \fBovs\-kmod\-ctl \-\-version
  27 .br
  28 \fBovs\-kmod\-ctl version
  29 .
  30 .SH DESCRIPTION
  31 .
  32 .PP
  33 The \fBovs\-kmod\-ctl\fR program is responsible for inserting and
  34 removing Open vSwitch kernel modules.  It is not meant to be invoked
  35 directly by system administrators but to be called internally by
  36 system startup scripts.  The script is used as part of an SELinux
  37 transition domain.
  38 .
  39 .PP
  40 Each of \fBovs\-kmod\-ctl\fR's commands is described separately below.
  41 .
  42 .SH "The ``insert'' command"
  43 .
  44 .PP
  45 The \fBinsert\fR command loads the Open vSwitch kernel modules, if
  46 needed.  If this fails, and the Linux bridge module is loaded but no
  47 bridges exist, it tries to unload the bridge module and tries loading
  48 the Open vSwitch kernel module again.
  49 .
  50 .SH "The ``remove'' command"
  51 .
  52 .PP
  53 The \fBremove\fR command unloads the Open vSwitch kernel module (including
  54 the bridge compatibility module, if loaded) and any associated vport
  55 modules.
  56 .
  57 .SH "EXIT STATUS"
  58 .
  59 \fBovs\-kmod\-ctl\fR exits with status 0 on success and nonzero on
  60 failure.  The \fBinsert\fR command is considered to succeed if kernel
  61 modules are already loaded; the \fBremove\fR command is considered to
  62 succeed if none of the kernel modules are loaded.
  63 .
  64 .SH "ENVIRONMENT"
  65 .
  66 The following environment variables affect \fBovs\-kmod\-ctl\fR:
  67 .
  68 .IP "\fBPATH\fR"
  69 \fBovs\-kmod\-ctl\fR does not hardcode the location of any of the programs
  70 that it runs.  \fBovs\-kmod\-ctl\fR will add the \fIsbindir\fR and
  71 \fIbindir\fR that were specified at \fBconfigure\fR time to
  72 \fBPATH\fR, if they are not already present.
  73 .
  74 .IP "\fBOVS_LOGDIR\fR"
  75 .IQ "\fBOVS_RUNDIR\fR"
  76 .IQ "\fBOVS_DBDIR\fR"
  77 .IQ "\fBOVS_SYSCONFDIR\fR"
  78 .IQ "\fBOVS_PKGDATADIR\fR"
  79 .IQ "\fBOVS_BINDIR\fR"
  80 .IQ "\fBOVS_SBINDIR\fR"
  81 Setting one of these variables in the environment overrides the
  82 respective \fBconfigure\fR option, both for \fBovs\-kmod\-ctl\fR itself
  83 and for the other Open vSwitch programs that it runs.
  84 .
  85 .SH "FILES"
  86 .
  87 \fBovs\-kmod\-ctl\fR uses the following files:
  88 .
  89 .IP "\fBovs\-lib"
  90 Shell function library used internally by \fBovs\-kmod\-ctl\fR.  It must
  91 be installed in the same directory as \fBovs\-kmod\-ctl\fR.
  92 .
  93 .SH "EXAMPLE"
  94 .
  95 .PP
  96 \fBovs\-kmod\-ctl\fR isn't intended to be manually executed.  However, the
  97 following examples demonstrate loading the kernel modules.
  98 .
  99 .TP
 100 \fBovs\-kmod\-ctl\fR insert
 101 Attempts to insert the Open vSwitch kernel modules.
 102 .
 103 .TP
 104 \fBovs\-kmod\-ctl\fR remove
 105 Attempts to remove the Open vSwitch kernel modules.
 106 .
 107 .SH "SEE ALSO"
 108 .
 109 \fBREADME.rst\fR, \fBovs\-ctl\fR(8)