X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=2e866dc51576b1d35bafbd37abe68302bae94d0c;hb=8628b0b71d1cf5b3bd7425e50f0aa1435aa38804;hp=d9742c8ec17ca084273fbacdcc4f3b4261d8a572;hpb=3b6a2571f07e153e850a9bf2044699d8d4434ef0;p=openvswitch diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index d9742c8e..2e866dc5 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -199,9 +199,8 @@ monitoring will not show any traffic. . .IP "\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 \fBovs\-openflowd\fR(8)'s \fB\-l\fR or \fB\-\-listen\fR command line -option. +messages received. Usually, \fIswitch\fR should specify the name of a +bridge in the \fBovs\-vswitchd\fR database. .IP If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set configuration'' message at connection setup time that requests @@ -291,6 +290,26 @@ Matches an Ethernet source (or destination) address specified as 6 pairs of hexadecimal digits delimited by colons (e.g. \fB00:0A:E4:25:6B:B0\fR). . +.IP \fBdl_dst=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB/\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR +Matches an Ethernet destination address specified as 6 pairs of +hexadecimal digits delimited by colons (e.g. \fB00:0A:E4:25:6B:B0\fR), +with a wildcard mask following the slash. Only +the following masks are allowed: +.RS +.IP \fB01:00:00:00:00:00\fR +Match only the multicast bit. Thus, +\fBdl_dst=01:00:00:00:00:00/01:00:00:00:00:00\fR matches all multicast +(including broadcast) Ethernet packets, and +\fBdl_dst=00:00:00:00:00:00/01:00:00:00:00:00\fR matches all unicast +Ethernet packets. +.IP \fBfe:ff:ff:ff:ff:ff\fR +Match all bits except the multicast bit. This is probably not useful. +.IP \fBff:ff:ff:ff:ff:ff\fR +Exact match (equivalent to omitting the mask). +.IP \fB00:00:00:00:00:00\fR +Wildcard all bits (equivalent to \fBdl_dst=*\fR.) +.RE +. .IP \fBdl_type=\fIethertype\fR Matches Ethernet protocol type \fIethertype\fR, which is specified as an integer between 0 and 65535, inclusive, either in decimal or as a @@ -365,6 +384,25 @@ specified as a decimal number between 0 and 255, inclusive. When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of these settings are ignored (see \fBFlow Syntax\fR above). . +.IP \fBtable=\fInumber\fR +If specified, limits the flow manipulation and flow dump commands to +only apply to the table with the given \fInumber\fR. +\fInumber\fR is a number between 0 and 254, inclusive. +. +Behavior varies if \fBtable\fR is not specified. For flow table +modification commands without \fB\-\-strict\fR, the switch will choose +the table for these commands to operate on. For flow table +modification commands with \fB\-\-strict\fR, the command will operate +on any single matching flow in any table; it will do nothing if there +are matches in more than one table. The \fBdump-flows\fR and +\fBdump-aggregate\fR commands will gather statistics about flows from +all tables. +.IP +When this field is specified in \fBadd-flow\fR, \fBadd-flows\fR, +\fBmod-flows\fR and \fBdel-flows\fR commands, it activates a Nicira +extension to OpenFlow, which as of this writing is only known to be +implemented by Open vSwitch. +. .PP The following shorthand notations are also available: . @@ -514,8 +552,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 -\fBovs\-openflowd\fR(8) for information on the \fBof\fIn\fR network device). +network device that has the same name as the bridge. . .IP \fBdrop\fR Discards the packet, so no further processing or forwarding takes place. @@ -713,14 +750,6 @@ If set, a matching flow must include an output action to \fIport\fR. The \fBdump\-flows\fR and \fBdump\-aggregate\fR commands support an additional optional field: . -.IP \fBtable=\fInumber\fR -If specified, limits the flows about which statistics are gathered to -those in the table with the given \fInumber\fR. Tables are numbered -as shown by the \fBdump\-tables\fR command. -. -If this field is not specified, or if \fInumber\fR is given as -\fB255\fR, statistics are gathered about flows from all tables. -. .SS "Table Entry Output" . The \fBdump\-tables\fR and \fBdump\-aggregate\fR commands print information @@ -764,11 +793,6 @@ increasing capability: This is the standard OpenFlow 1.0 flow format. It should be supported by all OpenFlow switches. . -.IP "\fBtun_id_from_cookie\fR" -This Nicira extension to OpenFlow adds minimal and limited support for -\fBtun_id\fR, but it does not support any other Nicira flow -extensions. (This flow format is deprecated.) -. .IP "\fBnxm\fR (Nicira Extended Match)" This Nicira extension to OpenFlow is flexible and extensible. It supports all of the Nicira flow extensions, such as \fBtun_id\fR and @@ -799,19 +823,16 @@ increase verbosity further. . .SH EXAMPLES . -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 -\fBovs\-openflowd\fR(8) command line. +The following examples assume that \fBovs\-vswitchd\fR has a bridge +named \fBbr0\fR configured. . .TP -\fBovs\-ofctl dump\-tables unix:@RUNDIR@/openflow.sock\fR +\fBovs\-ofctl dump\-tables br0\fR Prints out the switch's table stats. (This is more interesting after some traffic has passed through.) . .TP -\fBovs\-ofctl dump\-flows unix:@RUNDIR@/openflow.sock\fR +\fBovs\-ofctl dump\-flows br0\fR Prints the flow entries in the switch. . .SH "SEE ALSO"