contrib/ofed/management/infiniband-diags/man/perfquery.8

   1 .TH PERFQUERY 8 "March 29, 2007" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 perfquery \- query InfiniBand port counters
   5
   6 .SH SYNOPSIS
   7 .B perfquery
   8 [\-d(ebug)] [\-G(uid)] [-e(xtended)] [-a(ll_ports)] [-l(oop_ports)] [-r(eset_after_read)] [-R(eset_only)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-h(elp)] [<lid|guid> [[port] [reset_mask]]]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 perfquery uses PerfMgt GMPs to obtain the PortCounters (basic performance
  13 and error counters) or PortExtendedCounters from the PMA at the node/port
  14 specified. Optionally shows aggregated counters for all ports of node.
  15 Also, optionally, reset after read, or only reset counters.
  16
  17 Note: In both PortCounters and PortCountersExtended, components
  18 that represent Data (e.g. PortXmitData and PortRcvData) indicate octets
  19 divided by 4 rather than just octets.
  20
  21 Note: Inputting a port of 255 indicates an operation be performed on all ports.
  22
  23 .SH OPTIONS
  24
  25 .PP
  26 .TP
  27 \fB\-e\fR, \fB\-\-extended\fR
  28 show extended port counters rather than (basic) port counters.
  29 Note that extended port counters attribute is optional.
  30 .TP
  31 \fB\-a\fR, \fB\-\-all_ports\fR
  32 show aggregated counters for all ports of the destination lid
  33 or reset all counters for all ports.  If the destination lid
  34 does not support the AllPortSelect flag, all ports will be
  35 iterated through to emulate AllPortSelect behavior.
  36 .TP
  37 \fB\-l\fR, \fB\-\-loop_ports\fR
  38 If all ports are selected by the user (either through the
  39 \fB\-a\fR option or port 255) iterate through each port
  40 rather than doing than aggregate operation.
  41 .TP
  42 \fB\-r\fR, \fB\-\-reset_after_read\fR
  43 reset counters after read
  44 .TP
  45 \fB\-R\fR, \fB\-\-Reset_only\fR
  46 only reset counters
  47
  48 .SH COMMON OPTIONS
  49
  50 Most OpenIB diagnostics take the following common flags. The exact list of
  51 supported flags per utility can be found in the usage message and can be shown
  52 using the util_name -h syntax.
  53
  54 # Debugging flags
  55 .PP
  56 \-d      raise the IB debugging level.
  57         May be used several times (-ddd or -d -d -d).
  58 .PP
  59 \-e      show send and receive errors (timeouts and others)
  60 .PP
  61 \-h      show the usage message
  62 .PP
  63 \-v      increase the application verbosity level.
  64         May be used several times (-vv or -v -v -v)
  65 .PP
  66 \-V      show the version info.
  67
  68 # Addressing flags
  69 .PP
  70 \-G      use GUID address argument. In most cases, it is the Port GUID.
  71         Example:
  72         "0x08f1040023"
  73 .PP
  74 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  75
  76 # Other common flags:
  77 .PP
  78 \-C <ca_name>    use the specified ca_name.
  79 .PP
  80 \-P <ca_port>    use the specified ca_port.
  81 .PP
  82 \-t <timeout_ms> override the default timeout for the solicited mads.
  83
  84 Multiple CA/Multiple Port Support
  85
  86 When no IB device or port is specified, the port to use is selected
  87 by the following criteria:
  88 .PP
  89 1. the first port that is ACTIVE.
  90 .PP
  91 2. if not found, the first port that is UP (physical link up).
  92
  93 If a port and/or CA name is specified, the user request is
  94 attempted to be fulfilled, and will fail if it is not possible.
  95
  96 .SH EXAMPLES
  97
  98 .PP
  99 perfquery               # read local port performance counters
 100 .PP
 101 perfquery 32 1          # read performance counters from lid 32, port 1
 102 .PP
 103 perfquery -e 32 1       # read extended performance counters from lid 32, port 1
 104 .PP
 105 perfquery -a 32         # read perf counters from lid 32, all ports
 106 .PP
 107 perfquery -r 32 1       # read performance counters and reset
 108 .PP
 109 perfquery -e -r 32 1    # read extended performance counters and reset
 110 .PP
 111 perfquery -R 0x20 1     # reset performance counters of port 1 only
 112 .PP
 113 perfquery -e -R 0x20 1  # reset extended performance counters of port 1 only
 114 .PP
 115 perfquery -R -a 32      # reset performance counters of all ports
 116 .PP
 117 perfquery -R 32 2 0x0fff # reset only error counters of port 2
 118 .PP
 119 perfquery -R 32 2 0xf000 # reset only non-error counters of port 2
 120
 121 .SH AUTHOR
 122 .TP
 123 Hal Rosenstock
 124 .RI < halr@voltaire.com >