ovsdb-idlc: Fix sizeof calculation in generated code.
[openvswitch] / utilities / ovs-vsctl.8.in
index 84193e8757241c49540bc22ec993880f1335a3bc..ab487ad41fb3df433a1087cf635355036d52fcb8 100644 (file)
@@ -139,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.
 .
@@ -299,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.
@@ -313,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
@@ -435,17 +442,24 @@ A bridge port.  Records may be identified by port name.
 .IP "\fBInterface\fR"
 A network device attached to a port.  Records may be identified by
 name.
+.IP "\fBMirror\fR"
+A port mirroring configuration attached to a bridge.  Records may be
+identified by mirror name.
 .IP "\fBController\fR"
 Configuration for an OpenFlow controller.  A controller attached to a
 particular bridge may be identified by the bridge's name.  The default
 controller controller for an Open vSwitch may be identified by
 specifying \fB.\fR as the record name.
-.IP "\fBMirror\fR"
-A port mirroring configuration attached to a bridge.  Records may be
-identified by mirror name.
 .IP "\fBNetFlow\fR"
 A NetFlow configuration attached to a bridge.  Records may be
 identified by bridge name.
+.IP "\fBSSL\fR"
+The global SSL configuration for \fBovs\-vswitchd\fR.  The record
+attached to the \fBOpen_vSwitch\fR table may be identified by
+specifying \fB.\fR as the record name.
+.IP "\fBsFlow\fR"
+An sFlow configuration attached to a bridge.  Records may be
+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
@@ -473,8 +487,10 @@ the syntax is that of strings in JSON, e.g. backslashes may be used to
 escape special characters.  The empty string must be represented as a
 pair of double quotes (\fB""\fR).
 .IP "UUID"
-A universally unique identifier in the style of RFC 4122,
-e.g. \fBf81d4fae-7dec-11d0-a765-00a0c91e6bf6\fR.
+Either a universally unique identifier in the style of RFC 4122,
+e.g. \fBf81d4fae\-7dec\-11d0\-a765\-00a0c91e6bf6\fR, or an \fB@\fIname\fR
+defined by the \fBcreate\fR command within the same \fBovs\-vsctl\fR
+invocation.
 .PP
 Multiple values in a single column may be separated by spaces or a
 single comma.  When multiple values are present, duplicates are not
@@ -545,10 +561,15 @@ 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 "\fBcreate\fR \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
+.IP "[\fB--id=@\fIname\fR] \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.
+.IP
+If \fB@\fIname\fR is specified, then the UUID for the new row may be
+referred to by that name elsewhere in the same \fBovs\-vsctl\fR
+invocation in contexts where a UUID is expected.  Such references may
+precede or follow the \fBcreate\fR command.
 .
 .IP "\fR[\fB\-\-if\-exists\fR] \fBdestroy \fItable record\fR..."
 Deletes each specified \fIrecord\fR from \fItable\fR.  Unless
@@ -572,6 +593,12 @@ Delete bridge \fBbr0\fR if it exists (the \fB\-\-\fR is required to
 separate \fBdel\-br\fR's options from the global options):
 .IP
 .B "ovs\-vsctl \-\- \-\-if\-exists del\-br br0"
+.PP
+Set the \fBqos\fR column of the \fBPort\fR record for \fBeth0\fR to
+point to a new \fBQoS\fR record, which in turn points with its queue 0
+to a new \fBQueue\fR record:
+.IP
+.B "ovs-vsctl \-\- set port eth0 qos=@newqos \-\- \-\-id=@newqos create qos type=linux\-htb other\-config:max\-rate=1000000 queues:0=@newqueue \-\- \-\-id=@newqueue create queue other\-config:min\-rate=1000000 other\-config:max\-rate=1000000"
 .
 .SH "EXIT STATUS"
 .IP "0"
@@ -585,3 +612,4 @@ bridge that does not exist.
 .
 .BR ovsdb\-server (1),
 .BR ovs\-vswitchd (8).
+\