contrib/ofed/management/infiniband-diags/man/ibnetdiscover.8

   1 .TH IBNETDISCOVER 8 "January 3, 2008" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 ibnetdiscover \- discover InfiniBand topology
   5
   6 .SH SYNOPSIS
   7 .B ibnetdiscover
   8 [\-d(ebug)] [\-e(rr_show)] [\-v(erbose)] [\-s(how)] [\-l(ist)] [\-g(rouping)] [\-H(ca_list)] [\-S(witch_list)] [\-R(outer_list)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\--node-name-map <node-name-map>] [\-p(orts)] [\-h(elp)] [<topology-file>]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 ibnetdiscover performs IB subnet discovery and outputs a human readable
  13 topology file. GUIDs, node types, and port numbers are displayed
  14 as well as port LIDs and NodeDescriptions.  All nodes (and links) are displayed
  15 (full topology).  Optionally, this utility can be used to list the current
  16 connected nodes by nodetype.  The output is printed to standard output
  17 unless a topology file is specified.
  18
  19 .SH OPTIONS
  20
  21 .PP
  22 .TP
  23 \fB\-l\fR, \fB\-\-list\fR
  24 List of connected nodes
  25 .TP
  26 \fB\-g\fR, \fB\-\-grouping\fR
  27 Show grouping.  Grouping correlates IB nodes by different vendor specific
  28 schemes.  It may also show the switch external ports correspondence.
  29 .TP
  30 \fB\-H\fR, \fB\-\-Hca_list\fR
  31 List of connected CAs
  32 .TP
  33 \fB\-S\fR, \fB\-\-Switch_list\fR
  34 List of connected switches
  35 .TP
  36 \fB\-R\fR, \fB\-\-Router_list\fR
  37 List of connected routers
  38 .TP
  39 \fB\-s\fR, \fB\-\-show\fR
  40 Show more information
  41 .TP
  42 \fB\-\-node\-name\-map\fR <node-name-map>
  43 Specify a node name map.  The node name map file maps GUIDs to more user friendly
  44 names.  See file format below.
  45 .TP
  46 \fB\-p\fR, \fB\-\-ports\fR
  47 Obtain a ports report which is a
  48 list of connected ports with relevant information (like LID, portnum,
  49 GUID, width, speed, and NodeDescription).
  50
  51 .SH COMMON OPTIONS
  52
  53 Most OpenIB diagnostics take the following common flags. The exact list of
  54 supported flags per utility can be found in the usage message and can be shown
  55 using the util_name -h syntax.
  56
  57 # Debugging flags
  58 .PP
  59 \-d      raise the IB debugging level.
  60         May be used several times (-ddd or -d -d -d).
  61 .PP
  62 \-e      show send and receive errors (timeouts and others)
  63 .PP
  64 \-h      show the usage message
  65 .PP
  66 \-v      increase the application verbosity level.
  67         May be used several times (-vv or -v -v -v)
  68 .PP
  69 \-V      show the version info.
  70
  71 # Other common flags:
  72 .PP
  73 \-C <ca_name>    use the specified ca_name.
  74 .PP
  75 \-P <ca_port>    use the specified ca_port.
  76 .PP
  77 \-t <timeout_ms> override the default timeout for the solicited mads.
  78
  79 Multiple CA/Multiple Port Support
  80
  81 When no IB device or port is specified, the port to use is selected
  82 by the following criteria:
  83 .PP
  84 1. the first port that is ACTIVE.
  85 .PP
  86 2. if not found, the first port that is UP (physical link up).
  87
  88 If a port and/or CA name is specified, the user request is
  89 attempted to be fulfilled, and will fail if it is not possible.
  90
  91 .SH TOPOLOGY FILE FORMAT
  92 The topology file format is human readable and largely intuitive.
  93 Most identifiers are given textual names like vendor ID (vendid), device ID
  94 (device ID), GUIDs of various types (sysimgguid, caguid, switchguid, etc.).
  95 PortGUIDs are shown in parentheses ().  For switches, this is shown on the
  96 switchguid line.  For CA and router ports, it is shown on the connectivity lines.  The IB node is identified followed by the number of ports and a quoted
  97 the node GUID.  On the right of this line is a comment (#) followed by the
  98 NodeDescription in quotes.  If the node is a switch, this line also contains
  99 whether switch port 0 is base or enhanced, and the LID and LMC of port 0.
 100 Subsequent lines pertaining to this node show the connectivity.   On the
 101 left is the port number of the current node.  On the right is the peer node
 102 (node at other end of link). It is identified in quotes with nodetype
 103 followed by - followed by NodeGUID with the port number in square brackets.
 104 Further on the right is a comment (#).  What follows the comment is
 105 dependent on the node type.  If it it a switch node, it is followed by
 106 the NodeDescription in quotes and the LID of the peer node.  If it is a
 107 CA or router node, it is followed by the local LID and LMC and then
 108 followed by the NodeDescription in quotes and the LID of the peer node.
 109 The active link width and speed are then appended to the end of this
 110 output line.
 111
 112 An example of this is:
 113 .nf
 114 #
 115 # Topology file: generated on Tue Jun  5 14:15:10 2007
 116 #
 117 # Max of 3 hops discovered
 118 # Initiated from node 0008f10403960558 port 0008f10403960559
 119
 120 Non-Chassis Nodes
 121
 122 vendid=0x8f1
 123 devid=0x5a06
 124 sysimgguid=0x5442ba00003000
 125 switchguid=0x5442ba00003080(5442ba00003080)
 126 Switch  24 "S-005442ba00003080"         # "ISR9024 Voltaire" base port 0 lid 6 lmc 0
 127 [22]    "H-0008f10403961354"[1](8f10403961355)         # "MT23108 InfiniHost Mellanox Technologies" lid 4 4xSDR
 128 [10]    "S-0008f10400410015"[1]         # "SW-6IB4 Voltaire" lid 3 4xSDR
 129 [8]     "H-0008f10403960558"[2](8f1040396055a)         # "MT23108 InfiniHost Mellanox Technologies" lid 14 4xSDR
 130 [6]     "S-0008f10400410015"[3]         # "SW-6IB4 Voltaire" lid 3 4xSDR
 131 [12]    "H-0008f10403960558"[1](8f10403960559)         # "MT23108 InfiniHost Mellanox Technologies" lid 10 4xSDR
 132
 133 vendid=0x8f1
 134 devid=0x5a05
 135 switchguid=0x8f10400410015(8f10400410015)
 136 Switch  8 "S-0008f10400410015"          # "SW-6IB4 Voltaire" base port 0 lid 3 lmc 0
 137 [6]     "H-0008f10403960984"[1](8f10403960985)         # "MT23108 InfiniHost Mellanox Technologies" lid 16 4xSDR
 138 [4]     "H-005442b100004900"[1](5442b100004901)        # "MT23108 InfiniHost Mellanox Technologies" lid 12 4xSDR
 139 [1]     "S-005442ba00003080"[10]                # "ISR9024 Voltaire" lid 6 1xSDR
 140 [3]     "S-005442ba00003080"[6]         # "ISR9024 Voltaire" lid 6 4xSDR
 141
 142 vendid=0x2c9
 143 devid=0x5a44
 144 caguid=0x8f10403960984
 145 Ca      2 "H-0008f10403960984"          # "MT23108 InfiniHost Mellanox Technologies"
 146 [1](8f10403960985)     "S-0008f10400410015"[6]         # lid 16 lmc 1 "SW-6IB4 Voltaire" lid 3 4xSDR
 147
 148 vendid=0x2c9
 149 devid=0x5a44
 150 caguid=0x5442b100004900
 151 Ca      2 "H-005442b100004900"          # "MT23108 InfiniHost Mellanox Technologies"
 152 [1](5442b100004901)     "S-0008f10400410015"[4]         # lid 12 lmc 1 "SW-6IB4 Voltaire" lid 3 4xSDR
 153
 154 vendid=0x2c9
 155 devid=0x5a44
 156 caguid=0x8f10403961354
 157 Ca      2 "H-0008f10403961354"          # "MT23108 InfiniHost Mellanox Technologies"
 158 [1](8f10403961355)     "S-005442ba00003080"[22]                # lid 4 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR
 159
 160 vendid=0x2c9
 161 devid=0x5a44
 162 caguid=0x8f10403960558
 163 Ca      2 "H-0008f10403960558"          # "MT23108 InfiniHost Mellanox Technologies"
 164 [2](8f1040396055a)     "S-005442ba00003080"[8]         # lid 14 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR
 165 [1](8f10403960559)     "S-005442ba00003080"[12]                # lid 10 lmc 1 "ISR9024 Voltaire" lid 6 1xSDR
 166 .fi
 167
 168 When grouping is used, IB nodes are organized into chasses which are
 169 numbered. Nodes which cannot be determined to be in a chassis are
 170 displayed as "Non-Chassis Nodes".  External ports are also shown on the
 171 connectivity lines.
 172
 173
 174 .SH NODE NAME MAP FILE FORMAT
 175 The node name map is used to specify user friendly names for nodes in the
 176 output.  GUIDs are used to perform the lookup.
 177
 178 .TP
 179 \fBGenerically:\fR
 180
 181 # comment
 182 .br
 183 <guid> "<name>"
 184
 185 .TP
 186 \fBExample:\fR
 187
 188 # IB1
 189 .br
 190 # Line cards
 191 .br
 192 0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
 193 .br
 194 0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
 195 .br
 196 0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
 197 .br
 198 0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
 199 .br
 200 0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
 201 .br
 202 .br
 203 # Spines
 204 .br
 205 0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
 206 .br
 207 0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
 208 .br
 209 0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
 210 .br
 211 0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
 212 .br
 213 0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
 214 .br
 215 .br
 216 # GUID   Node Name
 217 .br
 218 0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
 219 .br
 220 0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
 221 .br
 222 0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
 223 .br
 224 0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
 225 .br
 226
 227 .SH AUTHORS
 228 .TP
 229 Hal Rosenstock
 230 .RI < halr@voltaire.com >
 231 .TP
 232 Ira Weiny
 233 .RI < weiny2@llnl.gov >