1opaextractperf(8) Master map: IFSFFCLIRG (Man Page) opaextractperf(8)
3
7 opaextractperf
8 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
21 opaextractperf [opareport options]
22
24 --help Produces full help text.
25 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 -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 -p/--port port
45 Specifies the port, numbered 1..n. Using 0 speci‐
46 fies the first active port. (Default is 0.)
47 -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 -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 -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 -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 -e / --end date_time
98 Obtains past performance stats over an interval
99 ending at date_time. Implies -s option.
100 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 -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 -a/--clearall
121 Clears all performance statistics for all ports.
122 -M/--pmadirect
128 Accesses performance statistics using direct PMA.
129 -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 -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
152 -h 0 First active port in system (default).
153 -h 0 -p 0 First active port in system.
156 -h x First active port on HFI x.
159 -h x -p 0 First active port on HFI x.
162 -h 0 -p y Port y within system (no matter which ports are active).
165 -h x -p y HFI x, port y.
168
172 gid:value value is numeric port GID of form: subnet:guid.
173 lid:value value is numeric LID.
176 lid:value:node
179 value is numeric LID, selects entire node with given LID.
180 lid:value:port:value2
183 value is numeric LID of node, value2 is port number.
184 portguid:value
187 value is numeric port GUID.
188 nodeguid:value
191 value is numeric node GUID.
192 nodeguid:value1:port:value2
195 value1 is numeric node GUID, value2 is port number.
196 iocguid:value
199 value is numeric IOC GUID.
200 iocguid:value1:port:value2
203 value1 is numeric IOC GUID, value2 is port number.
204 systemguid:value
207 value is numeric system image GUID.
208 systemguid:value1:port:value2
211 value1 is the numeric system image GUID, value2 is port num‐
212 ber.
213 ioc:value value is IOC Profile ID String (IOC Name).
216 ioc:value1:port:value2
219 value1 is IOC Profile ID String (IOC Name), value2 is port
220 number.
221 iocpat:value
224 value is glob pattern for IOC Profile ID String (IOC Name).
225 iocpat:value1:port:value2
228 value1 is glob pattern for IOC Profile ID String (IOC Name),
229 value2 is port number.
230 ioctype:value
233 value is IOC type (SRP or OTHER).
234 ioctype:value1:port:value2
237 value1 is IOC type (SRP or OTHER); value2 is port number.
238 node:value
241 value is node description (node name).
242 node:value1:port:value2
245 value1 is node description (node name), value2 is port num‐
246 ber.
247 nodepat:value
250 value is glob pattern for node description (node name).
251 nodepat:value1:port:value2
254 value1 is the glob pattern for the node description (node
255 name), value2 is port number.
256 nodedetpat:value
259 value is glob pattern for node details.
260 nodedetpat:value1:port:value2
263 value1 is the glob pattern for the node details, value2 is
264 port number.
265 nodetype:value
268 value is node type (SW, FI, or RT).
269 nodetype:value1:port:value2
272 value1 is node type (SW, FI, or RT), value2 is port number.
273 rate:value
276 value is string for rate (25g, 50g, 75g, 100g), omits switch
277 mgmt port 0.
278 portstate:value
281 value is a string for state (down, init, armed, active,
282 notactive, initarmed).
283 portphysstate:value
286 value is a string for PHYs state (polling, disabled, train‐
287 ing, linkup, recovery, offline, test)
288 mtucap:value
291 value is MTU size (2048, 4096, 8192, 10240), omits switch
292 mgmt port 0.
293 labelpat:value
296 value is glob pattern for cable label.
297 lengthpat:value
300 value is glob pattern for cable length.
301 cabledetpat:value
304 value is glob pattern for cable details.
305 cabinflenpat:value
308 value is glob pattern for cable info length.
309 cabinfvendnamepat:value
312 value is glob pattern for cable info vendor name.
313 cabinfvendpnpat:value
316 value is glob pattern for cable info vendor part number.
317 cabinfvendrevpat:value
320 value is glob pattern for cable info vendor revision.
321 cabinfvendsnpat:value
324 value is glob pattern for cable info vendor serial number.
325 cabinftype:value
328 value is either optical, passive_copper, active_copper, or
329 unknown.
330 linkdetpat:value
333 value is glob pattern for link details.
334 portdetpat:value
337 value is glob pattern for port details.
338 sm Specifies the master subnet manager (SM).
341 smdetpat:value
344 value is glob pattern for SM details.
345 route:point1:point2
348 Specifies all ports along the routes between the two given
349 points.
350 led:value value is either on or off for LED port beacon.
353 linkqual:value
356 Specifies the ports with a link quality equal to value.
357 linkqualLE:value
360 Specifies the ports with a link quality less than or equal to
361 value.
362 linkqualGE:value
365 Specifies the ports with a link quality greater than or equal
366 to value.
367 The portion of the script that calls opareport and opaxmlextract fol‐
371 lows:
372 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
385 opaextractperf
386 opaextractperf -h 1 -p 2
387Copyright(C) 2015-2018 Intel Corporation opaextractperf(8)