X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=c59bca9316896d2d712d5d4900478839ad6634cd;hb=6da1e8091eb2e19de7ba5e0c73ac3e7dd437743d;hp=2e866dc51576b1d35bafbd37abe68302bae94d0c;hpb=cb8ca532a6636d20c9d7e4a5323489cad9c3eeb7;p=sliver-openvswitch.git diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index 2e866dc51..c59bca931 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -143,7 +143,7 @@ Deletes entries from \fIswitch\fR's flow table. With only a 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" +.IP "[\fB\-\-readd\fR] \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 @@ -151,6 +151,12 @@ up any differences, adding flows from \fIflow\fR that are missing on \fIfile\fR, and updating flows in \fIswitch\fR whose actions, cookie, or timeouts differ in \fIfile\fR. . +.IP +With \fB\-\-readd\fR, \fBovs\-ofctl\fR adds all the flows from +\fIfile\fR, even those that exist with the same actions, cookie, and +timeout in \fIswitch\fR. This resets all the flow packet and byte +counters to 0, which can be useful for debugging. +. .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 @@ -428,6 +434,43 @@ Extended Match) extension to OpenFlow. When one of these is specified, extension. If the switch does not support NXM, then \fBovs\-ofctl\fR will report a fatal error. . +.IP \fBvlan_tci=\fItci\fR[\fB/\fImask\fR] +Matches modified VLAN TCI \fItci\fR. If \fImask\fR is omitted, +\fItci\fR is the exact VLAN TCI to match; if \fImask\fR is specified, +then a 1-bit in \fItci\fR indicates that the corresponding bit in +\fItci\fR must match exactly, and a 0-bit wildcards that bit. Both +\fItci\fR and \fImask\fR are 16-bit values that are decimal by +default; use a \fB0x\fR prefix to specify them in hexadecimal. +. +.IP +The value that \fBvlan_tci\fR matches against is 0 for a packet that +has no 802.1Q header. Otherwise, it is the TCI value from the 802.1Q +header with the CFI bit (with value \fB0x1000\fR) forced to 1. +.IP +Examples: +.RS +.IP \fBvlan_tci=0\fR +Match only packets without an 802.1Q header. +.IP \fBvlan_tci=0xf123\fR +Match packets tagged with priority 7 in VLAN 0x123. +.IP \fBvlan_tci=0x1123/0x1fff\fR +Match packets tagged with VLAN 0x123 (and any priority). +.IP \fBvlan_tci=0x5000/0xf000\fR +Match packets tagged with priority 2 (in any VLAN). +.IP \fBvlan_tci=0/0xfff\fR +Match packets with no 802.1Q header or tagged with VLAN 0 (and any +priority). +.IP \fBvlan_tci=0x5000/0xe000\fR +Match packets with no 802.1Q header or tagged with priority 2 (in any +VLAN). +.IP \fBvlan_tci=0/0xefff\fR +Match packets with no 802.1Q header or tagged with VLAN 0 and priority +0. +.RE +.IP +Some of these matching possibilities can also be achieved with +\fBdl_vlan\fR and \fBdl_vlan_pcp\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 ARP, \fBarp_sha\fR and \fBarp_tha\fR match @@ -511,8 +554,13 @@ Same as \fBdl_type=0x86dd,nw_proto=17\fR. Same as \fBdl_type=0x86dd,nw_proto=58\fR. . .PP -The \fBadd\-flow\fR and \fBadd\-flows\fR commands require an additional -field, which must be the final field specified: +Finally, field assignments to \fBduration\fR, \fBn_packets\fR, or +\fBn_bytes\fR are ignored to allow output from the \fBdump\-flows\fR +command to be used as input for other commands that parse flows. +. +.PP +The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands +require an additional field, which must be the final field specified: . .IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR Specifies a comma-separated list of actions to take on a packet when the @@ -554,6 +602,9 @@ omitted, then the entire packet is sent. Outputs the packet on the ``local port,'' which corresponds to the network device that has the same name as the bridge. . +.IP \fBin_port\fR +Outputs the packet on the port from which it was received. +. .IP \fBdrop\fR Discards the packet, so no further processing or forwarding takes place. If a drop action is used, no other actions may be specified. @@ -618,16 +669,6 @@ then this uses an action extension that is supported by Open vSwitch 1.0 and later. Otherwise, if \fIid\fR is a 64-bit value, it requires Open vSwitch 1.1 or later. . -.IP \fBdrop_spoofed_arp\fR -Stops processing further actions, if the packet being processed is an -Ethernet+IPv4 ARP packet for which the source Ethernet address inside -the ARP packet differs from the source Ethernet address in the -Ethernet header. -.IP -This action is deprecated in favor of defining flows using the -\fBarp_sha\fR match field described earlier and will likely be removed -in a future version of Open vSwitch. -. .IP \fBset_queue\fB:\fIqueue\fR Sets the queue that should be used to \fIqueue\fR when packets are output. The number of supported queues depends on the switch; some @@ -670,7 +711,7 @@ Hashes \fIfields\fR using \fIbasis\fR as a universal hash parameter, then the applies multipath link selection \fIalgorithm\fR (with parameter \fIarg\fR) to choose one of \fIn_links\fR output links numbered 0 through \fIn_links\fR minus 1, and stores the link into -\fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM register as +\fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as described above. .IP Currently, \fIfields\fR must be either \fBeth_src\fR or @@ -682,7 +723,7 @@ 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 +\fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as described above. .IP Currently, \fIid\fR should be the OpenFlow port number of an interface on the @@ -692,6 +733,35 @@ 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. +. +.IP "\fBbundle(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIslave_type\fB, slaves:[\fIs1\fB, \fIs2\fB, ...])\fR" +Hashes \fIfields\fR using \fIbasis\fR as a universal hash parameter, then +applies the bundle link selection \fIalgorithm\fR to choose one of the listed +slaves represented as \fIslave_type\fR. Currently the only supported +\fIslave_type\fR is \fBofport\fR. Thus, each \fIs1\fR through \fIsN\fR should +be an OpenFlow port number. Outputs to the selected slave. +.IP +Currently, \fIfields\fR must be either \fBeth_src\fR or \fBsymmetric_l4\fR and +\fIalgorithm\fR must be one of \fBhrw\fR and \fBactive_backup\fR. +.IP +Example: \fBbundle(eth_src,0,hrw,ofport,slaves:4,8)\fR uses an Ethernet source +hash with basis 0, to select between OpenFlow ports 4 and 8 using the Highest +Random Weight algorithm. +.IP +Refer to \fBnicira\-ext.h\fR for more details. +. +.IP "\fBbundle_load(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIslave_type\fB, \fIdst\fB[\fIstart\fB..\fIend\fB], slaves:[\fIs1\fB, \fIs2\fB, ...])\fR" +Has the same behavior as the \fBbundle\fR action, with one exception. Instead +of outputting to the selected slave, it writes its selection to +\fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as described +above. +.IP +Example: \fBbundle_load(eth_src,0,hrw,ofport,NXM_NX_REG0[],slaves:4,8)\fR uses +an Ethernet source hash with basis 0, to select between OpenFlow ports 4 and 8 +using the Highest Random Weight algorithm, and writes the selection to +\fBNXM_NX_REG0[]\fR. +.IP +Refer to \fBnicira\-ext.h\fR for more details. .RE . .IP @@ -706,14 +776,15 @@ support an additional optional field: . A cookie is an opaque identifier that can be associated with the flow. \fIvalue\fR can be any 64-bit number and need not be unique among -flows. +flows. If this field is omitted, these commands set a default cookie +value of 0. . .PP The following additional field sets the priority for flows added by the \fBadd\-flow\fR and \fBadd\-flows\fR commands. For \fBmod\-flows\fR and \fBdel\-flows\fR when \fB\-\-strict\fR is specified, priority must match along with the rest of the flow -specification. Other commands ignore the priority value. +specification. Other commands do not allow priority to be specified. . .IP \fBpriority=\fIvalue\fR The priority at which a wildcarded entry will match in comparison to @@ -746,10 +817,6 @@ and \fBdel\-flows\fR commands support one additional optional field: \fBout_port=\fIport\fR If set, a matching flow must include an output action to \fIport\fR. . -.PP -The \fBdump\-flows\fR and \fBdump\-aggregate\fR commands support an -additional optional field: -. .SS "Table Entry Output" . The \fBdump\-tables\fR and \fBdump\-aggregate\fR commands print information