X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=c44de463bc33fe98ee785305140d5b1f5732cd01;hb=eeba8e4fd3b9ae3c69fbf3ae9ef28a55184ac12a;hp=95b0884293af9fcd1e9122e992874cb41f79f14b;hpb=685a51a5b89750cead1b2934c2079d2bb9c52a4a;p=openvswitch diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index 95b08842..c44de463 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -54,13 +54,6 @@ Prints to the console information on \fIswitch\fR, including information on its flow tables and ports. . .TP -\fBstatus \fIswitch\fR [\fIkey\fR] -Prints to the console a series of key-value pairs that report the -status of \fIswitch\fR. If \fIkey\fR is specified, only the key-value -pairs whose key names begin with \fIkey\fR are printed. If \fIkey\fR is -omitted, all key-value pairs are printed. -. -.TP \fBdump\-tables \fIswitch\fR Prints to the console statistics for each of the flow tables used by \fIswitch\fR. @@ -124,33 +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 flow entries as described in \fIfile\fR to \fIswitch\fR's -tables. Each line in \fIfile\fR is a flow entry in the format -described in \fBFlow Syntax\fR, below. +.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 -\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. -. -.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 @@ -177,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 @@ -622,6 +642,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 @@ -731,11 +764,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