X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=06d61deeaf2ba63e31a4053c22fb661f9d67326c;hb=e7b3e606b2f6054bc20518d64100ae501b3e6ef3;hp=ec9129d2411c68838b31a198bddda96dbd28376f;hpb=9b45d7f5db91cdb41eb0a2124d92885d3b3edcc9;p=sliver-openvswitch.git diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index ec9129d24..06d61deea 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -117,34 +117,60 @@ If only \fIqueue\fR is omitted, then statistics are printed for all queues on \fIport\fR; if only \fIport\fR is omitted, then statistics are printed for \fIqueue\fR on every port where it exists. . -.TP -\fBadd\-flow \fIswitch flow\fR -Add the flow entry as described by \fIflow\fR to the \fIswitch\fR's -tables. The flow entry is in the format described in \fBFlow Syntax\fR, -below. -. -.TP -\fBadd\-flows \fIswitch file\fR -Add the flow entries listed in \fIfile\fR, or supplied on \fBstdin\fR -if \fIfile\fR is \fB\-\fR, to \fIswitch\fR's -tables. Each line in \fIfile\fR is a flow entry in the format -described in \fBFlow Syntax\fR, below. -. -.TP -\fBmod\-flows \fIswitch flow\fR -Modify the actions in entries from the \fIswitch\fR's tables -that match \fIflow\fR. When invoked with the \fB\-\-strict\fR option, -wildcards are not treated as active for matching purposes. See -\fBFlow Syntax\fR, below, for the syntax of \fIflows\fR. +.SS "OpenFlow Switch Flow Table Commands" +. +These commands manage the flow table in an OpenFlow switch. In each +case, \fIflow\fR specifies a flow entry in the format described in +\fBFlow Syntax\fR, below, and \fIfile\fR is a text file that contains +zero or more flows in the same syntax, one per line. +. +.IP "\fBadd\-flow \fIswitch flow\fR" +.IQ "\fBadd\-flow \fIswitch \fB\- < \fIfile\fR" +.IQ "\fBadd\-flows \fIswitch file\fR" +Add each flow entry to \fIswitch\fR's tables. +. +.IP "[\fB\-\-strict\fR] \fBmod\-flows \fIswitch flow\fR" +.IQ "[\fB\-\-strict\fR] \fBmod\-flows \fIswitch \fB\- < \fIfile\fR" +Modify the actions in entries from \fIswitch\fR's tables that match +the specified flows. With \fB\-\-strict\fR, wildcards are not treated +as active for matching purposes. +. +.IP "\fBdel\-flows \fIswitch\fR" +.IQ "[\fB\-\-strict\fR] \fBdel\-flows \fIswitch \fR[\fIflow\fR]" +.IQ "[\fB\-\-strict\fR] \fBdel\-flows \fIswitch \fB\- < \fIfile\fR" +Deletes entries from \fIswitch\fR's flow table. With only a +\fIswitch\fR argument, deletes all flows. Otherwise, deletes flow +entries that match the specified flows. With \fB\-\-strict\fR, +wildcards are not treated as active for matching purposes. +. +.IP "\fBreplace\-flows \fIswitch file\fR" +Reads flow entries from \fIfile\fR (or \fBstdin\fR if \fIfile\fR is +\fB\-\fR) and queries the flow table from \fIswitch\fR. Then it fixes +up any differences, adding flows from \fIflow\fR that are missing on +\fIswitch\fR, deleting flows from \fIswitch\fR that are not in +\fIfile\fR, and updating flows in \fIswitch\fR whose actions, cookie, +or timeouts differ in \fIfile\fR. +. +.IP "\fBdiff\-flows \fIsource1 source2\fR" +Reads flow entries from \fIsource1\fR and \fIsource2\fR and prints the +differences. A flow that is in \fIsource1\fR but not in \fIsource2\fR +is printed preceded by a \fB\-\fR, and a flow that is in \fIsource2\fR +but not in \fIsource1\fR is printed preceded by a \fB+\fR. If a flow +exists in both \fIsource1\fR and \fIsource2\fR with different actions, +cookie, or timeouts, then both versions are printed preceded by +\fB\-\fR and \fB+\fR, respectively. +.IP +\fIsource1\fR and \fIsource2\fR may each name a file or a switch. If +a name begins with \fB/\fR or \fB.\fR, then it is considered to be a +file name. A name that contains \fB:\fR is considered to be a switch. +Otherwise, it is a file if a file by that name exists, a switch if +not. +.IP +For this command, an exit status of 0 means that no differences were +found, 1 means that an error occurred, and 2 means that some +differences were found. . -.TP -\fBdel\-flows \fIswitch \fR[\fIflow\fR] -Deletes entries from the \fIswitch\fR's tables that match -\fIflow\fR. When invoked with the \fB\-\-strict\fR option, wildcards are -not treated as active for matching purposes. If \fIflow\fR is -omitted and the \fB\-\-strict\fR option is not used, all flows in the -switch's tables are removed. See \fBFlow Syntax\fR, below, for the -syntax of \fIflows\fR. +.SS "OpenFlow Switch Monitoring Commands" . .IP "\fBsnoop \fIswitch\fR" Connects to \fIswitch\fR and prints to the console all OpenFlow @@ -171,7 +197,7 @@ If a switch has no controller configured, or if the configured controller is disconnected, no traffic is sent, so monitoring will not show any traffic. . -.IQ "\fBmonitor \fIswitch\fR [\fImiss-len\fR]" +.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 @@ -339,6 +365,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: . @@ -616,6 +661,19 @@ Currently, \fIfields\fR must be either \fBeth_src\fR or the \fBiter_hash\fR algorithm uses \fIarg\fR. .IP Refer to \fBnicira\-ext.h\fR for more details. +. +.IP "\fBautopath(\fIid\fB, \fIdst\fB[\fIstart\fB..\fIend\fB])\fR" +Given \fIid\fR, chooses an OpenFlow port and populates it in +\fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM register as +described above. +.IP +Currently, \fIid\fR should be the OpenFlow port number of an interface on the +bridge. If it isn't then \fIdst\fB[\fIstart\fB..\fIend\fB]\fR will be +populated with the OpenFlow port "none". If \fIid\fR is a member of a bond, +the normal bond selection logic will be used to choose the destination port. +Otherwise, the register will be populated with \fIid\fR itself. +.IP +Refer to \fBnicira\-ext.h\fR for more details. .RE . .IP @@ -674,14 +732,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 @@ -725,11 +775,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