X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=9a8fd334394a0fb6df61d548ef5f144de0c35f24;hb=d2ad7ef178c39427f2e93ea5c70b3ffc51b7ad1f;hp=07848fd1c1716dbc5e6134936d471e8b2622ea26;hpb=afd5ac066bf1a633690513919ae86dcd1af7ecbc;p=sliver-openvswitch.git diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index 07848fd1c..9a8fd3343 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -487,6 +487,21 @@ series of OpenFlow messages in the binary format used on an OpenFlow connection, and prints them to the console. This can be useful for printing OpenFlow messages captured from a TCP stream. . +.IP "\fBofp\-parse\-pcap\fR \fIfile\fR [\fIport\fR...]" +Reads \fIfile\fR, which must be in the PCAP format used by network +capture tools such as \fBtcpdump\fR or \fBwireshark\fR, extracts all +the TCP streams for OpenFlow connections, and prints the OpenFlow +messages in those connections in human-readable format on +\fBstdout\fR. +.IP +OpenFlow connections are distinguished by TCP port number. +Non-OpenFlow packets are ignored. By default, data on TCP ports 6633 +and 6653 are considered to be OpenFlow. Specify one or more +\fIport\fR arguments to override the default. +.IP +This command cannot usefully print SSL encrypted traffic. It does not +understand IPv6. +. .SS "Flow Syntax" .PP Some \fBovs\-ofctl\fR commands accept an argument that describes a flow or @@ -728,33 +743,41 @@ above, the bitwise match forms apply only when \fBdl_type\fR and \fBnw_proto\fR specify TCP or UDP or SCTP. . .IP \fBtcp_flags=\fIflags\fB/\fImask\fR +.IQ \fBtcp_flags=\fR[\fB+\fIflag\fR...][\fB-\fIflag\fR...] Bitwise match on TCP flags. The \fIflags\fR and \fImask\fR are 16-bit numbers written in decimal or in hexadecimal prefixed by \fB0x\fR. Each 1-bit in \fImask\fR requires that the corresponding bit in \fIflags\fR must match. Each 0-bit in \fImask\fR causes the corresponding bit to be ignored. .IP +Alternatively, the flags can be specified by their symbolic names +(listed below), each preceded by either \fB+\fR for a flag that must +be set, or \fB\-\fR for a flag that must be unset, without any other +delimiters between the flags. Flags not mentioned are wildcarded. +For example, \fBtcp,tcp_flags=+syn\-ack\fR matches TCP SYNs that are +not ACKs. +.IP TCP protocol currently defines 9 flag bits, and additional 3 bits are reserved (must be transmitted as zero), see RFCs 793, 3168, and 3540. The flag bits are, numbering from the least significant bit: .RS -.IP "\fB0: FIN\fR" +.IP "\fB0: fin\fR" No more data from sender. -.IP "\fB1: SYN\fR" +.IP "\fB1: syn\fR" Synchronize sequence numbers. -.IP "\fB2: RST\fR" +.IP "\fB2: rst\fR" Reset the connection. -.IP "\fB3: PSH\fR" +.IP "\fB3: psh\fR" Push function. -.IP "\fB4: ACK\fR" +.IP "\fB4: ack\fR" Acknowledgement field significant. -.IP "\fB5: URG\fR" +.IP "\fB5: urg\fR" Urgent pointer field significant. -.IP "\fB6: ECE\fR" +.IP "\fB6: ece\fR" ECN Echo. -.IP "\fB7: CWR\fR" +.IP "\fB7: cwr\fR" Congestion Windows Reduced. -.IP "\fB8: NS\fR" +.IP "\fB8: ns\fR" Nonce Sum. .IP "\fB9-11:\fR" Reserved. @@ -923,6 +946,17 @@ The \fBip_frag\fR match type is likely to be most useful in \fBnx\-match\fR mode. See the description of the \fBset\-frags\fR command, above, for more details. . +.IP \fBarp_spa=\fIip\fR[\fB/\fInetmask\fR] +.IQ \fBarp_tpa=\fIip\fR[\fB/\fInetmask\fR] +When \fBdl_type\fR specifies either ARP or RARP, \fBarp_spa\fR and +\fBarp_tha\fR match the source and target IPv4 address, respectively. +An address may be specified as an IP address or host name +(e.g. \fB192.168.1.1\fR or \fBwww.example.com\fR). The optional +\fInetmask\fR allows restricting a match to an IPv4 address prefix. +The netmask may be specified as a dotted quad +(e.g. \fB192.168.1.0/255.255.255.0\fR) or as a CIDR block +(e.g. \fB192.168.1.0/24\fR). +. .IP \fBarp_sha=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR .IQ \fBarp_tha=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR When \fBdl_type\fR specifies either ARP or RARP, \fBarp_sha\fR and @@ -1176,14 +1210,14 @@ allows isn't supported at the moment.) A priority of zero and the tag of zero are used for the new tag. . .IP \fBpush_mpls\fR:\fIethertype\fR -If the packet does not already contain any MPLS labels, changes the -packet's Ethertype to \fIethertype\fR, which must be either the MPLS -unicast Ethertype \fB0x8847\fR or the MPLS multicast Ethertype -\fB0x8848\fR, and then pushes an initial label stack entry. The label -stack entry's default label is 2 if the packet contains IPv6 and 0 -otherwise, its default traffic control value is the low 3 bits of the -packet's DSCP value (0 if the packet is not IP), and its TTL is copied -from the IP TTL (64 if the packet is not IP). +Changes the packet's Ethertype to \fIethertype\fR, which must be either +\fB0x8847\fR or \fB0x8848\fR, and pushes an MPLS LSE. +.IP +If the packet does not already contain any MPLS labels then an initial +label stack entry is pushed. The label stack entry's label is 2 if the +packet contains IPv6 and 0 otherwise, its default traffic control value is +the low 3 bits of the packet's DSCP value (0 if the packet is not IP), and +its TTL is copied from the IP TTL (64 if the packet is not IP). .IP If the packet does already contain an MPLS label, pushes a new outermost label as a copy of the existing outermost label. @@ -1992,7 +2026,8 @@ affects the \fBmonitor\fR command. . .IP "\fB\-\-timestamp\fR" Print a timestamp before each received packet. This option only -affects the \fBmonitor\fR and \fBsnoop\fR commands. +affects the \fBmonitor\fR, \fBsnoop\fR, and \fBofp\-parse\-pcap\fR +commands. . .IP "\fB\-m\fR" .IQ "\fB\-\-more\fR"