mir/openvswitch
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-10-23 14:57:06 +00:00
Code Issues Releases Wiki Activity
Files
efa6665e4d72e4d4f7cc971fb0df54278dba3e47
openvswitch/utilities/ovs-dpctl.8.in

76 lines
2.3 KiB
Groff
Raw Normal View History

docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.de IQ
. br
. ns
. IP "\\$1"
..
manpages: Put version number instead of date at bottom of page. We're really good about keeping manpages up to date, but terrible at updating the dates at the bottom of the manpages. So, instead of using manually updated dates, this commit switches to using automatically updated version numbers. We can only use automatically updated version numbers for manpages that we preprocess, that is, the manpages whose sources end with ".in". This excludes a couple of manpages that don't actually get installed with OVS, such as the manpages for ovs-ctl and ovsdb-idlc. This commit doesn't change those manpages. It does change the ovs-bugtool manpage to one that is preprocessed so that we can use the version there. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Ethan Jackson <ethan@nicira.com>
2013-01-02 10:19:14 -08:00
.TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.ds PN ovs\-dpctl
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH NAME
ovs\-dpctl \- administer Open vSwitch datapaths
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH SYNOPSIS
.B ovs\-dpctl
[\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH DESCRIPTION
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.PP
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
ovs-dpctl: Remove obsolete documentation of limit on number of datapaths. Reported-by: Vjekoslav Brajkovic <balkan@cs.washington.edu> Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-05-14 11:13:27 -07:00
datapaths. A single machine may host any number of datapaths.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.PP
ovs-dpctl: Mention use of ovs-appctl instead for netdev datapath. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Gurucharan Shetty <gshetty@nicira.com>
2015-01-30 13:38:45 -08:00
This program works only with datapaths that are implemented outside of
\fBovs\-vswitchd\fR itself, such as the Linux and Windows kernel-based
datapaths. To manage datapaths that are integrated into
\fBovs\-vswitchd\fR, such as the userspace (\fBnetdev\fR) datapath,
use \fBovs\-appctl\fR(8) to invoke the \fBdpctl/*\fR commands, which
are documented in \fBovs\-vswitchd\fR(8).
.PP
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
A newly created datapath is associated with only one network device, a
virtual network device sometimes called the datapath's ``local port''.
A newly created datapath is not, however, associated with any of the
host's other network devices. To intercept and process traffic on a
given network device, use the \fBadd\-if\fR command to explicitly add
that network device to the datapath.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.PP
datapath: Make adding and attaching a vport a single step. For some time now, Open vSwitch datapaths have internally made a distinction between adding a vport and attaching it to a datapath. Adding a vport just means to create it, as an entity detached from any datapath. Attaching it gives it a port number and a datapath. Similarly, a vport could be detached and deleted separately. After some study, I think I understand why this distinction exists. It is because ovs-vswitchd tries to open all the datapath ports before it tries to create them. However, changing it to create them before it tries to open them is not difficult, so this commit does this. The bulk of this commit, however, changes the datapath interface to one that always creates a vport and attaches it to a datapath in a single step, and similarly detaches a vport and deletes it in a single step. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Jesse Gross <jesse@nicira.com>
2010-12-03 14:41:38 -08:00
If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
of \fBovs\-dpctl\fR.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.PP
datapath: Change dp_idx to dp_ifindex, the ifindex of the local port. I can't see any real value in maintaining a dp_idx separate from the ifindex of the local port. With the current implementation it also artificially limits the number of datapaths. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Jesse Gross <jesse@nicira.com>
2011-01-21 17:01:56 -08:00
Most \fBovs\-dpctl\fR commands that work with datapaths take an
argument that specifies the name of the datapath. Datapath names take
the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
device associated with the datapath's local port. If \fItype\fR is
given, it specifies the datapath provider of \fIname\fR, otherwise the
default provider \fBsystem\fR is assumed.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.PP
The following commands manage datapaths.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
dpctl: add ovs-appctl dpctl/* commands to talk to dpif-netdev This commit introduces multiple appctl commands (dpctl/*) They are needed to interact with userspace datapaths (dpif-netdev), because the ovs-dpctl command runs in a separate process and cannot see the userspace datapaths inside vswitchd. This change moves most of the code of utilities/ovs-dpctl.c in lib/dpctl.c. Both the ovs-dpctl command and the ovs-appctl dpctl/* commands make calls to lib/dpctl.c functions, to interact with datapaths. The code from utilities/ovs-dpctl.c has been moved to lib/dpctl.c and has been changed for different reasons: - An exit() call in the old code made perfectly sense. Now (since the code can be run inside vswitchd) it would terminate the daemon. Same reasoning can be applied to ovs_fatal_*() calls. - The lib/dpctl.c code _should_ not leak memory. - All the print* have been replaced with a function pointer provided by the caller, since this code can be run in the ovs-dpctl process (in which case we need to print to stdout) or in response to a unixctl request (and in this case we need to send everything through a socket, using JSON encapsulation). The syntax is ovs-appctl dpctl/(COMMAND) [OPTIONS] [PARAMETERS] while the ovs-dpctl syntax (which _should_ remain the same after this change) is ovs-dpctl [OPTIONS] (COMMAND) [PARAMETERS] Signed-off-by: Daniele Di Proietto <ddiproietto@vmware.com> [blp@nicira.com made stylistic and documentation changes] Signed-off-by: Ben Pfaff <blp@nicira.com>
2014-07-17 17:26:00 -07:00
.ds DX
.de DO
\\$1 \\$2 \\$3
..
.so lib/dpctl.man
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH OPTIONS
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.IP "\fB\-s\fR"
.IQ "\fB\-\-statistics\fR"
ovs-dpctl: Add -s option to print packet and byte counters.
2011-04-28 13:02:15 -07:00
Causes the \fBshow\fR command to print packet and byte counters for
each port within the datapaths that it shows.
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.
odp-util: add verbose mode for displaying dp flow. When verbose mode tuned on, all dp flow fields described by the netlink attributes are displayed, including fully wildcarded attributes. Otherwise, the fully wildcarded attributes are omitted for brevity. Added -m option to "ovs-dpctl dump-flows" to enable verbose mode. It is off by default. Signed-off-by: Andy Zhou <azhou@nicira.com> [blp@nicira.com added documentation] Signed-off-by: Ben Pfaff <blp@nicira.com>
2013-08-03 12:23:14 -07:00
.IP "\fB\-m\fR"
.IQ "\fB\-\-more\fR"
Increases the verbosity of \fBdump\-flows\fR output.
.
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.IP "\fB\-t\fR"
.IQ "\fB\-\-timeout=\fIsecs\fR"
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If
the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
signal.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.so lib/vlog.man
.so lib/common.man
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH "SEE ALSO"
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.BR ovs\-appctl (8),
.BR ovs\-vswitchd (8)
Reference in New Issue Copy Permalink