1opareport(8) Master map: IFSFFCLIRG (Man Page) opareport(8)
3
7 opareport
8 (All) Provides powerful fabric analysis and reporting capabilities.
12 Must be run on a host connected to the Intel(R) Omni-Path Fabric with
13 the Intel(R) Omni-Path Fabric Suite FastFabric Toolset installed.
14
16 opareport [-v][-q] [-h hfi] [-p port] [-o report] [-d detail] [-P|-H]
17 [-N] [-x] [-X snapshot_input] [-T topology_input] [-s] [-r] [-V]
18 [-i seconds] [-b date_time] [-e date_time] [-C] [-a] [-m] [-M] [-A] [-c
19 file]
20 [-L] [-F point] [-S point] [-D point] [-Q]
21
23 --help Produces full help text.
24 -v/--verbose
27 Returns verbose output.
28 -q/--quiet
31 Disables progress reports.
32 -h/--hfi hfi
35 Specifies the HFI, numbered 1..n. Using 0 specifies that the
36 -p port port is a system-wide port number. (Default is 0.)
37 -p/--port port
40 Specifies the port, numbered 1..n. Using 0 specifies the
41 first active port. (Default is 0.)
42 -o/--output report
45 Specifies the report type for output. Refer to Report Types
46 for details.
47 -d/--detail level
50 Specifies the level of detail 0-n for output. Default is 2.
51 -P/--persist
54 Only includes data persistent across reboots.
55 -H/--hard Only includes permanent hardware data.
58 -N/--noname
61 Omits node and IOC names.
62 -x/--xml Produces output in XML.
65 -X/--infile snapshot_input
68 Generates a report using the data in the snapshot_input file.
69 snapshot_input must have been generated during a previous -o
70 snapshot run. When used, the -s, -i, -C, and -a options are
71 ignored. '-' may be used as the snapshot_input to specify
72 stdin.
73 -T/--topology topology_input
76 Uses topology_input file to augment and verify fabric infor‐
77 mation. When used, various reports can be augmented with
78 information not available electronically (such as cable
79 labels). '-' may be used to specify stdin.
80 -s/--stats
83 Gets performance statistics for all ports.
84 -i/--interval seconds
87 Obtains performance statistics over interval seconds. Clears
88 all statistics, waits interval seconds, then generates
89 report. Implies -s option.
90 -b / --begin date_time
93 Obtains past performance stats over an interval beginning at
94 date_time. Implies -s option. date_time may be a time entered
95 as HH:MM[:SS] or date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd
96 or date followed by time; for example, "2016-07-04 14:40".
97 Relative times are taken as "x [second|minute|hour|day](s)
98 ago.
99 -e / --end date_time
102 Obtains past performance stats over an interval ending at
103 date_time. Implies -s option.
104 date_time may be a time entered as HH:MM[:SS] or date as
107 mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date followed by time;
108 for example, "2016-07-04 14:40". Relative times are taken as
109 "x [second|minute|hour|day](s) ago.
110 -C/--clear
112 Clears performance statistics for all ports. Only statistics
113 with error thresholds are cleared. A clear occurs after gen‐
114 erating the report.
115 -a/--clearall
118 Clears all performance statistics for all ports.
119 -m/--smadirect
122 Accesses fabric information directly from SMA.
123 -M/--pmadirect
126 Accesses performance statistics using direct PMA.
127 -A/--allports
130 Gets PortInfo for down switch ports. Uses direct SMA to get
131 this data. If used with -M, also gets PMA stats for down
132 switch ports.
133 -c/--config file
136 Specifies the error thresholds configuration file. Default is
137 /etc/opa/opamon.conf file.
138 -L/--limit
141 Limits operation to exact specified focus with -F for port
142 error counters check (-o errors) and port counters clear (-C
143 or -i). Normally, the neighbor of each selected port is also
144 checked/cleared. Does not affect other reports.
145 -F/--focus point
148 Specifies the focus area for report.
149 Limits output to reflect a subsection of the fabric. May not
152 work with all reports. (For example, route, mcgroups, and the
153 verify* reports may ignore the option or not generate useful
154 results.)
155 -S/--src point
157 Specifies the source for trace route. Default is local port.
158 -D/--dest point
161 Specifies the destination for trace route.
162 -Q/--quietfocus
165 Excludes focus description from report.
166
170 -h 0 First active port in system (default).
171 -h 0 -p 0 First active port in system.
174 -h x First active port on HFI x.
177 -h x -p 0 First active port on HFI x.
180 -h 0 -p y Port y within system (no matter which ports are active).
183 -h x -p y HFI x, port y.
186
190 -r/--routes
191 Gets routing tables for all switches.
192 -V/--vltables
195 Gets the P-Key tables for all nodes and the QoS VL-related
196 tables for all ports.
197
201 comps Summary of all systems and SMs in fabric.
202 brcomps Brief summary of all systems and SMs in fabric.
205 nodes Summary of all node types and SMs in fabric.
208 brnodes Brief summary of all node types and SMs in fabric.
211 ious Summary of all IO units in the fabric.
214 lids Summary of all LIDs in the fabric.
217 links Summary of all links.
220 extlinks Summary of links external to systems.
223 filinks Summary of links to FIs.
226 islinks Summary of inter-switch links.
229 extislinks
232 Summary of inter-switch links external to systems.
233 slowlinks Summary of links running slower than expected.
236 slowconfiglinks
239 Summary of links configured to run slower than supported,
240 includes slowlinks.
241 slowconnlinks
244 Summary of links connected with mismatched speed potential,
245 includes slowconfiglinks.
246 misconfiglinks
249 Summary of links configured to run slower than supported.
250 misconnlinks
253 Summary of links connected with mismatched speed potential.
254 errors Summary of links whose errors exceed counts in the configura‐
257 tion file.
258 otherports
261 Summary of ports not connected to the fabric.
262 linear Summary of linear forwarding data base (FDB) for each switch.
265 mcast Summary of multicast FDB for each switch in the fabric.
268 mcgroups Summary of multicast groups.
271 When used in conjunction with -d, the following report
274 details are possible:
275 · -d0 : Shows the number of multicast groups
278 · -d1 : Shows a list of multicast groups
280 · -d2 : Shows a list of members per multicast group
282 This report can be used with option -X.
286 portusage Summary of ports referenced in linear FDB for each switch,
288 broken down by NodeType of DLID.
289 pathusage Summary of number of FI to FI paths routed through each
292 switch port.
293 treepathusage
296 Analysis of number of FI to FI paths routed through each
297 switch port for a FAT tree.
298 portgroups
301 Summary of adaptive routing port groups for each switch.
302 quarantinednodes
305 Summary of quarantined nodes.
306 validateroutes
309 Validates all routes in the fabric.
310 validatevlroutes
313 Validates all routes in the fabric using SLSC, SCSC, and SCVL
314 tables.
315 validatepgs
318 Validates all port groups in the fabric.
319 validatecreditloops
322 Validates topology configuration of the fabric to identify
323 any existing credit loops.
324 validatevlcreditloops
327 Validates topology configuration of the fabric including
328 SLSC, SCSC, and SCVL tables to identify any existing credit
329 loops.
330 validatemcroutes
333 Validates multicast routes of the fabric to identify loops in
334 multicast forwarding tables and detect MFT-multicast member‐
335 ship inconsistencies.
336 vfinfo Summary of virtual fabric (vFabric) information.
339 vfmember Summary of vFabric membership information.
342 verifyfis Compares fabric (or snapshot) FIs to supplied topology and
345 identifies differences and omissions.
346 verifysws Compares fabric (or snapshot) switches to supplied topology
349 and identifies differences and omissions.
350 verifynodes
353 Returns verifyfis and verifysws reports.
354 verifysms Compares fabric (or snapshot) SMs to supplied topology and
357 identifies differences and omissions.
358 verifylinks
361 Compares fabric (or snapshot) links to supplied topology and
362 identifies differences and omissions.
363 verifyextlinks
366 Compares fabric (or snapshot) links to supplied topology and
367 identifies differences and omissions. Limits analysis to
368 links external to systems.
369 verifyfilinks
372 Compares fabric (or snapshot) links to supplied topology and
373 identify differences and omissions. Limits analysis to links
374 to FIs.
375 verifyislinks
378 Compares fabric (or snapshot) links to supplied topology and
379 identify differences and omissions. Limits analysis to inter-
380 switch links.
381 verifyextislinks
384 Compares fabric (or snapshot) links to supplied topology and
385 identify differences and omissions. Limits analysis to inter-
386 switch links external to systems.
387 verifyall Returns verifyfis, verifysws, verifysms, and verifylinks
390 reports.
391 all Returns comps, nodes, ious, links, extlinks, slowconnlinks,
394 and errors reports.
395 route Traces route between -S and -D points.
398 bfrctrl Reports Buffer Control Tables for all ports.
401 snapshot Outputs snapshot of the fabric state for later use as snap‐
404 shot_input. This implies -x. May not be combined with other
405 reports. When selected, -F, -P, -H, and -N options are
406 ignored.
407 topology Outputs the topology of the fabric for later use as topol‐
410 ogy_input. This implies -x. May not be combined with other
411 reports. Use with detail level 3 or more to get Port element
412 under Node in output xml.
413 none No report, useful to clear statistics.
416
420 gid:value value is numeric port GID of form: subnet:guid.
421 lid:value value is numeric LID.
424 lid:value:node
427 value is numeric LID, selects entire node with given LID.
428 lid:value:port:value2
431 value is numeric LID of node, value2 is port number.
432 portguid:value
435 value is numeric port GUID.
436 nodeguid:value
439 value is numeric node GUID.
440 nodeguid:value1:port:value2
443 value1 is numeric node GUID, value2 is port number.
444 iocguid:value
447 value is numeric IOC GUID.
448 iocguid:value1:port:value2
451 value1 is numeric IOC GUID, value2 is port number.
452 systemguid:value
455 value is numeric system image GUID.
456 systemguid:value1:port:value2
459 value1 is the numeric system image GUID, value2 is port num‐
460 ber.
461 ioc:value value is IOC Profile ID String (IOC Name).
464 ioc:value1:port:value2
467 value1 is IOC Profile ID String (IOC Name), value2 is port
468 number.
469 iocpat:value
472 value is glob pattern for IOC Profile ID String (IOC Name).
473 iocpat:value1:port:value2
476 value1 is glob pattern for IOC Profile ID String (IOC Name),
477 value2 is port number.
478 ioctype:value
481 value is IOC type (SRP or OTHER).
482 ioctype:value1:port:value2
485 value1 is IOC type (SRP or OTHER); value2 is port number.
486 node:value
489 value is node description (node name).
490 node:value1:port:value2
493 value1 is node description (node name), value2 is port num‐
494 ber.
495 nodepat:value
498 value is glob pattern for node description (node name).
499 nodepat:value1:port:value2
502 value1 is the glob pattern for the node description (node
503 name), value2 is port number.
504 nodedetpat:value
507 value is glob pattern for node details.
508 nodedetpat:value1:port:value2
511 value1 is the glob pattern for the node details, value2 is
512 port number.
513 nodetype:value
516 value is node type (SW, FI, or RT).
517 nodetype:value1:port:value2
520 value1 is node type (SW, FI, or RT), value2 is port number.
521 rate:value
524 value is string for rate (25g, 50g, 75g, 100g), omits switch
525 mgmt port 0.
526 portstate:value
529 value is a string for state (down, init, armed, active,
530 notactive, initarmed).
531 portphysstate:value
534 value is a string for PHYs state (polling, disabled, train‐
535 ing, linkup, recovery, offline, test)
536 mtucap:value
539 value is MTU size (2048, 4096, 8192, 10240), omits switch
540 mgmt port 0.
541 labelpat:value
544 value is glob pattern for cable label.
545 lengthpat:value
548 value is glob pattern for cable length.
549 cabledetpat:value
552 value is glob pattern for cable details.
553 cabinflenpat:value
556 value is glob pattern for cable info length.
557 cabinfvendnamepat:value
560 value is glob pattern for cable info vendor name.
561 cabinfvendpnpat:value
564 value is glob pattern for cable info vendor part number.
565 cabinfvendrevpat:value
568 value is glob pattern for cable info vendor revision.
569 cabinfvendsnpat:value
572 value is glob pattern for cable info vendor serial number.
573 cabinftype:value
576 value is either optical, passive_copper, active_copper, or
577 unknown.
578 linkdetpat:value
581 value is glob pattern for link details.
582 portdetpat:value
585 value is glob pattern for port details.
586 sm Specifies the master subnet manager (SM).
589 smdetpat:value
592 value is glob pattern for SM details.
593 route:point1:point2
596 Specifies all ports along the routes between the two given
597 points.
598 led:value value is either on or off for LED port beacon.
601 linkqual:value
604 Specifies the ports with a link quality equal to value.
605 linkqualLE:value
608 Specifies the ports with a link quality less than or equal to
609 value.
610 linkqualGE:value
613 Specifies the ports with a link quality greater than or equal
614 to value.
615
618 opareport can generate hundreds of different reports. Commonly gener‐
619 ated reports include the following:
620 opareport -o comps -d 3
622 opareport -o errors -o slowlinks
623 opareport -o nodes -F portguid:0x00117500a000447b
624 opareport -o nodes -F nodeguid:0x001175009800447b:port:1
625 opareport -o nodes -F nodeguid:0x001175009800447b
626 opareport -o nodes -F 'node:duster hfi1_0'
627 opareport -o nodes -F 'node:duster hfi1_0:port:1'
628 opareport -o nodes -F 'nodepat:d*'
629 opareport -o nodes -F 'nodepat:d*:port:1'
630 opareport -o nodes -F 'nodedetpat:compute*'
631 opareport -o nodes -F 'nodedetpat:compute*:port:1'
632 opareport -o nodes -F nodetype:FI
633 opareport -o nodes -F nodetype:FI:port:1
634 opareport -o nodes -F lid:1
635 opareport -o nodes -F led:on opareport -o nodes -F led:off opareport -o
636 nodes -F lid:1:node
637 opareport -o nodes -F lid:1:port:2
638 opareport -o nodes -F gid:0xfe80000000000000:0x00117500a000447b
639 opareport -o nodes -F systemguid:0x001175009800447b
640 opareport -o nodes -F systemguid:0x001175009800447b:port:1
641 opareport -o nodes -F iocguid:0x00117501300001e0
642 opareport -o nodes -F iocguid:0x00117501300001e0:port:2
643 opareport -o nodes -F 'ioc:Chassis 0x001175005000010C, Slot 2, IOC 1'
644 opareport -o nodes -F 'ioc:Chassis 0x001175005000010C, Slot 2, IOC
645 1:port:2'
646 opareport -o nodes -F 'iocpat:*Slot 2*'
647 opareport -o nodes -F 'iocpat:*Slot 2*:port:2'
648 opareport -o nodes -F ioctype:SRP opareport -o nodes -F ioc‐
649 type:SRP:port:2
650 opareport -o extlinks -F rate:100g
651 opareport -o extlinks -F portstate:armed
652 opareport -o extlinks -F portphysstate:linkup
653 opareport -o extlinks -F 'labelpat:S1345*'
654 opareport -o extlinks -F 'lengthpat:11m'
655 opareport -o extlinks -F 'cabledetpat:*hitachi*'
656 opareport -o extlinks -F 'linkdetpat:*core ISL*'
657 opareport -o extlinks -F 'portdetpat:*mgmt*'
658 opareport -o links -F mtucap:2048
659 opareport -o nodes -F sm
660 opareport -o nodes -F 'smdetpat:primary*'
661 opareport -o nodes -F 'route:node:duster hfi1_0:node:cuda hfi1_0'
662 opareport -o nodes -F 'route:node:duster hfi1_0:port:1:node:cuda
663 hfi1_0:port:2'
664 opareport -s -o snapshot > file
665 opareport -o topology > topology.xml
666 opareport -o errors -X file
667 opareport -s --begin "2 days ago"
668 opareport -s --begin "12:30" --end "14:00"
669
674 opareport also supports operation with the Fabric Manager Performance
675 Manager (PM)/Performance Manager Agent (PMA). When opareport detects
676 the presence of a PM, it automatically issues any required PortCounter
677 queries and clears to the PM to access the PMs running totals. If a PM
678 is not detected, then opareport directly accesses the PMAs on all the
679 nodes. The -M option can force access to the PMA even if a PM is
680 present.
681 opareport takes advantage of these interfaces to obtain extensive
683 information about the fabric from the subnet manager and the end nodes.
684 Using this information, opareport is able to cross-reference it and
685 produce analysis greatly beyond what any single subnet manager request
686 could provide. As such, it exceeds the capabilities previously avail‐
687 able in tools such as opasaquery and opafabricinfo.
688 opareport obtains and displays counters from the Fabric Manager PM/PA
690 or directly from the fabric PMAs using the -M option.
691 opareport internally cross-references all this information so its out‐
693 put can be in user-friendly form. Reports include GUIDs, LIDs, and
694 names for components. Obviously, these reports are easiest to read if
695 the end user has taken the time to provide unique names for all the
696 components in the fabric (node names and IOC names). All Intel compo‐
697 nents support this capability. For hosts, the node names are automati‐
698 cally assigned based on the network host name of the server. For
699 switches and line cards, the names can be assigned using the element
700 managers for each component.
701 Each run of opareport obtains up-to-date information from the fabric.
703 At the start of the run opareport takes a few seconds to obtain all the
704 fabric data, then it is output to stdout. The reports are sorted by
705 GUIDs and other permanent information so they can be rerun in the
706 future and produce output in the same order even if components have
707 been rebooted. This is useful for comparison using simple tools like
708 diff. opareport permits multiple reports to be requested for a single
709 run (for example, one of each report type).
710 By default, opareport uses the first active port on the local system.
712 However, if the Management Node is connected to more than one fabric
713 (for example, a subnet), the Intel(R) Omni-Path Host Fabric Interface
714 (HFI) and port may be specified to select the fabric to analyze.
715Copyright(C) 2015-2018 Intel Corporation opareport(8)