X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=0faed9c97181eaaa11ae888b9247dea1d8861194;hb=ca00e5debfb9c2e4aa17eec9df563343c72d65ba;hp=eb98043ca46c084062cfe10d76618af1702df628;hpb=e3fdfed11b8c56aa6a8deffe11a552fed7e7adbc;p=openvswitch diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index eb98043c..0faed9c9 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -1,4 +1,4 @@ -.TH ovs\-ofctl 8 "June 2009" "Open vSwitch" "Open vSwitch Manual" +.TH ovs\-ofctl 8 "January 2010" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-ofctl .SH NAME @@ -26,28 +26,20 @@ connecting to an OpenFlow switch. The following connection methods are supported: .RS -.TP -\fBssl:\fIhost\fR[\fB:\fIport\fR] -The specified SSL \fIport\fR (default: 6633) on the given remote -\fIhost\fR. The \fB--private-key\fR, \fB--certificate\fR, and -\fB--ca-cert\fR options are mandatory when this form is used. - -.TP -\fBtcp:\fIhost\fR[\fB:\fIport\fR] -The specified TCP \fIport\fR (default: 6633) on the given remote -\fIhost\fR. - -.TP -\fBunix:\fIfile\fR -The Unix domain server socket named \fIfile\fR. - +.so lib/vconn-active.man +. .IP "\fIfile\fR" This is short for \fBunix:\fIfile\fR, as long as \fIfile\fR does not contain a colon. - -.IP \fIdp\fR -This is short for \fBunix:@RUNDIR@/\fIdp\fB.mgmt\fR, as long as -\fIdp\fR does not contain a colon. +. +.IP \fIbridge\fR +This is short for \fBunix:@RUNDIR@/\fIbridge\fB.mgmt\fR, as long as +\fIbridge\fR does not contain a colon. +. +.IP [\fItype\fB@\fR]\fIdp\fR +Attempts to look up the bridge associated with \fIdp\fR and open as +above. If \fItype\fR is given, it specifies the datapath provider of +\fIdp\fR, otherwise the default provider \fBsystem\fR is assumed. .RE .TP @@ -68,9 +60,11 @@ Prints to the console statistics for each of the flow tables used by \fIswitch\fR. .TP -\fBdump-ports \fIswitch\fR -Prints to the console statistics for each of the network devices -associated with \fIswitch\fR. +\fBdump-ports \fIswitch\fR [\fInetdev\fR] +Prints to the console statistics for network devices associated with +\fIswitch\fR. If \fInetdev\fR is specified, only the statistics +associated with that device will be printed. \fInetdev\fR can be an +OpenFlow assigned port number or device name, e.g. \fBeth0\fR. .TP \fBmod-port \fIswitch\fR \fInetdev\fR \fIaction\fR @@ -144,36 +138,22 @@ switch's tables are removed. See \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR. .TP -\fBmonitor \fIswitch\fR [\fImiss-len\fR [\fIsend-exp]] +\fBmonitor \fIswitch\fR [\fImiss-len\fR] Connects to \fIswitch\fR and prints to the console all OpenFlow messages received. Usually, \fIswitch\fR should specify a connection -named on \fBsecchan\fR(8)'s \fB-l\fR or \fB--listen\fR command line +named on \fBovs\-openflowd\fR(8)'s \fB-l\fR or \fB--listen\fR command line option. If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set configuration'' message at connection setup time that requests \fImiss-len\fR bytes of each packet that misses the flow table. The -OpenFlow reference implementation not send these messages to the +OpenFlow reference implementation does not send these messages to the \fBovs\-ofctl monitor\fR client connection unless a nonzero value is specified on this argument. -If \fIsend-exp\fR is specified as \fB1\fR, \fBovs\-ofctl\fR will also -request to be sent flow expiration messages. If this argument is -omitted, or \fB0\fR is specified, then \fRovs\-ofctl\fR will not request -flow expirations. - This command may be useful for debugging switch or controller implementations. -.TP -\fBexecute \fIswitch command \fR[\fIarg\fR...] -Sends a request to \fIswitch\fR to execute \fIcommand\fR along with -each \fIarg\fR, if any, then waits for the command to complete and -reports its completion status on \fBstderr\fR and its output, if any, -on \fBstdout\fR. The set of available commands and their argument is -switch-dependent. (This command uses a Nicira extension to OpenFlow -that may not be available on all switches.) - .SS "OpenFlow Switch and Controller Commands" The following commands, like those in the previous section, may be @@ -229,6 +209,11 @@ as \fIvlan\fR to match packets that are not tagged with a Virtual LAN; otherwise, specify a number between 0 and 4095, inclusive, as the 12-bit VLAN ID to match. +.IP \fBdl_vlan_pcp=\fIpriority\fR +Matches IEEE 802.1q Priority Code Point (PCP) \fIpriority\fR, which is +specified as a value between 0 and 7, inclusive. A higher value +indicates a higher frame priority level. + .IP \fBdl_src=\fImac\fR Matches Ethernet source address \fImac\fR, which is specified as 6 pairs of hexadecimal digits delimited by colons (e.g. \fB00:0A:E4:25:6B:B0\fR). @@ -257,6 +242,11 @@ Matches IPv4 destination address \fIip\fR. Matches IP protocol type \fIproto\fR, which is specified as a decimal number between 0 and 255, inclusive (e.g. 6 to match TCP packets). +.IP \fBnw_tos=\fItos\fR +Matches IP ToS/DSCP field \fItos\fR, which is specified as a decimal +number between 0 and 255, inclusive. Note that the two lower reserved +bits are ignored for matching purposes. + .IP \fBtp_src=\fIport\fR Matches UDP or TCP source port \fIport\fR, which is specified as a decimal number between 0 and 65535, inclusive (e.g. 80 to match packets originating @@ -327,7 +317,7 @@ omitted, then the entire packet is sent. .IP \fBlocal\fR Outputs the packet on the ``local port,'' which corresponds to the \fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in -\fBsecchan\fR(8) for information on the \fBof\fIn\fR network device). +\fBovs\-openflowd\fR(8) for information on the \fBof\fIn\fR network device). .IP \fBdrop\fR Discards the packet, so no further processing or forwarding takes place. @@ -353,6 +343,24 @@ Sets the source Ethernet address to \fImac\fR. .IP \fBmod_dl_dst\fB:\fImac\fR Sets the destination Ethernet address to \fImac\fR. + +.IP \fBmod_nw_src\fB:\fIip\fR +Sets the IPv4 source address to \fIip\fR. + +.IP \fBmod_nw_dst\fB:\fIip\fR +Sets the IPv4 destination address to \fIip\fR. + +.IP \fBmod_tp_src\fB:\fIport\fR +Sets the TCP or UDP source port to \fIport\fR. + +.IP \fBmod_tp_dst\fB:\fIport\fR +Sets the TCP or UDP destination port to \fIport\fR. + +.IP \fBmod_nw_tos\fB:\fItos\fR +Sets the IP ToS/DSCP field to \fItos\fR. Valid values are between 0 and +255, inclusive. Note that the two lower reserved bits are never +modified. + .RE .IP @@ -440,28 +448,7 @@ described in \fBFlow Syntax\fR, above. \fB--strict\fR Uses strict matching when running flow modification commands. -.TP -\fB-t\fR, \fB--timeout=\fIsecs\fR -Limits \fBovs\-ofctl\fR runtime to approximately \fIsecs\fR seconds. If -the timeout expires, \fBovs\-ofctl\fR will exit with a \fBSIGALRM\fR -signal. - -.TP -\fB-p\fR, \fB--private-key=\fIprivkey.pem\fR -Specifies a PEM file containing the private key used as the -identity for SSL connections to a switch. - -.TP -\fB-c\fR, \fB--certificate=\fIcert.pem\fR -Specifies a PEM file containing a certificate, signed by the -controller's certificate authority (CA), that certifies the -private key to identify a trustworthy controller. - -.TP -\fB-C\fR, \fB--ca-cert=\fIcacert.pem\fR -Specifies a PEM file containing the CA certificate used to verify that -a switch is trustworthy. - +.so lib/ssl.man .so lib/vlog.man .so lib/common.man @@ -471,7 +458,7 @@ The following examples assume that an OpenFlow switch on the local host has been configured to listen for management connections on a Unix domain socket named \fB@RUNDIR@/openflow.sock\fR, e.g. by specifying \fB--listen=punix:@RUNDIR@/openflow.sock\fR on the -\fBsecchan\fR(8) command line. +\fBovs\-openflowd\fR(8) command line. .TP \fBovs\-ofctl dump-tables unix:@RUNDIR@/openflow.sock\fR