1
2opaextractperf(8)      Master map: IFSFFCLIRG (Man Page)     opaextractperf(8)
3
4
5

NAME

7       opaextractperf
8
9
10
11       Provides  a report of all performance counters in a CVS format suitable
12       for importing into a spreadsheet or parsed by other scripts for further
13       analysis.  It  generates  a detailed opareport component summary report
14       and pipes the result to opaxmlextract, extracting  element  values  for
15       NodeDesc,  SystemImageGUID,  PortNum, and all the performance counters.
16       Extraction is performed only from the Systems portion  of  the  report,
17       which  does not contain Neighbor information (the Neighbor and SMs por‐
18       tions are suppressed).
19

Syntax

21       opaextractperf [opareport options]
22

Options

24       --help    Produces full help text.
25
26
27       opareport options
28                 The following options are passed to opareport. This subset is
29                 considered  typical  and  useful for this command. By design,
30                 the tool ignores -o/--output report option.
31
32
33
34
35                 -h/--hfi hfi
36                           Specifies the HFI, numbered 1..n. Using 0 specifies
37                           that the -p port port is a system-wide port number.
38                           (Default is 0.)
39
40
41
42
43
44                 -p/--port port
45                           Specifies the port, numbered 1..n. Using  0  speci‐
46                           fies the first active port. (Default is 0.)
47
48
49
50
51
52                 -X/--infile snapshot_input
53                           Generates  a  report  using  the  data in the snap‐
54                           shot_input file. snapshot_input must have been gen‐
55                           erated  during  a  previous  -o  snapshot run. When
56                           used, the -s, -i, -C, and -a options  are  ignored.
57                           '-'  may  be  used as the snapshot_input to specify
58                           stdin.
59
60
61
62
63
64                 -T/--topology topology_input
65                           Uses topology_input file to augment and verify fab‐
66                           ric  information. When used, various reports can be
67                           augmented with information not available electroni‐
68                           cally  (such  as  cable labels). '-' may be used to
69                           specify stdin.
70
71
72
73
74
75                 -i/--interval seconds
76                           Obtains performance statistics over  interval  sec‐
77                           onds.  Clears  all  statistics, waits interval sec‐
78                           onds, then generates report. Implies -s option.
79
80
81
82
83
84                 -b / --begin date_time
85                           Obtains past performance  stats  over  an  interval
86                           beginning   at   date_time.   Implies   -s  option.
87                           date_time may be a time entered  as  HH:MM[:SS]  or
88                           date  as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date
89                           followed by time; for example, "2016-07-04  14:40".
90                           Relative    times    are    taken   as   "x   [sec‐
91                           ond|minute|hour|day](s) ago.
92
93
94
95
96
97                 -e / --end date_time
98                           Obtains past performance  stats  over  an  interval
99                           ending at date_time. Implies -s option.
100
101
102                           date_time  may  be  a time entered as HH:MM[:SS] or
103                           date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or  date
104                           followed  by time; for example, "2016-07-04 14:40".
105                           Relative   times   are   taken    as    "x    [sec‐
106                           ond|minute|hour|day](s) ago.
107
108
109
110
111                 -C/--clear
112                           Clears  performance  statistics for all ports. Only
113                           statistics with error  thresholds  are  cleared.  A
114                           clear occurs after generating the report.
115
116
117
118
119
120                 -a/--clearall
121                           Clears all performance statistics for all ports.
122
123
124
125
126
127                 -M/--pmadirect
128                           Accesses performance statistics using direct PMA.
129
130
131
132
133
134                 -A/--allports
135                           Gets  PortInfo  for  down switch ports. Uses direct
136                           SMA to get this data. If used with  -M,  also  gets
137                           PMA stats for down switch ports.
138
139
140
141
142
143                 -F/--focus point
144                           Specifies  the  focus area for report. Used for all
145                           reports except route  to  limit  scope  of  report.
146                           Refer to Point Syntax for details.
147
148
149
150

-h and -p options permit a variety of selections:

152       -h 0      First active port in system (default).
153
154
155       -h 0 -p 0 First active port in system.
156
157
158       -h x      First active port on HFI x.
159
160
161       -h x -p 0 First active port on HFI x.
162
163
164       -h 0 -p y Port y within system (no matter which ports are active).
165
166
167       -h x -p y HFI x, port y.
168
169
170

Point Syntax

172       gid:value value is numeric port GID of form: subnet:guid.
173
174
175       lid:value value is numeric LID.
176
177
178       lid:value:node
179                 value is numeric LID, selects entire node with given LID.
180
181
182       lid:value:port:value2
183                 value is numeric LID of node, value2 is port number.
184
185
186       portguid:value
187                 value is numeric port GUID.
188
189
190       nodeguid:value
191                 value is numeric node GUID.
192
193
194       nodeguid:value1:port:value2
195                 value1 is numeric node GUID, value2 is port number.
196
197
198       iocguid:value
199                 value is numeric IOC GUID.
200
201
202       iocguid:value1:port:value2
203                 value1 is numeric IOC GUID, value2 is port number.
204
205
206       systemguid:value
207                 value is numeric system image GUID.
208
209
210       systemguid:value1:port:value2
211                 value1  is the numeric system image GUID, value2 is port num‐
212                 ber.
213
214
215       ioc:value value is IOC Profile ID String (IOC Name).
216
217
218       ioc:value1:port:value2
219                 value1 is IOC Profile ID String (IOC Name),  value2  is  port
220                 number.
221
222
223       iocpat:value
224                 value is glob pattern for IOC Profile ID String (IOC Name).
225
226
227       iocpat:value1:port:value2
228                 value1  is glob pattern for IOC Profile ID String (IOC Name),
229                 value2 is port number.
230
231
232       ioctype:value
233                 value is IOC type (SRP or OTHER).
234
235
236       ioctype:value1:port:value2
237                 value1 is IOC type (SRP or OTHER); value2 is port number.
238
239
240       node:value
241                 value is node description (node name).
242
243
244       node:value1:port:value2
245                 value1 is node description (node name), value2 is  port  num‐
246                 ber.
247
248
249       nodepat:value
250                 value is glob pattern for node description (node name).
251
252
253       nodepat:value1:port:value2
254                 value1  is  the  glob  pattern for the node description (node
255                 name), value2 is port number.
256
257
258       nodedetpat:value
259                 value is glob pattern for node details.
260
261
262       nodedetpat:value1:port:value2
263                 value1 is the glob pattern for the node  details,  value2  is
264                 port number.
265
266
267       nodetype:value
268                 value is node type (SW, FI, or RT).
269
270
271       nodetype:value1:port:value2
272                 value1 is node type (SW, FI, or RT), value2 is port number.
273
274
275       rate:value
276                 value  is string for rate (25g, 50g, 75g, 100g), omits switch
277                 mgmt port 0.
278
279
280       portstate:value
281                 value is a string  for  state  (down,  init,  armed,  active,
282                 notactive, initarmed).
283
284
285       portphysstate:value
286                 value  is  a string for PHYs state (polling, disabled, train‐
287                 ing, linkup, recovery, offline, test)
288
289
290       mtucap:value
291                 value is MTU size (2048, 4096,  8192,  10240),  omits  switch
292                 mgmt port 0.
293
294
295       labelpat:value
296                 value is glob pattern for cable label.
297
298
299       lengthpat:value
300                 value is glob pattern for cable length.
301
302
303       cabledetpat:value
304                 value is glob pattern for cable details.
305
306
307       cabinflenpat:value
308                 value is glob pattern for cable info length.
309
310
311       cabinfvendnamepat:value
312                 value is glob pattern for cable info vendor name.
313
314
315       cabinfvendpnpat:value
316                 value is glob pattern for cable info vendor part number.
317
318
319       cabinfvendrevpat:value
320                 value is glob pattern for cable info vendor revision.
321
322
323       cabinfvendsnpat:value
324                 value is glob pattern for cable info vendor serial number.
325
326
327       cabinftype:value
328                 value  is  either  optical, passive_copper, active_copper, or
329                 unknown.
330
331
332       linkdetpat:value
333                 value is glob pattern for link details.
334
335
336       portdetpat:value
337                 value is glob pattern for port details.
338
339
340       sm        Specifies the master subnet manager (SM).
341
342
343       smdetpat:value
344                 value is glob pattern for SM details.
345
346
347       route:point1:point2
348                 Specifies all ports along the routes between  the  two  given
349                 points.
350
351
352       led:value value is either on or off for LED port beacon.
353
354
355       linkqual:value
356                 Specifies the ports with a link quality equal to value.
357
358
359       linkqualLE:value
360                 Specifies the ports with a link quality less than or equal to
361                 value.
362
363
364       linkqualGE:value
365                 Specifies the ports with a link quality greater than or equal
366                 to value.
367
368
369
370       The  portion  of the script that calls opareport and opaxmlextract fol‐
371       lows:
372
373       opareport -o comps -s -x -d 10 $@ | opaxmlextract -d ;
374       -e NodeDesc -e SystemImageGUID -e PortNum -e XmitDataMB
375       -e XmitData -e XmitPkts -e RcvDataMB -e RcvData -e RcvPkts
376       -e SymbolErrors -e LinkErrorRecovery -e LinkDowned -e PortRcvErrors
377       -e PortRcvRemotePhysicalErrors -e PortRcvSwitchRelayErrors
378       -e PortXmitDiscards -e PortXmitConstraintErrors
379       -e PortRcvConstraintErrors -e LocalLinkIntegrityErrors
380       -e ExcessiveBufferOverrunErrors -e VL15Dropped -s Neighbor -s SMs
381
382
383

Example

385       opaextractperf
386       opaextractperf -h 1 -p 2
387
388
389
390Copyright(C) 2015-2018         Intel Corporation             opaextractperf(8)
Impressum