ovs-kmod-ctl(8)

1ovs-ctl(8)                    Open vSwitch Manual                   ovs-ctl(8)
2
3
4

NAME

6       ovs-kmod-ctl - OVS startup helper script for loading kernel modules
7

SYNOPSIS

9       ovs-kmod-ctl insert
10       ovs-kmod-ctl remove
11       ovs-kmod-ctl help | -h | --help
12       ovs-kmod-ctl --version
13       ovs-kmod-ctl version
14

DESCRIPTION

16       The ovs-kmod-ctl program is responsible for inserting and removing Open
17       vSwitch kernel modules.  It is not meant to be invoked directly by sys‐
18       tem  administrators  but  to  be  called  internally  by system startup
19       scripts.  The script is used as part of an SELinux transition domain.
20
21       Each of ovs-kmod-ctl's commands is described separately below.
22

The ``insert'' command

24       The insert command loads the Open vSwitch kernel  modules,  if  needed.
25       If  this  fails,  and  the Linux bridge module is loaded but no bridges
26       exist, it tries to unload the bridge module and tries loading the  Open
27       vSwitch kernel module again.
28

The ``remove'' command

30       The  remove  command  unloads the Open vSwitch kernel module (including
31       the bridge compatibility module, if loaded) and  any  associated  vport
32       modules.
33

EXIT STATUS

35       ovs-kmod-ctl  exits  with  status  0 on success and nonzero on failure.
36       The insert command is considered  to  succeed  if  kernel  modules  are
37       already  loaded; the remove command is considered to succeed if none of
38       the kernel modules are loaded.
39

ENVIRONMENT

41       The following environment variables affect ovs-kmod-ctl:
42
43       PATH   ovs-kmod-ctl does not hardcode the location of any of  the  pro‐
44              grams  that  it  runs.   ovs-kmod-ctl  will  add the sbindir and
45              bindir that were specified at configure time to  PATH,  if  they
46              are not already present.
47
48       OVS_LOGDIR
49       OVS_RUNDIR
50       OVS_DBDIR
51       OVS_SYSCONFDIR
52       OVS_PKGDATADIR
53       OVS_BINDIR
54       OVS_SBINDIR
55              Setting  one of these variables in the environment overrides the
56              respective configure option, both for  ovs-kmod-ctl  itself  and
57              for the other Open vSwitch programs that it runs.
58

FILES

60       ovs-kmod-ctl uses the following files:
61
62       ovs-lib
63              Shell function library used internally by ovs-kmod-ctl.  It must
64              be installed in the same directory as ovs-kmod-ctl.
65

EXAMPLE

67       ovs-kmod-ctl isn't intended to be manually executed.  However, the fol‐
68       lowing examples demonstrate loading the kernel modules.
69
70       ovs-kmod-ctl insert
71              Attempts to insert the Open vSwitch kernel modules.
72
73       ovs-kmod-ctl remove
74              Attempts to remove the Open vSwitch kernel modules.
75