X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-ofctl.8.in;h=e9e2e6fd5181fce9a94ce5c40c57cac954419dd2;hb=a39edbd4a409ad14b79c2205e340c07185785b92;hp=5fcc60b5794d486097c7bbd5976188cc05766d04;hpb=a8600e1a65b10c7e6b8ca94d18482f50ba27a873;p=openvswitch diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index 5fcc60b5..e9e2e6fd 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -243,7 +243,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. . -.IP "\fBmonitor \fIswitch\fR [\fImiss-len\fR]" +.IP "\fBmonitor \fIswitch\fR [\fImiss-len\fR] [\fIinvalid_ttl\fR]" Connects to \fIswitch\fR and prints to the console all OpenFlow messages received. Usually, \fIswitch\fR should specify the name of a bridge in the \fBovs\-vswitchd\fR database. @@ -256,6 +256,13 @@ does not send these and other asynchronous messages to an specified on this argument. (Thus, if \fImiss\-len\fR is not specified, very little traffic will ordinarily be printed.) .IP +.IP +If \fBinvalid_ttl\fR is passed, \fBovs\-ofctl\fR sends an OpenFlow ``set +configuration'' message at connection setup time that requests +\fIINVALID_TTL_TO_CONTROLLER\fR, so that \fBovs\-ofctl monitor\fR can +receive ``packets-in'' messages when TTL reaches zero on \fBdec_ttl\fR action. +.IP + This command may be useful for debugging switch or controller implementations. . @@ -737,7 +744,7 @@ Sets the TCP or UDP source port to \fIport\fR. Sets the TCP or UDP destination port to \fIport\fR. . .IP \fBmod_nw_tos\fB:\fItos\fR -Sets the IP ToS/DSCP field to \fItos\fR. Valid values are between 0 and +Sets the IPv4 ToS/DSCP field to \fItos\fR. Valid values are between 0 and 255, inclusive. Note that the two lower reserved bits are never modified. . @@ -778,6 +785,16 @@ OpenFlow implementations do not support queuing at all. Restores the queue to the value it was before any \fBset_queue\fR actions were applied. . +.IP \fBdec_ttl\fR +Decrement TTL of IPv4 packet or hop limit of IPv6 packet. If the +TTL or hop limit is initially zero, no decrement occurs. Instead, +a ``packet-in'' message with reason code \fBOFPR_INVALID_TTL\fR is +sent to each connected controller that has enabled receiving them, +if any. Processing the current set of actions then stops. +However, if the current set of actions was reached through +``resubmit'' then remaining actions in outer levels resume +processing. +. .IP \fBnote:\fR[\fIhh\fR]... Does nothing at all. Any number of bytes represented as hex digits \fIhh\fR may be included. Pairs of hex digits may be separated by @@ -933,15 +950,22 @@ further actions, including those which may be in other tables, or different levels of the \fBresubmit\fR call stack, are ignored. . .PP -The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands -support an additional optional field: +An opaque identifier called a cookie can be used as a handle to identify +a set of flows: . -.IP \fBcookie=\fIvalue\fR +.IP \fBcookie=\fIvalue\fR[\fB/\fImask\fR] . -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. If this field is omitted, these commands set a default cookie -value of 0. +A cookie can be associated with a flow using the \fBadd-flow\fR and +\fBadd-flows\fR commands. \fIvalue\fR can be any 64-bit number and need +not be unique among flows. If this field is omitted, a default cookie +value of 0 is used. +.IP +When using NXM, the cookie can be used as a handle for querying, +modifying, and deleting flows. In addition to \fIvalue\fR, an optional +\fImask\fR may be supplied for the \fBdel-flows\fR, \fBmod-flows\fR, +\fBdump-flows\fR, and \fBdump-aggregate\fR commands to limit matching +cookies. A 1-bit in \fImask\fR indicates that the corresponding bit in +\fIcookie\fR must match exactly, and a 0-bit wildcards that bit. . .PP The following additional field sets the priority for flows added by @@ -1042,16 +1066,49 @@ above table, overrides \fBovs\-ofctl\fR's default choice of flow format. If a command cannot work as requested using the requested flow format, \fBovs\-ofctl\fR will report a fatal error. . +. +.IP "\fB\-P \fIformat\fR" +.IQ "\fB\-\-packet\-in\-format=\fIformat\fR" +\fBovs\-ofctl\fR supports the following packet_in formats, in order of +increasing capability: +.RS +.IP "\fBopenflow10\fR" +This is the standard OpenFlow 1.0 packet in format. It should be supported by +all OpenFlow switches. +. +.IP "\fBnxm\fR (Nicira Extended Match)" +This packet_in format includes flow metadata encoded using the NXM format. +. +.RE +.IP +Usually, \fBovs\-ofctl\fR prefers the \fBnxm\fR packet_in format, but will +allow the switch to choose its default if \fBnxm\fR is unsupported. When +\fIformat\fR is one of the formats listed in the above table, \fBovs\-ofctl\fR +will insist on the selected format. If the switch does not support the +requested format, \fBovs\-ofctl\fR will report a fatal error. This option only +affects the \fBmonitor\fR command. +. .IP "\fB\-m\fR" .IQ "\fB\-\-more\fR" Increases the verbosity of OpenFlow messages printed and logged by \fBovs\-ofctl\fR commands. Specify this option more than once to increase verbosity further. +. +.ds DD \ +\fBovs\-ofctl\fR detaches only when executing the \fBmonitor\fR or \ +\fBsnoop\fR commands. +.so lib/daemon.man .SS "Public Key Infrastructure Options" .so lib/ssl.man .so lib/vlog.man .so lib/common.man . +.SH "RUNTIME MANAGEMENT COMMANDS" +\fBovs\-appctl\fR(8) can send commands to a running \fBovs\-ofctl\fR process. +The currently supported commands only apply when executing the \fBmonitor\fR or +\fBsnoop\fR commands and are described below. +.IP "\fBexit\fR" +Causes \fBovs\-ofctl\fR to gracefully terminate. .SH EXAMPLES . The following examples assume that \fBovs\-vswitchd\fR has a bridge