ovs-ctl: Add option to delete transient ports.
[cascardo/ovs.git] / utilities / ovs-ctl.8
index 97294af..6a9a544 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
@@ -87,10 +90,14 @@ 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.
+.IP 7.
 Starts \fBovs\-vswitchd\fR.
 .
 .SS "Options"
@@ -145,6 +152,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:
 .
@@ -237,7 +249,7 @@ aren't running.
 .PP
 The \fBrestart\fR command performs a \fBstop\fR followed by a \fBstart\fR
 command.  The command can take the same options as that of the \fBstart\fR
-command. In addition, it saves and restores Openflow flows for each
+command. In addition, it saves and restores OpenFlow flows for each
 individual bridge.
 .
 .SH "The ``status'' command"
@@ -267,7 +279,7 @@ implemented by Open vSwitch.  The most common examples of these are
 bridge ``local ports''.
 .
 .IP 2.
-Saves the Openflow flows of each bridge.
+Saves the OpenFlow flows of each bridge.
 .
 .IP 3.
 Stops the Open vSwitch daemons, as if by a call to \fBovs\-ctl
@@ -285,7 +297,7 @@ compatibility module if it is loaded).
 .IP 6.
 Starts OVS back up, as if by a call to \fBovs\-ctl start\fR.  This
 reloads the kernel module, restarts the OVS daemons and finally
-restores the saved Openflow flows.
+restores the saved OpenFlow flows.
 .
 .IP 7.
 Restores the kernel configuration state that was saved in step 4.
@@ -441,5 +453,5 @@ distribution are good examples of how to use \fBovs\-ctl\fR.
 .
 .SH "SEE ALSO"
 .
-\fBREADME\fR, \fBINSTALL.Linux\fR, \fBovsdb\-server\fR(8),
+\fBREADME.md\fR, \fBINSTALL.Linux.md\fR, \fBovsdb\-server\fR(8),
 \fBovs\-vswitchd\fR(8).