1IBDIAGNET(1) IB DIAGNOSTIC PACKAGE IBDIAGNET(1)
2
6 ibdiagnet - IB diagnostic net
7
9 ibdiagnet [-c <count>] [-v] [-r] [-vlr] [-u] [-o <out-dir>]
10 [-t <topo-file>] [-s <sys-name>] [-i <dev-index>] [-p <port-num>]
11 [-wt]
12 [-pm] [-pc] [-P <<PM>=<Value>>]
13 [-lw <1x|4x|12x>] [-ls <2.5|5|10>]
14 [-skip <ibdiag_check/s>] [-load_db <db_file>]
15
17 ibdiagnet scans the fabric using directed route packets and extracts
18 all the available information regarding its connectivity and devices.
19 It then produces the following files in the output directory (which
20 defined by the -o option (see below)).
21
23 ibdiagnet.log -
24 A dump of all the application reports generate according to the
25 provided flags
26 ibdiagnet.lst -
28 List of all the nodes, ports and links in the fabric
29 ibdiagnet.fdbs -
31 A dump of the unicast forwarding tables of the fabric switches
32 ibdiagnet.mcfdbs -
34 A dump of the multicast forwarding tables of the fabric switches
35 ibdiagnet.masks -
37 In case of duplicate port/node Guids, these file include the map
38 between masked Guid and real Guids
39 ibdiagnet.sm -
41 List of all the SM (state and priority) in the fabric
42 ibdiagnet.pm -
44 A dump of the pm Counters values, of the fabric links
45 ibdiagnet.pkey -
47 A dump of the the existing partitions and their member host ports
48 ibdiagnet.mcgs -
50 A dump of the multicast groups, their properties and member host
51 ports
52 ibdiagnet.psl -
54 A dump of the path record SL of each possible source node guid and
55 DLID pairs. Created only if -vlr option is provided
56 ibdiagnet.slvl -
58 A dump of the SL2VL Tables from all the switches. Created only if
59 -vlr option is provided
60 ibdiagnet.db -
62 A dump of the internal subnet database. This file can be loaded in
63 later runs using the -load_db option
64 In addition to generating the files above, the discovery phase also
66 checks for duplicate node/port GUIDs in the IB fabric. If such an error
67 is detected, it is displayed on the standard output. After the
68 discovery phase is completed, directed route packets are sent multiple
69 times (according to the -c option) to detect possible problematic paths
70 on which packets may be lost. Such paths are explored, and a report of
71 the suspected bad links is displayed on the standard output.
72 After scanning the fabric, if the -r option is provided, a full report
74 of the fabric qualities is displayed. This report includes:
75 • SM report
77 • Number of nodes and systems
79 • Hop-count information
81 maximal hop-count, an example path, and a hop-count histogram
83 • All CA-to-CA paths traced
84 • Credit loop report
86 • mgid-mlid-HCAs multicast group and report
88 • Partitions report
90 • IPoIB report
92 Note: In case the IB fabric includes only one CA, then CA-to-CA paths
94 are not reported. Furthermore, if a topology file is provided,
95 ibdiagnet uses the names defined in it for the output reports.
96
98 -c <count> :
99 Min number of packets to be sent across each link (default = 10)
100 -v :
101 Enable verbose mode
102 -r :
103 Provides a report of the fabric qualities
104 -u :
105 Credit loop check based on UpDown rules
106 -t <topo-file> :
107 Specifies the topology file name
108 -s <sys-name> :
109 Specifies the local system name. Meaningful only if a topology
110 file is specified
111 -i <dev-index> :
112 Specifies the index of the device of the port used to connect to
113 the IB fabric (in case of multiple devices on the local system)
114 -p <port-num> :
115 Specifies the local device's port num used to connect to the IB
116 fabric
117 -o <out-dir> :
118 Specifies the directory where the output files will be placed
119 (default = /tmp)
120 -lw <1x|4x|12x> :
121 Specifies the expected link width
122 -ls <2.5|5|10> :
123 Specifies the expected link speed
124 -pm :
125 Dump all the fabric links, pm Counters into ibdiagnet.pm
126 -pc :
127 Reset all the fabric links pmCounters
128 -P <PM=<Trash>> :
129 If any of the provided pm is greater then its provided value,
130 print it to screen
131 -skip <skip-option(s)> :
132 Skip the executions of the selected checks. Skip options (one or
133 more can be specified) : dup_guids zero_guids pm logical_state
134 part ipoib all
135 -wt <file-name>> :
136 Write out the discovered topology into the given file. This flag
137 is useful if you later want to check for changes from the current
138 state of the fabric. A directory named ibdiag_ibnl is also created
139 by this option, and holds the IBNL files required to load this
140 topology. To use these files you will need to set the environment
141 variable named IBDM_IBNL_PATH to that directory. The directory is
142 located in /tmp or in the output directory provided by the -o flag.
143 -load_db <file-name>> :
144 Load subnet data from the given .db file, and skip subnet
145 discovery stage. Note: Some of the checks require actual subnet
146 discovery, and therefore would not run when load_db is specified.
147 These checks are : Duplicated/zero guids, link state, SMs status.
148 -vlr :
149 VL based Routing - provide this option to create the paths SL file
150 (psl), SL2VL file (slvl) and use them in credit loops check (if -r
151 option is provided).
152 NOTE: Since number of paths is N^2 extracting the PSL file may
153 take some time.
154 -h|--help :
156 Prints the help page information
157 -V|--version :
158 Prints the version of the tool
159 --vars :
160 Prints the tool's environment variables and their values
161
163 1 - Failed to fully discover the fabric
164 2 - Failed to parse command line options
165 3 - Failed to intract with IB fabric
166 4 - Failed to use local device or local port
167 5 - Failed to use Topology File
168 6 - Failed to load requierd Package
169IBDIAG 1.0 2021-01-26 IBDIAGNET(1)