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

NAME

7       opaextractbadlinks
8
9
10
11       Produces a CSV file listing all or some of the links that exceed opare‐
12       port -o error thresholds. opaextractbadlinks is  a  front  end  to  the
13       opareport  tool.  The  output  from  this  tool  can be imported into a
14       spreadsheet or parsed by other scripts.
15

Syntax

17       opaextractbadlinks [opareport options]
18

Options

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

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

167       -h 0      First active port in system (default).
168
169
170       -h 0 -p 0 First active port in system.
171
172
173       -h x      First active port on HFI x.
174
175
176       -h x -p 0 First active port on HFI x.
177
178
179       -h 0 -p y Port y within system (no matter which ports are active).
180
181
182       -h x -p y HFI x, port y.
183
184
185

Point Syntax

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

Examples

385       # List all the bad links in the fabric:
386       opaextractbadlinks
387
388       # List all the bad links to a switch named "coresw1":
389       opaextractbadlinks -F "node:coresw1"
390
391       # List all the bad links to end-nodes:
392       opaextractbadlinks -F "nodetype:FI"
393
394       # List all the bad links on the 2nd HFI's fabric of a multi-plane  fab‐
395       ric:
396       opaextractbadlinks -h 2
397
398
399
400
401Copyright(C) 2015-2018         Intel Corporation         opaextractbadlinks(8)
Impressum