dpif-netlink: add GENEVE creation support
[cascardo/ovs.git] / utilities / ovs-ctl.8
index 0f70403..4b441b4 100644 (file)
@@ -22,6 +22,9 @@ ovs\-ctl \- OVS startup helper script
 .br
 \fBovs\-ctl stop
 .br
+\fBovs\-ctl\fR \fB\-\-system\-id=random\fR|\fIuuid\fR
+[\fIoptions\fR] \fBrestart
+.br
 \fBovs\-ctl status
 .br
 \fBovs\-ctl version
@@ -78,7 +81,8 @@ If the database does exist, but it has an obsolete version, it
 upgrades it to the latest schema.
 .
 .IP 3.
-Starts \fBovsdb-server\fR.
+Starts \fBovsdb-server\fR, unless the \fB\-\-no\-ovsdb\-server\fR command
+option is given.
 .
 .IP 4.
 Initializes a few values inside the database.
@@ -87,10 +91,15 @@ Initializes a few values inside the database.
 If the \fB\-\-delete\-bridges\fR option was used, deletes all of the
 bridges from the database.
 .
+.IP 6.
+If the \fB\-\-delete\-transient\-ports\fR option was used, deletes all ports
+that have \fBother_config:transient\fR set to true.
+.
 .PP
 The \fBstart\fR command skips the following step if
-\fBovs\-vswitchd\fR is already running:
-.IP 6.
+\fBovs\-vswitchd\fR is already running, or if the \fB\-\-no\-ovs\-vswitchd\fR
+command option is given:
+.IP 7.
 Starts \fBovs\-vswitchd\fR.
 .
 .SS "Options"
@@ -145,6 +154,11 @@ on every boot.  This option supports that, by deleting all Open
 vSwitch bridges after starting \fBovsdb\-server\fR but before starting
 \fBovs\-vswitchd\fR.
 .
+.IP "\fB\-\-delete\-transient\-ports\fR"
+Deletes all ports that have the other_config:transient value set to true. This
+is important on certain environments where some ports are going to be recreated
+after reboot, but other ports need to be persisted in the database.
+.
 .PP
 The following options are less important:
 .
@@ -226,7 +240,9 @@ taken as relative to \fIdbdir\fR.
 .
 .PP
 The \fBstop\fR command does not unload the Open vSwitch kernel
-modules.
+modules. It can take the same \fB\-\-no\-ovsdb\-server\fR and
+\fB\-\-no\-ovs\-vswitchd\fR options as that of the \fBstart\fR
+command. 
 .
 .PP
 This command does nothing and finishes successfully if the OVS daemons
@@ -302,7 +318,8 @@ particular distribution and installation.)
 .
 .PP
 \fBforce\-kmod\-reload\fR internally stops and starts OVS, so it
-accepts all of the options accepted by the \fBstart\fR command.
+accepts all of the options accepted by the \fBstart\fR command except
+for the \fB\-\-no\-ovs\-vswitchd\fR option.
 .
 .SH "The ``load\-kmod'' command"
 .
@@ -365,8 +382,23 @@ Prints a usage message and exits successfully.
 .
 .SH "OPTIONS"
 .PP
-In addition to the options listed for each command above, this option
-controls the behavior of several of \fBovs\-ctl\fR's commands.
+In addition to the options listed for each command above, these options
+control the behavior of several of \fBovs\-ctl\fR's commands.
+.
+.PP
+By default, \fBovs\-ctl\fR will control the \fBovsdb\-server\fR, and
+the \fBovs\-vswitchd\fR daemons. The following options restrict that control
+to exclude one or the other:
+.
+.IP "\fB\-\-no\-ovsdb-server\fR"
+Specifies that the \fBovs\-ctl\fR commands \fBstart\fR, \fBstop\fR, and
+\fBrestart\fR should not modify the running status of \fBovsdb\-server\fR.
+.
+.IP "\fB\-\-no\-ovs\-vswitchd\fR"
+Specifies that the \fBovs\-ctl\fR commands \fBstart\fR, \fBstop\fR, and
+\fBrestart\fR should not modify the running status of \fBovs\-vswitchd\fR.
+It is an error to include this option with the \fBforce\-reload\-kmod\fR
+command.
 .
 .SH "EXIT STATUS"
 .
@@ -441,5 +473,5 @@ distribution are good examples of how to use \fBovs\-ctl\fR.
 .
 .SH "SEE ALSO"
 .
-\fBREADME.md\fR, \fBINSTALL.Linux\fR, \fBovsdb\-server\fR(8),
+\fBREADME.md\fR, \fBINSTALL.Linux.md\fR, \fBovsdb\-server\fR(8),
 \fBovs\-vswitchd\fR(8).