X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=9923715904235ef754267dadea811e09ae92342e;hb=HEAD;hp=e5e488abda82559825e1f5467193df0b9671d9ad;hpb=99ab7312c17cd4ab603eb6194c50b9f1ef3ca1c9;p=sliver-openvswitch.git diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index e5e488abd..992371590 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -58,6 +58,10 @@ information on its flow tables and ports. \fBdump\-tables \fIswitch\fR Prints to the console statistics for each of the flow tables used by \fIswitch\fR. +.TP +\fBdump\-table\-features \fIswitch\fR +Prints to the console features for each of the flow tables used by +\fIswitch\fR. . .TP \fBdump\-ports \fIswitch\fR [\fInetdev\fR] @@ -487,6 +491,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 +747,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. @@ -926,7 +953,7 @@ 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. +\fBarp_tpa\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. @@ -1187,14 +1214,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. @@ -1952,6 +1979,11 @@ format. .IQ "\fBOXM-OpenFlow13\fR" These are the standard OXM (OpenFlow Extensible Match) flow format in OpenFlow 1.2 and 1.3, respectively. +.IP "\fBOXM-OpenFlow14\fR" +The standard OXM (OpenFlow Extensible Match) flow format in OpenFlow +1.4. OpenFlow 1.4 is not yet well supported; in particular, the +implementation is unsafe, such that sending an unsupported message in +OpenFlow 1.4 to \fBovs\-vswitchd\fR can cause it to crash. .RE . .IP @@ -1959,13 +1991,15 @@ OpenFlow 1.2 and 1.3, respectively. collections of flow formats: .RS .IP "\fBany\fR" -Any supported flow format. +Any supported flow format except \fBOXM-OpenFlow14\fR, which is not +yet well supported (see above). .IP "\fBOpenFlow10\fR" \fBOpenFlow10\-table_id\fR or \fBOpenFlow10+table_id\fR. .IP "\fBNXM\fR" \fBNXM\-table_id\fR or \fBNXM+table_id\fR. .IP "\fBOXM\fR" -\fBOXM-OpenFlow12\fR or \fBOXM-OpenFlow13\fR. +\fBOXM-OpenFlow12\fR or \fBOXM-OpenFlow13\fR. \fBOXM-OpenFlow14\fR is +not included because it is not yet well supported (see above). .RE . .IP @@ -2003,7 +2037,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"