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

NAME

7       opaextractstat2
8
9
10
11       Performs  an error analysis of a fabric and provides augmented informa‐
12       tion from a topology_file including all error counters. The  output  is
13       in  a CSV format suitable for importing into a spreadsheet or parsed by
14       other scripts. opaextractstat2 is a front  end  to  the  opareport  and
15       opaxmlextract tools.
16

Syntax

18       opaextractstat2 topology_file [opareport options]
19

Options

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

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

161       -h 0      First active port in system (default).
162
163
164       -h 0 -p 0 First active port in system.
165
166
167       -h x      First active port on HFI x.
168
169
170       -h x -p 0 First active port on HFI x.
171
172
173       -h 0 -p y Port y within system (no matter which ports are active).
174
175
176       -h x -p y HFI x, port y.
177
178
179

Point Syntax

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

Examples

392       opaextractstat2 topology_file
393       opaextractstat2 topology_file -c my_opamon.conf
394
395
396
397Copyright(C) 2015-2018         Intel Corporation            opaextractstat2(8)
Impressum