interface-reconfigure+vif: accept openvswitch in /etc/xensource/network.conf
[openvswitch] / utilities / ovs-vsctl.8.in
index 7db3ddcdcfdb9d45fb8a35a2b02f76a66ab5c5fa..031615cee470c938561a0e6dd1f39f6a8e9a1614 100644 (file)
@@ -9,7 +9,6 @@
 .  RS -0.15in
 .  I "\\$1"
 .  RE
-.  PP
 ..
 .TH ovs\-vsctl 8 "November 2009" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovs\-vsctl
@@ -80,7 +79,7 @@ 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
@@ -121,6 +120,7 @@ zero will cause \fBovs\-vsctl\fR to wait forever.  If the timeout expires,
 not used, \fBovs\-vsctl\fR uses a timeout of five seconds.
 (A timeout would normally happen only if the database cannot be contacted.)
 .
+.SS "Public Key Infrastructure Options"
 .so lib/ssl.man
 .so lib/vlog.man
 .
@@ -225,19 +225,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.
@@ -312,7 +321,7 @@ the following forms:
 .RE
 .
 .ST "Controller Failure Settings"
-.
+.PP
 When a controller is configured, it is, ordinarily, responsible for
 setting up all flows on the switch.  Thus, if the connection to
 the controller fails, no new network connections can be set up.  If
@@ -376,6 +385,7 @@ Sets the SSL configuration.  The \fB\-\-bootstrap\fR option is described
 below.
 .
 .ST "CA Certificate Bootstrap"
+.PP
 Ordinarily, all of the files named in the SSL configuration must exist
 when \fBovs\-vswitchd\fR starts.  However, if the \fB\-\-bootstrap\fR 
 option is given, then \fBovs\-vswitchd\fR will attempt to obtain the
@@ -442,6 +452,7 @@ abbreviations are acceptable, e.g. \fBnet\fR or \fRn\fR is sufficient
 to identify the \fBNetFlow\fR table.
 .
 .ST "Database Values"
+.PP
 Each column in the database accepts a fixed type of data.  The
 currently defined basic types, and their representations, are:
 .IP "integer"
@@ -482,7 +493,6 @@ as \fB{}\fR, and curly braces may be optionally enclose non-empty maps
 as well.
 .
 .ST "Database Command Syntax"
-.
 .IP "\fBlist \fItable \fR[\fIrecord\fR]..."
 List the values of all columns of each specified \fIrecord\fR.  If no
 records are specified, lists all the records in \fItable\fR.