utilities/ovs-dpctl-top.8.in

   1 .so lib/ovs.tmac
   2 .TH ovs\-dpctl\-top "8" "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
   3 .
   4 .SH NAME
   5 \fBovs\-dpctl\-top\fR \- Top like behavior for ovs\-dpctl dump\-flows
   6 .
   7 .SH SYNOPSIS
   8 \fBovs\-dpctl\-top\fR [\-h] [\-v] [\-f FLOWFILES] [\-V] [\-s] [\-\-host HOST]
   9 [\-a | \-\-accumulate] [\-\-accumulate\-decay ACCUMULATEDECAY] [\-d DELAY]
  10 .
  11 .SH DESCRIPTION
  12 .PP
  13 This program summarizes \fBovs\-dpctl\fR flow content by aggregating the number
  14 of packets, total bytes and occurrence of the following fields:
  15 .IP
  16 \- Datapath in_port
  17 .IP
  18 \- Ethernet type
  19 .IP
  20 \- Source and destination MAC addresses
  21 .IP
  22 \- IP protocol
  23 .IP
  24 \- Source and destination IPv4 addresses
  25 .IP
  26 \- Source and destination IPv6 addresses
  27 .IP
  28 \- UDP and TCP destination port
  29 .IP
  30 \- Tunnel source and destination addresses
  31 .
  32 .SS "Output shows four values:"
  33 .IP
  34 \- FIELDS: the flow fields for example in_port(1).
  35 .IP
  36 \- COUNT: the number of lines in the dump\-flow output contain the flow field.
  37 .IP
  38 \- PACKETS: the total number of packets containing the flow field.
  39 .IP
  40 \- BYTES: the total number of bytes containing the flow field.  If units are
  41 not present then values are in bytes.
  42 .IP
  43 \- AVERAGE: the average packets size (BYTES/PACKET).
  44 .PP
  45 .SS "Top Behavior"
  46 .PP
  47 While in top mode, the default behavior, the following single character commands
  48 are supported:
  49 .IP
  50 a \- toggles top in accumulate and live mode.  Accumulate mode is described
  51 below.
  52 .IP
  53 s \- toggles which column is used to sort content in decreasing order.  A
  54 DESC title is placed over the column.
  55 .IP
  56 _ \- a space indicating to collect dump\-flow content again
  57 .IP
  58 h \- halt output.  Any character will restart sampling
  59 .IP
  60 f \- cycle through flow fields
  61 .IP
  62 q \- q for quit.
  63 .PP
  64 .SS "Accumulate Mode"
  65 .PP
  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.
  77 .PP
  78 .SS "Debugging Errors"
  79 .PP
  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:
  83 .PP
  84 $ ovs\-dpctl dump\-flows | ovs\-dpctl\-top \fB\-\-script\fR \fB\-\-verbose\fR
  85 .PP
  86 Error messages will identify content that failed to parse.
  87 .PP
  88 .SS "Access Remote Hosts"
  89 .PP
  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:
  93 .PP
  94 $ ssh\-copy\-id user@hostname
  95 .PP
  96 Consult ssh\-copy\-id man pages for more details.
  97 .PP
  98 .SS "Expected usage"
  99 .PP
 100 $ ovs\-dpctl\-top
 101 .PP
 102 or to run as a script:
 103 .PP
 104 $ ovs\-dpctl dump\-flows > dump\-flows.log
 105 .PP
 106 $ ovs\-dpctl\-top \fB\-\-script\fR \fB\-\-flow\-file\fR dump\-flows.log
 107 .SS "OPTIONS"
 108 .TP
 109 \fB\-h\fR, \fB\-\-help\fR
 110 show this help message and exit.
 111 .TP
 112 \fB\-v\fR, \fB\-\-version\fR
 113 show program's version number and exit.
 114 .TP
 115 \fB\-f\fR FLOWFILES, \fB\-\-flow\-file\fR FLOWFILES
 116 file containing flows from ovs\-dpctl dump\-flow.
 117 .TP
 118 \fB\-V\fR, \fB\-\-verbose\fR
 119 enable debug level verbosity.
 120 .TP
 121 \fB\-s\fR, \fB\-\-script\fR
 122 Run from a script (no user interface).
 123 .TP
 124 \fB\-\-host\fR HOST
 125 Specify a user@host for retrieving flows see Accessing
 126 Remote Hosts for more information.
 127 .TP
 128 \fB\-a\fR, \fB\-\-accumulate\fR
 129 Accumulate dump\-flow content.
 130 .TP
 131 \fB\-\-accumulate\-decay\fR ACCUMULATEDECAY
 132 Decay old accumulated flows.  The default is 5 minutes. A value of 0 disables
 133 decay.
 134 .TP
 135 \fB\-d\fR DELAY, \fB\-\-delay\fR DELAY
 136 Delay in milliseconds to collect dump\-flow content (sample rate).