1opareports(8) Master map: IFSFFCLIRG (Man Page) opareports(8)
3
7 opareports
8 (All) opareports is a front end to opareport that provides many of the
12 same options and capabilities. It can also run a report against multi‐
13 ple fabrics or subnets (for example, local host HFI ports). opareports
14 can use an input file to augment the reports using additional details
15 from the topology_input file.
16
18 opareports [-t portsfile] [-p ports] [-T topology_input] [opareport
19 arguments]
20
22 --help Produces full help text.
23 -t portsfile
25 Specifies the file with list of local HFI ports used to
26 access fabric for analysis. Default is /etc/opa/ports file.
27 -p ports Specifies the list of local HFI ports used to access fabric
29 for counter clear.
30 Default is first active port. The first HFI in the system is
33 1. The first port on an HFI is 1. Uses the format hfi:port,
34 for example:
35 0:0 First active port in system.
39 0:y Port y within system.
45 x:0 First active port on HFI x.
51 x:y HFI x, port y.
57 -T topology_input
61 Specifies the name of a topology input file to use. The file‐
62 name may have %P as a marker which is replaced with the
63 hfi:port being operated on, such as 0:0 or 1:2. The default
64 filename is specified by FF_TOPOLOGY_FILE as /etc/opa/topol‐
65 ogy.%P.xml. If -T NONE is specified, no topology input file
66 is used.
67 opareport arguments
69 Options are passed to opareport.
70 Specifies any of the other opareport arguments listed below
73 (see opareport Options ):
74 opareport [-v][-q] [-h hfi] [-p port] [-o report]
75 [-d detail] [-P|-H] [-N] [-x] [-X snapshot_input]
76 [-T topology_input] [-s] [-r] [-V] [-i seconds]
77 [-b date_time] [-e date_time] [-C] [-a] [-m] [-M] [-A]
78 [-c file] [-L] [-F point] [-S point]
79 [-D point] [-Q]
80 NOTE: When using opareport arguments, regard the following:
87 · The -h and -X options are not available.
90 · The meaning of -p is different for opareports than opare‐
92 port.
93 · When run against multiple fabrics, the -x and -o snapshot
95 options are not available.
96 · When run against multiple fabrics, the -F option is
98 applied to all fabrics.
99
104 opareports
105 opareports -p '1:1 2:1'
106
108 The following environment variables are also used by this command:
109 PORTS List of ports, used in absence of -t and -p.
111 PORTS_FILE
113 File containing list of ports, used in absence of -t and -p.
114 FF_TOPOLOGY_FILE
116 File containing topology_input (may have %P marker in file‐
117 name), used in absence of -T.
118
121 For reference:
122 --help Produces full help text.
124 -v/--verbose
127 Returns verbose output.
128 -q/--quiet
131 Disables progress reports.
132 -h/--hfi hfi
135 Specifies the HFI, numbered 1..n. Using 0 specifies that the
136 -p port port is a system-wide port number. (Default is 0.)
137 -p/--port port
140 Specifies the port, numbered 1..n. Using 0 specifies the
141 first active port. (Default is 0.)
142 -o/--output report
145 Specifies the report type for output. Refer to opareport
146 Report Types for details.
147 -d/--detail level
150 Specifies the level of detail 0-n for output. Default is 2.
151 -P/--persist
154 Only includes data persistent across reboots.
155 -H/--hard Only includes permanent hardware data.
158 -N/--noname
161 Omits node and IOC names.
162 -x/--xml Produces output in XML.
165 -X/--infile snapshot_input
168 Generates a report using the data in the snapshot_input file.
169 snapshot_input must have been generated during a previous -o
170 snapshot run. When used, the -s, -i, -C, and -a options are
171 ignored. '-' may be used as the snapshot_input to specify
172 stdin.
173 -T/--topology topology_input
176 Uses topology_input file to augment and verify fabric infor‐
177 mation. When used, various reports can be augmented with
178 information not available electronically (such as cable
179 labels). '-' may be used to specify stdin.
180 -s/--stats
183 Gets performance statistics for all ports.
184 -i/--interval seconds
187 Obtains performance statistics over interval seconds. Clears
188 all statistics, waits interval seconds, then generates
189 report. Implies -s option.
190 -b / --begin date_time
193 Obtains past performance stats over an interval beginning at
194 date_time. Implies -s option. date_time may be a time entered
195 as HH:MM[:SS] or date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd
196 or date followed by time; for example, "2016-07-04 14:40".
197 Relative times are taken as "x [second|minute|hour|day](s)
198 ago.
199 -e / --end date_time
202 Obtains past performance stats over an interval ending at
203 date_time. Implies -s option.
204 date_time may be a time entered as HH:MM[:SS] or date as
207 mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date followed by time;
208 for example, "2016-07-04 14:40". Relative times are taken as
209 "x [second|minute|hour|day](s) ago.
210 -C/--clear
212 Clears performance statistics for all ports. Only statistics
213 with error thresholds are cleared. A clear occurs after gen‐
214 erating the report.
215 -a/--clearall
218 Clears all performance statistics for all ports.
219 -m/--smadirect
222 Accesses fabric information directly from SMA.
223 -M/--pmadirect
226 Accesses performance statistics using direct PMA.
227 -A/--allports
230 Gets PortInfo for down switch ports. Uses direct SMA to get
231 this data. If used with -M, also gets PMA stats for down
232 switch ports.
233 -c/--config file
236 Specifies the error thresholds configuration file. Default is
237 /etc/opa/opamon.conf file.
238 -L/--limit
241 Limits operation to exact specified focus with -F for port
242 error counters check (-o errors) and port counters clear (-C
243 or -i). Normally, the neighbor of each selected port is also
244 checked/cleared. Does not affect other reports.
245 -F/--focus point
248 Specifies the focus area for report.
249 Limits output to reflect a subsection of the fabric. May not
252 work with all reports. (For example, route, mcgroups, and the
253 verify* reports may ignore the option or not generate useful
254 results.)
255 -S/--src point
257 Specifies the source for trace route. Default is local port.
258 -D/--dest point
261 Specifies the destination for trace route.
262 -Q/--quietfocus
265 Excludes focus description from report.
266
270 For reference:
271 -r/--routes
273 Gets routing tables for all switches.
274 -V/--vltables
277 Gets the P-Key tables for all nodes and the QoS VL-related
278 tables for all ports.
279
283 For reference:
284 comps Summary of all systems and SMs in fabric.
286 brcomps Brief summary of all systems and SMs in fabric.
289 nodes Summary of all node types and SMs in fabric.
292 brnodes Brief summary of all node types and SMs in fabric.
295 ious Summary of all IO units in the fabric.
298 lids Summary of all LIDs in the fabric.
301 links Summary of all links.
304 extlinks Summary of links external to systems.
307 filinks Summary of links to FIs.
310 islinks Summary of inter-switch links.
313 extislinks
316 Summary of inter-switch links external to systems.
317 slowlinks Summary of links running slower than expected.
320 slowconfiglinks
323 Summary of links configured to run slower than supported,
324 includes slowlinks.
325 slowconnlinks
328 Summary of links connected with mismatched speed potential,
329 includes slowconfiglinks.
330 misconfiglinks
333 Summary of links configured to run slower than supported.
334 misconnlinks
337 Summary of links connected with mismatched speed potential.
338 errors Summary of links whose errors exceed counts in the configura‐
341 tion file.
342 otherports
345 Summary of ports not connected to the fabric.
346 linear Summary of linear forwarding data base (FDB) for each switch.
349 mcast Summary of multicast FDB for each switch in the fabric.
352 mcgroups Summary of multicast groups.
355 When used in conjunction with -d, the following report
358 details are possible:
359 · -d0 : Shows the number of multicast groups
362 · -d1 : Shows a list of multicast groups
364 · -d2 : Shows a list of members per multicast group
366 This report can be used with option -X.
370 portusage Summary of ports referenced in linear FDB for each switch,
372 broken down by NodeType of DLID.
373 pathusage Summary of number of FI to FI paths routed through each
376 switch port.
377 treepathusage
380 Analysis of number of FI to FI paths routed through each
381 switch port for a FAT tree.
382 portgroups
385 Summary of adaptive routing port groups for each switch.
386 quarantinednodes
389 Summary of quarantined nodes.
390 validateroutes
393 Validates all routes in the fabric.
394 validatevlroutes
397 Validates all routes in the fabric using SLSC, SCSC, and SCVL
398 tables.
399 validatepgs
402 Validates all port groups in the fabric.
403 validatecreditloops
406 Validates topology configuration of the fabric to identify
407 any existing credit loops.
408 validatevlcreditloops
411 Validates topology configuration of the fabric including
412 SLSC, SCSC, and SCVL tables to identify any existing credit
413 loops.
414 validatemcroutes
417 Validates multicast routes of the fabric to identify loops in
418 multicast forwarding tables and detect MFT-multicast member‐
419 ship inconsistencies.
420 vfinfo Summary of virtual fabric (vFabric) information.
423 vfmember Summary of vFabric membership information.
426 verifyfis Compares fabric (or snapshot) FIs to supplied topology and
429 identifies differences and omissions.
430 verifysws Compares fabric (or snapshot) switches to supplied topology
433 and identifies differences and omissions.
434 verifynodes
437 Returns verifyfis and verifysws reports.
438 verifysms Compares fabric (or snapshot) SMs to supplied topology and
441 identifies differences and omissions.
442 verifylinks
445 Compares fabric (or snapshot) links to supplied topology and
446 identifies differences and omissions.
447 verifyextlinks
450 Compares fabric (or snapshot) links to supplied topology and
451 identifies differences and omissions. Limits analysis to
452 links external to systems.
453 verifyfilinks
456 Compares fabric (or snapshot) links to supplied topology and
457 identify differences and omissions. Limits analysis to links
458 to FIs.
459 verifyislinks
462 Compares fabric (or snapshot) links to supplied topology and
463 identify differences and omissions. Limits analysis to inter-
464 switch links.
465 verifyextislinks
468 Compares fabric (or snapshot) links to supplied topology and
469 identify differences and omissions. Limits analysis to inter-
470 switch links external to systems.
471 verifyall Returns verifyfis, verifysws, verifysms, and verifylinks
474 reports.
475 all Returns comps, nodes, ious, links, extlinks, slowconnlinks,
478 and errors reports.
479 route Traces route between -S and -D points.
482 bfrctrl Reports Buffer Control Tables for all ports.
485 snapshot Outputs snapshot of the fabric state for later use as snap‐
488 shot_input. This implies -x. May not be combined with other
489 reports. When selected, -F, -P, -H, and -N options are
490 ignored.
491 topology Outputs the topology of the fabric for later use as topol‐
494 ogy_input. This implies -x. May not be combined with other
495 reports. Use with detail level 3 or more to get Port element
496 under Node in output xml.
497 none No report, useful to clear statistics.
500
504 For reference:
505 gid:value value is numeric port GID of form: subnet:guid.
507 lid:value value is numeric LID.
510 lid:value:node
513 value is numeric LID, selects entire node with given LID.
514 lid:value:port:value2
517 value is numeric LID of node, value2 is port number.
518 portguid:value
521 value is numeric port GUID.
522 nodeguid:value
525 value is numeric node GUID.
526 nodeguid:value1:port:value2
529 value1 is numeric node GUID, value2 is port number.
530 iocguid:value
533 value is numeric IOC GUID.
534 iocguid:value1:port:value2
537 value1 is numeric IOC GUID, value2 is port number.
538 systemguid:value
541 value is numeric system image GUID.
542 systemguid:value1:port:value2
545 value1 is the numeric system image GUID, value2 is port num‐
546 ber.
547 ioc:value value is IOC Profile ID String (IOC Name).
550 ioc:value1:port:value2
553 value1 is IOC Profile ID String (IOC Name), value2 is port
554 number.
555 iocpat:value
558 value is glob pattern for IOC Profile ID String (IOC Name).
559 iocpat:value1:port:value2
562 value1 is glob pattern for IOC Profile ID String (IOC Name),
563 value2 is port number.
564 ioctype:value
567 value is IOC type (SRP or OTHER).
568 ioctype:value1:port:value2
571 value1 is IOC type (SRP or OTHER); value2 is port number.
572 node:value
575 value is node description (node name).
576 node:value1:port:value2
579 value1 is node description (node name), value2 is port num‐
580 ber.
581 nodepat:value
584 value is glob pattern for node description (node name).
585 nodepat:value1:port:value2
588 value1 is the glob pattern for the node description (node
589 name), value2 is port number.
590 nodedetpat:value
593 value is glob pattern for node details.
594 nodedetpat:value1:port:value2
597 value1 is the glob pattern for the node details, value2 is
598 port number.
599 nodetype:value
602 value is node type (SW, FI, or RT).
603 nodetype:value1:port:value2
606 value1 is node type (SW, FI, or RT), value2 is port number.
607 rate:value
610 value is string for rate (25g, 50g, 75g, 100g), omits switch
611 mgmt port 0.
612 portstate:value
615 value is a string for state (down, init, armed, active,
616 notactive, initarmed).
617 portphysstate:value
620 value is a string for PHYs state (polling, disabled, train‐
621 ing, linkup, recovery, offline, test)
622 mtucap:value
625 value is MTU size (2048, 4096, 8192, 10240), omits switch
626 mgmt port 0.
627 labelpat:value
630 value is glob pattern for cable label.
631 lengthpat:value
634 value is glob pattern for cable length.
635 cabledetpat:value
638 value is glob pattern for cable details.
639 cabinflenpat:value
642 value is glob pattern for cable info length.
643 cabinfvendnamepat:value
646 value is glob pattern for cable info vendor name.
647 cabinfvendpnpat:value
650 value is glob pattern for cable info vendor part number.
651 cabinfvendrevpat:value
654 value is glob pattern for cable info vendor revision.
655 cabinfvendsnpat:value
658 value is glob pattern for cable info vendor serial number.
659 cabinftype:value
662 value is either optical, passive_copper, active_copper, or
663 unknown.
664 linkdetpat:value
667 value is glob pattern for link details.
668 portdetpat:value
671 value is glob pattern for port details.
672 sm Specifies the master subnet manager (SM).
675 smdetpat:value
678 value is glob pattern for SM details.
679 route:point1:point2
682 Specifies all ports along the routes between the two given
683 points.
684 led:value value is either on or off for LED port beacon.
687 linkqual:value
690 Specifies the ports with a link quality equal to value.
691 linkqualLE:value
694 Specifies the ports with a link quality less than or equal to
695 value.
696 linkqualGE:value
699 Specifies the ports with a link quality greater than or equal
700 to value.
701
705 For reference:
706 opareport can generate hundreds of different reports. Commonly gener‐
708 ated reports include the following:opareport -o comps -d 3
709 opareport -o errors -o slowlinks
710 opareport -o nodes -F portguid:0x00117500a000447b
711 opareport -o nodes -F nodeguid:0x001175009800447b:port:1
712 opareport -o nodes -F nodeguid:0x001175009800447b
713 opareport -o nodes -F 'node:duster hfi1_0'
714 opareport -o nodes -F 'node:duster hfi1_0:port:1'
715 opareport -o nodes -F 'nodepat:d*'
716 opareport -o nodes -F 'nodepat:d*:port:1'
717 opareport -o nodes -F 'nodedetpat:compute*'
718 opareport -o nodes -F 'nodedetpat:compute*:port:1'
719 opareport -o nodes -F nodetype:FI
720 opareport -o nodes -F nodetype:FI:port:1
721 opareport -o nodes -F lid:1
722 opareport -o nodes -F led:on opareport -o nodes -F led:off opareport -o
723 nodes -F lid:1:node
724 opareport -o nodes -F lid:1:port:2
725 opareport -o nodes -F gid:0xfe80000000000000:0x00117500a000447b
726 opareport -o nodes -F systemguid:0x001175009800447b
727 opareport -o nodes -F systemguid:0x001175009800447b:port:1
728 opareport -o nodes -F iocguid:0x00117501300001e0
729 opareport -o nodes -F iocguid:0x00117501300001e0:port:2
730 opareport -o nodes -F 'ioc:Chassis 0x001175005000010C, Slot 2, IOC 1'
731 opareport -o nodes -F 'ioc:Chassis 0x001175005000010C, Slot 2, IOC
732 1:port:2'
733 opareport -o nodes -F 'iocpat:*Slot 2*'
734 opareport -o nodes -F 'iocpat:*Slot 2*:port:2'
735 opareport -o nodes -F ioctype:SRP opareport -o nodes -F ioc‐
736 type:SRP:port:2
737 opareport -o extlinks -F rate:100g
738 opareport -o extlinks -F portstate:armed
739 opareport -o extlinks -F portphysstate:linkup
740 opareport -o extlinks -F 'labelpat:S1345*'
741 opareport -o extlinks -F 'lengthpat:11m'
742 opareport -o extlinks -F 'cabledetpat:*hitachi*'
743 opareport -o extlinks -F 'linkdetpat:*core ISL*'
744 opareport -o extlinks -F 'portdetpat:*mgmt*'
745 opareport -o links -F mtucap:2048
746 opareport -o nodes -F sm
747 opareport -o nodes -F 'smdetpat:primary*'
748 opareport -o nodes -F 'route:node:duster hfi1_0:node:cuda hfi1_0'
749 opareport -o nodes -F 'route:node:duster hfi1_0:port:1:node:cuda
750 hfi1_0:port:2'
751 opareport -s -o snapshot > file
752 opareport -o topology > topology.xml
753 opareport -o errors -X file
754 opareport -s --begin "2 days ago"
755 opareport -s --begin "12:30" --end "14:00"
756
758 For simple fabrics, the Intel(R) Omni-Path Fabric Suite FastFabric
759 Toolset host is connected to a single fabric. By default, the first
760 active port on the FastFabric Toolset host is used to analyze the fab‐
761 ric.
762 However, in more complex fabrics, the FastFabric Toolset host may be
764 connected to more than one fabric or subnet. In this case, you can
765 specify the ports or HFIs to use with one of the following methods:
766 · On the command line using the -p option.
768 · In a file specified using the -t option.
770 · Through the environment variables PORTS or PORTS_FILE.
772 · Using the ports_file configuration option in /etc/opa/opafast‐
774 fabric.conf.
775 If the specified port does not exist or is empty, the first active port
777 on the local system is used. In more complex configurations, you must
778 specify the exact ports to use for all fabrics to be analyzed.
779 You can specify the topology_input file to be used with one of the fol‐
781 lowing methods:
782 · On the command line using the -T option.
784 · In a file specified through the environment variable FF_TOPOL‐
786 OGY_FILE.
787 · Using the ff_topology_file configuration option in opafastfab‐
789 ric.conf.
790 If the specified file does not exist, no topology_input file is used.
792 Alternately the filename can be specified as NONE to prevent use of an
793 input file.
794Copyright(C) 2015-2018 Intel Corporation opareports(8)