X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=utilities%2Fovs-dpctl.8.in;h=c1be05e136be6406625a4068c618ab4e1350adb4;hb=06d4d4b68726d9cf153577a4a2287f944276f0d7;hp=0a1d670298b4e68cd5fa51cb78fb43ccb537fe77;hpb=9ee3ae3e0d89fcd67d04d8a890734a5fbee218a5;p=cascardo%2Fovs.git diff --git a/utilities/ovs-dpctl.8.in b/utilities/ovs-dpctl.8.in index 0a1d67029..c1be05e13 100644 --- a/utilities/ovs-dpctl.8.in +++ b/utilities/ovs-dpctl.8.in @@ -1,160 +1,75 @@ -.TH ovs\-dpctl 8 "March 2009" "Open vSwitch" "Open vSwitch Manual" +.de IQ +. br +. ns +. IP "\\$1" +.. +.TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-dpctl - +. .SH NAME ovs\-dpctl \- administer Open vSwitch datapaths - +. .SH SYNOPSIS .B ovs\-dpctl [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...] - +. .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 +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 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. - -Do not use \fBovs\-dpctl\fR commands to modify datapaths if -\fBovs\-vswitchd\fR(8) is in use. Instead, modify the -\fBovs\-vswitchd\fR configuration file and send \fBSIGHUP\fR to the -\fBovs\-vswitchd\fR process. - .PP -Most \fBovs\-dpctl\fR commands that work with datapaths take an argument -that specifies the name of the datapath, in one of the following -forms: - -.so lib/dpif.man - +If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead +of \fBovs\-dpctl\fR. +.PP +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. .PP The following commands manage datapaths. - -.TP -\fBadd\-dp \fIdp\fR [\fInetdev\fR...] - -Creates datapath \fIdp\fR. The name of the new datapath's local port -depends on how \fIdp\fR is specified: if it takes the form -\fBdp\fIN\fR, the local port will be named \fBdp\fIN\fR; otherwise, -the local port's name will be \fIdp\fR. - -This will fail if the host already has 256 datapaths, if a network -device with the same name as the new datapath's local port already -exists, or if \fIdp\fR is given in the form \fBdp\fIN\fR -and a datapath numbered \fIN\fR already exists. - -If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the datapath. - -.TP -\fBdel\-dp \fIdp\fR -Deletes datapath \fIdp\fR. If \fIdp\fR is associated with any network -devices, they are automatically removed. - -.TP -\fBadd\-if \fIdp netdev\fR[\fIoption\fR...]... -Adds each \fInetdev\fR to the set of network devices datapath -\fIdp\fR monitors, where \fIdp\fR is the name of an existing -datapath, and \fInetdev\fR is the name of one of the host's -network devices, e.g. \fBeth0\fR. Once a network device has been added -to a datapath, the datapath has complete ownership of the network device's -traffic and the network device appears silent to the rest of the -system. - -A \fInetdev\fR may be followed by a comma-separated list of options. -The following options are currently supported: - -.RS -.IP "\fBinternal\fR" -Instead of attaching an existing \fInetdev\fR, creates an internal -port (analogous to the local port) with that name. -.RE - -.TP -\fBdel\-if \fIdp netdev\fR... -Removes each \fInetdev\fR from the list of network devices datapath -\fIdp\fR monitors. - -.TP -\fBshow \fR[\fIdp\fR...] -Prints a summary of configured datapaths, including their datapath -numbers and a list of ports connected to each datapath. (The local -port is identified as port 0.) - -If one or more datapaths are specified, information on only those -datapaths are displayed. Otherwise, \fBovs\-dpctl\fR displays information -about all configured datapaths. - -.IP "\fBdump-flows \fIdp\fR" -Prints to the console all flow entries in datapath \fIdp\fR's -flow table. - -This command is primarily useful for debugging Open vSwitch. The flow -table entries that it displays are not -OpenFlow flow entries. Instead, they are different and considerably -simpler flows maintained by the Open vSwitch kernel module. - -.IP "\fBdel-flows \fIdp\fR" -Deletes all flow entries from datapath \fIdp\fR's flow table. - -This command is primarily useful for debugging Open vSwitch. As -discussed in \fBdump-flows\fR, these entries are -not OpenFlow flow entries. By deleting them, the process that set them -up may be confused about their disappearance. - -.IP "\fBdump-groups \fIdp\fR" -Prints to the console the sets of port groups maintained by datapath -\fIdp\fR. Ordinarily there are at least 2 port groups in a datapath -that \fBsecchan\fR or \fBvswitch\fR is controlling: group 0 contains -all ports except those disabled by STP, and group 1 contains all -ports. Additional groups might be used in the future. - -This command is primarily useful for debugging Open vSwitch. OpenFlow -does not have a concept of port groups. - +. +.ds DX +.de DO +\\$1 \\$2 \\$3 +.. +.so lib/dpctl.man +. .SH OPTIONS -.TP -\fB-t\fR, \fB--timeout=\fIsecs\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. +. +.IP "\fB\-m\fR" +.IQ "\fB\-\-more\fR" +Increases the verbosity of \fBdump\-flows\fR output. +. +.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. - +. .so lib/vlog.man .so lib/common.man - -.SH EXAMPLES - -A typical \fBovs\-dpctl\fR command sequence for controlling an -Open vSwitch kernel module: - -.TP -\fBovs\-dpctl add\-dp dp0\fR -Creates datapath number 0. - -.TP -\fBovs\-dpctl add\-if dp0 eth0 eth1\fR -Adds two network devices to the new datapath. - -.PP -At this point one would ordinarily start \fBsecchan\fR(8) on -\fBdp0\fR, transforming \fBdp0\fR into an OpenFlow switch. Then, when -the switch and the datapath is no longer needed: - -.TP -\fBovs\-dpctl del\-if dp0 eth0 eth1\fR -Removes network devices from the datapath. - -.TP -\fBovs\-dpctl del\-dp dp0\fR -Deletes the datapath. - +. .SH "SEE ALSO" - -.BR secchan (8), +. .BR ovs\-appctl (8), .BR ovs\-vswitchd (8)