X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-vsctl.8.in;h=55ea30764f2de0226d6834384e81a5bf7e966329;hb=9e15c889f7a94db2decefd93dd6b3f77fb1b7bc6;hp=19ef5584df24518ab3c6b580bbc27e1c8acfda73;hpb=ac3005057c9baf5fab366e31e2c18b26685a73e2;p=openvswitch diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in index 19ef5584..55ea3076 100644 --- a/utilities/ovs-vsctl.8.in +++ b/utilities/ovs-vsctl.8.in @@ -79,10 +79,11 @@ the global options by \fB\-\-\fR. .IP "\fB\-\-db=\fIserver\fR" Sets \fIserver\fR as the database server that \fBovs\-vsctl\fR contacts to query or modify configuration. The default is -\fBunix:@RUNDIR@/ovsdb\-server\fR. \fIserver\fR must take one of the +\fBunix:@RUNDIR@/db.sock\fR. \fIserver\fR must take one of the following forms: .RS .so ovsdb/remote-active.man +.so ovsdb/remote-passive.man .RE . .IP "\fB\-\-no\-wait\fR" @@ -138,6 +139,11 @@ Any successful \fBovs\-vsctl\fR command automatically initializes the Open vSwitch database if it is empty. This command is provided to initialize the database without executing any other command. . +.IP "\fBemer\-reset\fR" +Reset the configuration into a clean state. This will clear the +configuration of items likely to have been configured by a manager. +The core networking configuration will be left as is. +. .SS "Bridge Commands" These commands examine and manipulate Open vSwitch bridges. . @@ -225,19 +231,28 @@ commands treat a bonded port as a single entity. Lists all of the ports within \fIbridge\fR on standard output, one per line. The local port \fIbridge\fR is not included in the list. . -.IP "[\fB\-\-may\-exist\fR] \fBadd\-port \fIbridge port\fR" +.IP "[\fB\-\-may\-exist\fR] \fBadd\-port \fIbridge port \fR[\fIcolumn\fR[\fB:\fIkey\fR]\fR=\fIvalue\fR]\&...\fR" Creates on \fIbridge\fR a new port named \fIport\fR from the network device of the same name. .IP +Optional arguments set values of column in the Port record created by +the command. For example, \fBtag=9\fR would make the port an access +port for VLAN 9. The syntax is the same as that for the \fBset\fR +command (see \fBDatabase Commands\fR below). +.IP Without \fB\-\-may\-exist\fR, attempting to create a port that exists is an error. With \fB\-\-may\-exist\fR, \fIport\fR may already exist (but it must be on \fIbridge\fR and not be a bonded port). . -.IP "[\fB\-\-fake\-iface\fR] \fBadd\-bond \fIbridge port iface\fR\&..." +.IP "[\fB\-\-fake\-iface\fR] \fBadd\-bond \fIbridge port iface\fR\&... [\fIcolumn\fR[\fB:\fIkey\fR]\fR=\fIvalue\fR]\&...\fR" Creates on \fIbridge\fR a new port named \fIport\fR that bonds together the network devices given as each \fIiface\fR. At least two interfaces must be named. .IP +Optional arguments set values of column in the Port record created by +the command. The syntax is the same as that for the \fBset\fR command +(see \fBDatabase Commands\fR below). +.IP With \fB\-\-fake\-iface\fR, a fake interface with the name \fIport\fR is created. This should only be used for compatibility with legacy software that requires it. @@ -289,13 +304,14 @@ output. .SS "OpenFlow Controller Connectivity" . \fBovs\-vswitchd\fR can perform all configured bridging and switching -locally, or it can be configured to connect a given bridge to an -external OpenFlow controller, such as NOX. +locally, or it can be configured to connect a given bridge to one or +more external OpenFlow controllers, such as NOX. . -If a \fIbridge\fR argument is given, the settings apply only to the -specified bridge. Otherwise, they apply to the Open vSwitch instance, -and its configuration applies to any bridge that has not been explicitly -configured through a \fIbridge\fR argument. +For each of these commands, a \fIbridge\fR of \fBdefault\fR applies +the configuration as the default for any bridge that has not been +explicitly configured. Otherwise, \fIbridge\fR must name a bridge, +and the settings apply only to that bridge. (Omitting \fIbridge\fR +entirely usually has the same effect as specifying \fBdefault\fR.) . .IP "\fBget\-controller\fR [\fIbridge\fR]" Prints the configured controller target. @@ -303,9 +319,10 @@ Prints the configured controller target. .IP "\fBdel\-controller\fR [\fIbridge\fR]" Deletes the configured controller target. . -.IP "\fBset\-controller\fR [\fIbridge\fR] \fItarget\fR" -Sets the configured controller target. The \fItarget\fR may use any of -the following forms: +.IP "\fBset\-controller\fR [\fIbridge\fR] \fItarget\fR\&..." +Sets the configured controller target or targets. If more than one +\fItarget\fR is specified, then \fIbridge\fR may not be omitted. Each +\fItarget\fR may use any of the following forms: . .RS .so lib/vconn-active.man @@ -439,7 +456,7 @@ identified by bridge name. .PP Names of tables, records, and columns are not case-sensitive, and \fB--\fR and \fB_\fR are treated interchangeably. Unique -abbreviations are acceptable, e.g. \fBnet\fR or \fRn\fR is sufficient +abbreviations are acceptable, e.g. \fBnet\fR or \fBn\fR is sufficient to identify the \fBNetFlow\fR table. . .ST "Database Values" @@ -535,7 +552,7 @@ Sets each \fIcolumn\fR in \fIrecord\fR in \fItable\fR to the empty set or empty map, as appropriate. This command applies only to columns that are allowed to be empty. . -.IP "create \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..." +.IP "\fBcreate\fR \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..." Creates a new record in \fItable\fR and sets the initial values of each \fIcolumn\fR. Columns not explicitly set will receive their default values. Outputs the UUID of the new row.