1opaextractstat(8) Master map: IFSFFCLIRG (Man Page) opaextractstat(8)
3
7 opaextractstat
8 Performs an error analysis of a fabric and provides augmented informa‐
12 tion from a topology_file. The report provides cable information as
13 well as symbol error counts.
14 opaextractstat generates a detailed opareport errors report that also
16 has a topology file (see opareport for more information about topology
17 files). The report is piped to opaxmlextract which extracts values for
18 Link, Cable and Port. (The port element names are context-sensitive.)
19 Note that opaxmlextract generates two extraction records for each link
20 (one for each port on the link); therefore, opaextractstat merges the
21 two records into a single record and removes redundant link and cable
22 information.
23 opaextractstat contains a while read loop that reads the CSV line-by-
25 line, uses cut to remove redundant information, and outputs the data on
26 a common line.
27
29 opaextractstat topology_file [opareport options]
30
32 --help Produces full help text.
33 topology_file
36 Specifies topology_file to use.
37 opareport options
40 The following options are passed to opareport. This subset is
41 considered typical and useful for this command. By design,
42 the tool ignores -o/--output report option.
43 -h/--hfi hfi
48 Specifies the HFI, numbered 1..n. Using 0 specifies
49 that the -p port port is a system-wide port number.
50 (Default is 0.)
51 -p/--port port
57 Specifies the port, numbered 1..n. Using 0 speci‐
58 fies the first active port. (Default is 0.)
59 -X/--infile snapshot_input
65 Generates a report using the data in the snap‐
66 shot_input file. snapshot_input must have been gen‐
67 erated during a previous -o snapshot run. When
68 used, the -s, -i, -C, and -a options are ignored.
69 '-' may be used as the snapshot_input to specify
70 stdin.
71 -i/--interval seconds
77 Obtains performance statistics over interval sec‐
78 onds. Clears all statistics, waits interval sec‐
79 onds, then generates report. Implies -s option.
80 -b / --begin date_time
86 Obtains past performance stats over an interval
87 beginning at date_time. Implies -s option.
88 date_time may be a time entered as HH:MM[:SS] or
89 date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date
90 followed by time; for example, "2016-07-04 14:40".
91 Relative times are taken as "x [sec‐
92 ond|minute|hour|day](s) ago.
93 -e / --end date_time
99 Obtains past performance stats over an interval
100 ending at date_time. Implies -s option.
101 date_time may be a time entered as HH:MM[:SS] or
104 date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date
105 followed by time; for example, "2016-07-04 14:40".
106 Relative times are taken as "x [sec‐
107 ond|minute|hour|day](s) ago.
108 -C/--clear
113 Clears performance statistics for all ports. Only
114 statistics with error thresholds are cleared. A
115 clear occurs after generating the report.
116 -a/--clearall
122 Clears all performance statistics for all ports.
123 -M/--pmadirect
129 Accesses performance statistics using direct PMA.
130 -A/--allports
136 Gets PortInfo for down switch ports. Uses direct
137 SMA to get this data. If used with -M, also gets
138 PMA stats for down switch ports.
139 -c/--config file
145 Specifies the error thresholds configuration file.
146 Default is /etc/opa/opamon.conf file.
147 -L/--limit
153 Limits operation to exact specified focus with -F
154 for port error counters check (-o errors) and port
155 counters clear (-C or -i). Normally, the neighbor
156 of each selected port is also checked/cleared. Does
157 not affect other reports.
158 -F/--focus point
164 Specifies the focus area for report. Used for all
165 reports except route to limit scope of report.
166 Refer to Point Syntax for details.
167
172 -h 0 First active port in system (default).
173 -h 0 -p 0 First active port in system.
176 -h x First active port on HFI x.
179 -h x -p 0 First active port on HFI x.
182 -h 0 -p y Port y within system (no matter which ports are active).
185 -h x -p y HFI x, port y.
188
192 gid:value value is numeric port GID of form: subnet:guid.
193 lid:value value is numeric LID.
196 lid:value:node
199 value is numeric LID, selects entire node with given LID.
200 lid:value:port:value2
203 value is numeric LID of node, value2 is port number.
204 portguid:value
207 value is numeric port GUID.
208 nodeguid:value
211 value is numeric node GUID.
212 nodeguid:value1:port:value2
215 value1 is numeric node GUID, value2 is port number.
216 iocguid:value
219 value is numeric IOC GUID.
220 iocguid:value1:port:value2
223 value1 is numeric IOC GUID, value2 is port number.
224 systemguid:value
227 value is numeric system image GUID.
228 systemguid:value1:port:value2
231 value1 is the numeric system image GUID, value2 is port num‐
232 ber.
233 ioc:value value is IOC Profile ID String (IOC Name).
236 ioc:value1:port:value2
239 value1 is IOC Profile ID String (IOC Name), value2 is port
240 number.
241 iocpat:value
244 value is glob pattern for IOC Profile ID String (IOC Name).
245 iocpat:value1:port:value2
248 value1 is glob pattern for IOC Profile ID String (IOC Name),
249 value2 is port number.
250 ioctype:value
253 value is IOC type (SRP or OTHER).
254 ioctype:value1:port:value2
257 value1 is IOC type (SRP or OTHER); value2 is port number.
258 node:value
261 value is node description (node name).
262 node:value1:port:value2
265 value1 is node description (node name), value2 is port num‐
266 ber.
267 nodepat:value
270 value is glob pattern for node description (node name).
271 nodepat:value1:port:value2
274 value1 is the glob pattern for the node description (node
275 name), value2 is port number.
276 nodedetpat:value
279 value is glob pattern for node details.
280 nodedetpat:value1:port:value2
283 value1 is the glob pattern for the node details, value2 is
284 port number.
285 nodetype:value
288 value is node type (SW, FI, or RT).
289 nodetype:value1:port:value2
292 value1 is node type (SW, FI, or RT), value2 is port number.
293 rate:value
296 value is string for rate (25g, 50g, 75g, 100g), omits switch
297 mgmt port 0.
298 portstate:value
301 value is a string for state (down, init, armed, active,
302 notactive, initarmed).
303 portphysstate:value
306 value is a string for PHYs state (polling, disabled, train‐
307 ing, linkup, recovery, offline, test)
308 mtucap:value
311 value is MTU size (2048, 4096, 8192, 10240), omits switch
312 mgmt port 0.
313 labelpat:value
316 value is glob pattern for cable label.
317 lengthpat:value
320 value is glob pattern for cable length.
321 cabledetpat:value
324 value is glob pattern for cable details.
325 cabinflenpat:value
328 value is glob pattern for cable info length.
329 cabinfvendnamepat:value
332 value is glob pattern for cable info vendor name.
333 cabinfvendpnpat:value
336 value is glob pattern for cable info vendor part number.
337 cabinfvendrevpat:value
340 value is glob pattern for cable info vendor revision.
341 cabinfvendsnpat:value
344 value is glob pattern for cable info vendor serial number.
345 cabinftype:value
348 value is either optical, passive_copper, active_copper, or
349 unknown.
350 linkdetpat:value
353 value is glob pattern for link details.
354 portdetpat:value
357 value is glob pattern for port details.
358 sm Specifies the master subnet manager (SM).
361 smdetpat:value
364 value is glob pattern for SM details.
365 route:point1:point2
368 Specifies all ports along the routes between the two given
369 points.
370 led:value value is either on or off for LED port beacon.
373 linkqual:value
376 Specifies the ports with a link quality equal to value.
377 linkqualLE:value
380 Specifies the ports with a link quality less than or equal to
381 value.
382 linkqualGE:value
385 Specifies the ports with a link quality greater than or equal
386 to value.
387 The portion of the script that calls opareport and opaxmlextract fol‐
391 lows:
392 opareport -x -d 10 -s -o errors -T $@ | opaxmlextract -d ;
394 -e Rate -e MTU -e LinkDetails -e CableLength -e CableLabel
395 -e CableDetails -e Port.NodeDesc -e Port.PortNum -e SymbolErrors.Value
396
400 opaextractstat topology_file
401 opaextractstat topology_file -c my_opamon.conf
402Copyright(C) 2015-2018 Intel Corporation opaextractstat(8)