2 .TH ovs\-dpctl\-top "8" "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
5 \fBovs\-dpctl\-top\fR \- Top like behavior for ovs\-dpctl dump\-flows
8 \fBovs\-dpctl\-top\fR [\-h] [\-v] [\-f FLOWFILES] [\-V] [\-s] [\-\-host HOST]
9 [\-a | \-\-accumulate] [\-\-accumulate\-decay ACCUMULATEDECAY] [\-d DELAY]
13 This program summarizes \fBovs\-dpctl\fR flow content by aggregating the number
14 of packets, total bytes and occurrence of the following fields:
20 \- Source and destination MAC addresses
24 \- Source and destination IPv4 addresses
26 \- Source and destination IPv6 addresses
28 \- UDP and TCP destination port
30 \- Tunnel source and destination addresses
32 .SS "Output shows four values:"
34 \- FIELDS: the flow fields for example in_port(1).
36 \- COUNT: the number of lines in the dump\-flow output contain the flow field.
38 \- PACKETS: the total number of packets containing the flow field.
40 \- BYTES: the total number of bytes containing the flow field. If units are
41 not present then values are in bytes.
43 \- AVERAGE: the average packets size (BYTES/PACKET).
47 While in top mode, the default behavior, the following single character commands
50 a \- toggles top in accumulate and live mode. Accumulate mode is described
53 s \- toggles which column is used to sort content in decreasing order. A
54 DESC title is placed over the column.
56 _ \- a space indicating to collect dump\-flow content again
58 h \- halt output. Any character will restart sampling
60 f \- cycle through flow fields
66 There are two supported modes: live and accumulate. The default is live.
67 The parameter \fB\-\-accumulate\fR or the 'a' character in top mode enables the
68 latter. In live mode, recent dump\-flow content is presented.
69 Where as accumulate mode keeps track of the prior historical
70 information until the flow is reset not when the flow is purged. Reset
71 flows are determined when the packet count for a flow has decreased from
72 its previous sample. There is one caveat, eventually the system will
73 run out of memory if, after the accumulate\-decay period any flows that
74 have not been refreshed are purged. The goal here is to free memory
75 of flows that are not active. Statistics are not decremented. Their purpose
76 is to reflect the overall history of the flow fields.
78 .SS "Debugging Errors"
80 Parsing errors are counted and displayed in the status line at the beginning
81 of the output. Use the \fB\-\-verbose\fR option with \fB\-\-script to see
82 what output was not parsed, like this:
84 $ ovs\-dpctl dump\-flows | ovs\-dpctl\-top \fB\-\-script\fR \fB\-\-verbose\fR
86 Error messages will identify content that failed to parse.
88 .SS "Access Remote Hosts"
90 The \fB\-\-host\fR must follow the format user@hostname. This script simply
91 calls \&'ssh user@Hostname' without checking for login credentials therefore
92 public keys should be installed on the system identified by hostname, such as:
94 $ ssh\-copy\-id user@hostname
96 Consult ssh\-copy\-id man pages for more details.
102 or to run as a script:
104 $ ovs\-dpctl dump\-flows > dump\-flows.log
106 $ ovs\-dpctl\-top \fB\-\-script\fR \fB\-\-flow\-file\fR dump\-flows.log
109 \fB\-h\fR, \fB\-\-help\fR
110 show this help message and exit.
112 \fB\-v\fR, \fB\-\-version\fR
113 show program's version number and exit.
115 \fB\-f\fR FLOWFILES, \fB\-\-flow\-file\fR FLOWFILES
116 file containing flows from ovs\-dpctl dump\-flow.
118 \fB\-V\fR, \fB\-\-verbose\fR
119 enable debug level verbosity.
121 \fB\-s\fR, \fB\-\-script\fR
122 Run from a script (no user interface).
125 Specify a user@host for retrieving flows see Accessing
126 Remote Hosts for more information.
128 \fB\-a\fR, \fB\-\-accumulate\fR
129 Accumulate dump\-flow content.
131 \fB\-\-accumulate\-decay\fR ACCUMULATEDECAY
132 Decay old accumulated flows. The default is 5 minutes. A value of 0 disables
135 \fB\-d\fR DELAY, \fB\-\-delay\fR DELAY
136 Delay in milliseconds to collect dump\-flow content (sample rate).