summaryrefslogtreecommitdiff
path: root/utilities/ovs-ofctl.8.in
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2014-05-07 23:18:46 -0700
committerBen Pfaff <blp@nicira.com>2014-05-14 10:31:44 -0700
commit70ae4f930cf99d0604f5e724f8f79bf08d11f263 (patch)
tree9f0870972bd2c81cd7f138a3d561a1e8a2afb8e5 /utilities/ovs-ofctl.8.in
parent19187a715fcaf09840cbf9e994972152d0cb9880 (diff)
downloadopenvswitch-70ae4f930cf99d0604f5e724f8f79bf08d11f263.tar.gz
Implement OpenFlow 1.5 port desc stats request.
OpenFlow 1.4 and earlier always send the description of every port in response to an OFPMP_PORT_DESC request. OpenFlow 1.5 proposes allowing the controller to request a description of a single port. This commit implements a prototype. EXT-69. Signed-off-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'utilities/ovs-ofctl.8.in')
-rw-r--r--utilities/ovs-ofctl.8.in16
1 files changed, 12 insertions, 4 deletions
diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index 16d6d930e..fc264c72c 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -70,11 +70,19 @@ Prints to the console statistics for network devices associated with
associated with that device will be printed. \fInetdev\fR can be an
OpenFlow assigned port number or device name, e.g. \fBeth0\fR.
.
-.TP
-\fBdump\-ports\-desc \fIswitch\fR
+.IP "\fBdump\-ports\-desc \fIswitch\fR [\fIport\fR]"
Prints to the console detailed information about network devices
-associated with \fIswitch\fR (version 1.7 or later). This is a subset
-of the information provided by the \fBshow\fR command.
+associated with \fIswitch\fR. To dump only a specific port, specify
+its number as \fIport\fR. Otherwise, if \fIport\fR is omitted, or if
+it is specified as \fBANY\fR, then all ports are printed. This is a
+subset of the information provided by the \fBshow\fR command.
+.IP
+If the connection to \fIswitch\fR negotiates OpenFlow 1.0, 1.2, or
+1.2, this command uses an OpenFlow extension only implemented in Open
+vSwitch (version 1.7 and later).
+.IP
+Only OpenFlow 1.5 and later support dumping a specific port. Earlier
+versions of OpenFlow always dump all ports.
.
.IP "\fBmod\-port \fIswitch\fR \fIport\fR \fIaction\fR"
Modify characteristics of port \fBport\fR in \fIswitch\fR. \fIport\fR