X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=d7f3ad25deefc93302fe2fda0db351b7b25bca68;hb=98704941ec95258281da2ac147ce5f3e03436ba4;hp=eb98043ca46c084062cfe10d76618af1702df628;hpb=e3fdfed11b8c56aa6a8deffe11a552fed7e7adbc;p=sliver-openvswitch.git diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index eb98043ca..d7f3ad25d 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -26,16 +26,15 @@ 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. +.IP "\fBssl:\fIip\fR[\fB:\fIport\fR]" +The specified SSL \fIport\fR (default: 6633) on the host at the given +\fIip\fR, which must be expressed as an IP address (not a DNS name). +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. +.IP "\fBtcp:\fIip\fR[\fB:\fIport\fR]" +The specified TCP \fIport\fR (default: 6633) on the host at the given +\fIip\fR, which must be expressed as an IP address (not a DNS name). .TP \fBunix:\fIfile\fR @@ -144,24 +143,19 @@ 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. @@ -229,6 +223,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). @@ -327,7 +326,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 +352,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 @@ -471,7 +488,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