diff mbox

[ovs-dev] ofproto: Add some examples for 'ofproto/trace' in ovs-vswitchd man page

Message ID f6744d1656573053c08e084ff642cabdb00f03c4.1489167217.git.tredaelli@redhat.com
State Superseded
Headers show

Commit Message

Timothy Redaelli March 10, 2017, 6:17 p.m. UTC
Reported-at: https://bugzilla.redhat.com/show_bug.cgi?id=1339097
Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
---
 ofproto/ofproto-unixctl.man | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

Comments

Ben Pfaff March 10, 2017, 6:45 p.m. UTC | #1
On Fri, Mar 10, 2017 at 07:17:28PM +0100, Timothy Redaelli wrote:
> Reported-at: https://bugzilla.redhat.com/show_bug.cgi?id=1339097
> Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>

Thanks for the examples!

These first two look a little odd.  It wouldn't normally make sense to
include a mask on any field in an ofproto/trace request, like the masks
shown on the dl_dst fields below.  What's the goal there?
> +\fBTrace an unicast ICMP echo request on ingress port 1\fR
> +.RS 4
> +.nf
> +ofproto/trace br in_port=1,icmp,icmp_type=8,\\
> +dl_dst=00:00:00:00:00:00/01:00:00:00:00:00
> +.RE
> +.fi
> +.PP
> +\fBTrace an unicast ICMP echo reply on ingress port 1\fR
> +.RS 4
> +.nf
> +ofproto/trace br in_port=1,icmp,icmp_type=0,\\
> +dl_dst=00:00:00:00:00:00/01:00:00:00:00:00


Thanks,

Ben.
diff mbox

Patch

diff --git a/ofproto/ofproto-unixctl.man b/ofproto/ofproto-unixctl.man
index ce4f7a2..d61fc3e 100644
--- a/ofproto/ofproto-unixctl.man
+++ b/ofproto/ofproto-unixctl.man
@@ -135,3 +135,37 @@  necessary because the command does not ordinarily imply a particular
 OpenFlow version.  One exception is that, when \fIactions\fR includes
 an action that only OpenFlow 1.1 and later supports (such as
 \fBpush_vlan\fR), \fB\-consistent\fR is automatically enabled.
+.
+.IP "Usage examples:"
+.RS 4
+.PP
+\fBTrace an unicast ICMP echo request on ingress port 1\fR
+.RS 4
+.nf
+ofproto/trace br in_port=1,icmp,icmp_type=8,\\
+dl_dst=00:00:00:00:00:00/01:00:00:00:00:00
+.RE
+.fi
+.PP
+\fBTrace an unicast ICMP echo reply on ingress port 1\fR
+.RS 4
+.nf
+ofproto/trace br in_port=1,icmp,icmp_type=0,\\
+dl_dst=00:00:00:00:00:00/01:00:00:00:00:00
+.fi
+.RE
+.PP
+\fBTrace an ARP request on ingress port 1\fR
+.RS 4
+.nf
+ofproto/trace br in_port=1,arp,arp_op=1
+.fi
+.RE
+.PP
+\fBTrace an ARP reply on ingress port 1\fR
+.RS 4
+.nf
+ofproto/trace br in_port=1,arp,arp_op=2
+.fi
+.RE
+.RE