X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-dpctl.8.in;h=40032bc7deeda32be200014154ada321e33e0059;hb=372d58a4e3d735a269856d1f285b5ed1b99f6dce;hp=ee124484388d667dfbd0088df432d5350065f686;hpb=045b2e5c77d02cd0d7bba046e2dbed72ec4828c8;p=sliver-openvswitch.git diff --git a/utilities/ovs-dpctl.8.in b/utilities/ovs-dpctl.8.in index ee1244843..40032bc7d 100644 --- a/utilities/ovs-dpctl.8.in +++ b/utilities/ovs-dpctl.8.in @@ -1,3 +1,8 @@ +.de IQ +. br +. ns +. IP "\\$1" +.. .TH ovs\-dpctl 8 "August 2009" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-dpctl . @@ -11,8 +16,7 @@ ovs\-dpctl \- administer Open vSwitch datapaths .SH DESCRIPTION .PP The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch -datapaths. A single machine may host up to 256 datapaths (numbered 0 -to 255). +datapaths. A single machine may host any number of datapaths. .PP A newly created datapath is associated with only one network device, a virtual network device sometimes called the datapath's ``local port''. @@ -34,11 +38,12 @@ default provider \fBsystem\fR is assumed. The following commands manage datapaths. . .TP -\fBadd\-dp \fIdp\fR [\fInetdev\fR...] +\fBadd\-dp \fIdp\fR [\fInetdev\fR[\fB,\fIoption\fR]...] Creates datapath \fIdp\fR, with a local port also named \fIdp\fR. This will fail if a network device \fIdp\fR already exists. .IP -If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the datapath. +If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the +new datapath, just as if \fBadd\-if\fR was specified. . .TP \fBdel\-dp \fIdp\fR @@ -68,6 +73,14 @@ Adds an arbitrary key-value option to the port's configuration. \fBovs\-vswitchd.conf.db\fR(5) documents the available port types and options. . +.IP "\fBset\-if \fIdp port\fR[\fB,\fIoption\fR]..." +Reconfigures each \fIport\fR in \fIdp\fR as specified. An +\fIoption\fR of the form \fIkey\fB=\fIvalue\fR adds the specified +key-value option to the port or overrides an existing key's value. An +\fIoption\fR of the form \fIkey\fB=\fR, that is, without a value, +deletes the key-value named \fIkey\fR. The type of a port cannot be +changed, so \fBtype=\fItype\fR is only allowed if \fItype\fR is the +port's existing type. .TP \fBdel\-if \fIdp netdev\fR... Removes each \fInetdev\fR from the list of network devices datapath @@ -106,11 +119,13 @@ not OpenFlow flow entries. By deleting them, the process that set them up may be confused about their disappearance. . .SH OPTIONS -.IP "\fB\-s\fR, \fB\-\-statistics\fR" +.IP "\fB\-s\fR" +.IQ "\fB\-\-statistics\fR" Causes the \fBshow\fR command to print packet and byte counters for each port within the datapaths that it shows. -.TP -\fB\-t\fR, \fB\-\-timeout=\fIsecs\fR +. +.IP "\fB\-t\fR" +.IQ "\fB\-\-timeout=\fIsecs\fR" Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR signal.