234 lines
8.1 KiB
Groff
234 lines
8.1 KiB
Groff
.TH IBNETDISCOVER 8 "January 3, 2008" "OpenIB" "OpenIB Diagnostics"
|
|
|
|
.SH NAME
|
|
ibnetdiscover \- discover InfiniBand topology
|
|
|
|
.SH SYNOPSIS
|
|
.B ibnetdiscover
|
|
[\-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>]
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
ibnetdiscover performs IB subnet discovery and outputs a human readable
|
|
topology file. GUIDs, node types, and port numbers are displayed
|
|
as well as port LIDs and NodeDescriptions. All nodes (and links) are displayed
|
|
(full topology). Optionally, this utility can be used to list the current
|
|
connected nodes by nodetype. The output is printed to standard output
|
|
unless a topology file is specified.
|
|
|
|
.SH OPTIONS
|
|
|
|
.PP
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-list\fR
|
|
List of connected nodes
|
|
.TP
|
|
\fB\-g\fR, \fB\-\-grouping\fR
|
|
Show grouping. Grouping correlates IB nodes by different vendor specific
|
|
schemes. It may also show the switch external ports correspondence.
|
|
.TP
|
|
\fB\-H\fR, \fB\-\-Hca_list\fR
|
|
List of connected CAs
|
|
.TP
|
|
\fB\-S\fR, \fB\-\-Switch_list\fR
|
|
List of connected switches
|
|
.TP
|
|
\fB\-R\fR, \fB\-\-Router_list\fR
|
|
List of connected routers
|
|
.TP
|
|
\fB\-s\fR, \fB\-\-show\fR
|
|
Show more information
|
|
.TP
|
|
\fB\-\-node\-name\-map\fR <node-name-map>
|
|
Specify a node name map. The node name map file maps GUIDs to more user friendly
|
|
names. See file format below.
|
|
.TP
|
|
\fB\-p\fR, \fB\-\-ports\fR
|
|
Obtain a ports report which is a
|
|
list of connected ports with relevant information (like LID, portnum,
|
|
GUID, width, speed, and NodeDescription).
|
|
|
|
.SH COMMON OPTIONS
|
|
|
|
Most OpenIB diagnostics take the following common flags. The exact list of
|
|
supported flags per utility can be found in the usage message and can be shown
|
|
using the util_name -h syntax.
|
|
|
|
# Debugging flags
|
|
.PP
|
|
\-d raise the IB debugging level.
|
|
May be used several times (-ddd or -d -d -d).
|
|
.PP
|
|
\-e show send and receive errors (timeouts and others)
|
|
.PP
|
|
\-h show the usage message
|
|
.PP
|
|
\-v increase the application verbosity level.
|
|
May be used several times (-vv or -v -v -v)
|
|
.PP
|
|
\-V show the version info.
|
|
|
|
# Other common flags:
|
|
.PP
|
|
\-C <ca_name> use the specified ca_name.
|
|
.PP
|
|
\-P <ca_port> use the specified ca_port.
|
|
.PP
|
|
\-t <timeout_ms> override the default timeout for the solicited mads.
|
|
|
|
Multiple CA/Multiple Port Support
|
|
|
|
When no IB device or port is specified, the port to use is selected
|
|
by the following criteria:
|
|
.PP
|
|
1. the first port that is ACTIVE.
|
|
.PP
|
|
2. if not found, the first port that is UP (physical link up).
|
|
|
|
If a port and/or CA name is specified, the user request is
|
|
attempted to be fulfilled, and will fail if it is not possible.
|
|
|
|
.SH TOPOLOGY FILE FORMAT
|
|
The topology file format is human readable and largely intuitive.
|
|
Most identifiers are given textual names like vendor ID (vendid), device ID
|
|
(device ID), GUIDs of various types (sysimgguid, caguid, switchguid, etc.).
|
|
PortGUIDs are shown in parentheses (). For switches, this is shown on the
|
|
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
|
|
the node GUID. On the right of this line is a comment (#) followed by the
|
|
NodeDescription in quotes. If the node is a switch, this line also contains
|
|
whether switch port 0 is base or enhanced, and the LID and LMC of port 0.
|
|
Subsequent lines pertaining to this node show the connectivity. On the
|
|
left is the port number of the current node. On the right is the peer node
|
|
(node at other end of link). It is identified in quotes with nodetype
|
|
followed by - followed by NodeGUID with the port number in square brackets.
|
|
Further on the right is a comment (#). What follows the comment is
|
|
dependent on the node type. If it it a switch node, it is followed by
|
|
the NodeDescription in quotes and the LID of the peer node. If it is a
|
|
CA or router node, it is followed by the local LID and LMC and then
|
|
followed by the NodeDescription in quotes and the LID of the peer node.
|
|
The active link width and speed are then appended to the end of this
|
|
output line.
|
|
|
|
An example of this is:
|
|
.nf
|
|
#
|
|
# Topology file: generated on Tue Jun 5 14:15:10 2007
|
|
#
|
|
# Max of 3 hops discovered
|
|
# Initiated from node 0008f10403960558 port 0008f10403960559
|
|
|
|
Non-Chassis Nodes
|
|
|
|
vendid=0x8f1
|
|
devid=0x5a06
|
|
sysimgguid=0x5442ba00003000
|
|
switchguid=0x5442ba00003080(5442ba00003080)
|
|
Switch 24 "S-005442ba00003080" # "ISR9024 Voltaire" base port 0 lid 6 lmc 0
|
|
[22] "H-0008f10403961354"[1](8f10403961355) # "MT23108 InfiniHost Mellanox Technologies" lid 4 4xSDR
|
|
[10] "S-0008f10400410015"[1] # "SW-6IB4 Voltaire" lid 3 4xSDR
|
|
[8] "H-0008f10403960558"[2](8f1040396055a) # "MT23108 InfiniHost Mellanox Technologies" lid 14 4xSDR
|
|
[6] "S-0008f10400410015"[3] # "SW-6IB4 Voltaire" lid 3 4xSDR
|
|
[12] "H-0008f10403960558"[1](8f10403960559) # "MT23108 InfiniHost Mellanox Technologies" lid 10 4xSDR
|
|
|
|
vendid=0x8f1
|
|
devid=0x5a05
|
|
switchguid=0x8f10400410015(8f10400410015)
|
|
Switch 8 "S-0008f10400410015" # "SW-6IB4 Voltaire" base port 0 lid 3 lmc 0
|
|
[6] "H-0008f10403960984"[1](8f10403960985) # "MT23108 InfiniHost Mellanox Technologies" lid 16 4xSDR
|
|
[4] "H-005442b100004900"[1](5442b100004901) # "MT23108 InfiniHost Mellanox Technologies" lid 12 4xSDR
|
|
[1] "S-005442ba00003080"[10] # "ISR9024 Voltaire" lid 6 1xSDR
|
|
[3] "S-005442ba00003080"[6] # "ISR9024 Voltaire" lid 6 4xSDR
|
|
|
|
vendid=0x2c9
|
|
devid=0x5a44
|
|
caguid=0x8f10403960984
|
|
Ca 2 "H-0008f10403960984" # "MT23108 InfiniHost Mellanox Technologies"
|
|
[1](8f10403960985) "S-0008f10400410015"[6] # lid 16 lmc 1 "SW-6IB4 Voltaire" lid 3 4xSDR
|
|
|
|
vendid=0x2c9
|
|
devid=0x5a44
|
|
caguid=0x5442b100004900
|
|
Ca 2 "H-005442b100004900" # "MT23108 InfiniHost Mellanox Technologies"
|
|
[1](5442b100004901) "S-0008f10400410015"[4] # lid 12 lmc 1 "SW-6IB4 Voltaire" lid 3 4xSDR
|
|
|
|
vendid=0x2c9
|
|
devid=0x5a44
|
|
caguid=0x8f10403961354
|
|
Ca 2 "H-0008f10403961354" # "MT23108 InfiniHost Mellanox Technologies"
|
|
[1](8f10403961355) "S-005442ba00003080"[22] # lid 4 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR
|
|
|
|
vendid=0x2c9
|
|
devid=0x5a44
|
|
caguid=0x8f10403960558
|
|
Ca 2 "H-0008f10403960558" # "MT23108 InfiniHost Mellanox Technologies"
|
|
[2](8f1040396055a) "S-005442ba00003080"[8] # lid 14 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR
|
|
[1](8f10403960559) "S-005442ba00003080"[12] # lid 10 lmc 1 "ISR9024 Voltaire" lid 6 1xSDR
|
|
.fi
|
|
|
|
When grouping is used, IB nodes are organized into chasses which are
|
|
numbered. Nodes which cannot be determined to be in a chassis are
|
|
displayed as "Non-Chassis Nodes". External ports are also shown on the
|
|
connectivity lines.
|
|
|
|
|
|
.SH NODE NAME MAP FILE FORMAT
|
|
The node name map is used to specify user friendly names for nodes in the
|
|
output. GUIDs are used to perform the lookup.
|
|
|
|
.TP
|
|
\fBGenerically:\fR
|
|
|
|
# comment
|
|
.br
|
|
<guid> "<name>"
|
|
|
|
.TP
|
|
\fBExample:\fR
|
|
|
|
# IB1
|
|
.br
|
|
# Line cards
|
|
.br
|
|
0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB-24D"
|
|
.br
|
|
0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB-24D"
|
|
.br
|
|
0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB-24D"
|
|
.br
|
|
0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB-24D"
|
|
.br
|
|
0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB-24D"
|
|
.br
|
|
.br
|
|
# Spines
|
|
.br
|
|
0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
|
|
.br
|
|
0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
|
|
.br
|
|
0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
|
|
.br
|
|
0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB-12D"
|
|
.br
|
|
0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB-12D"
|
|
.br
|
|
.br
|
|
# GUID Node Name
|
|
.br
|
|
0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D"
|
|
.br
|
|
0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D"
|
|
.br
|
|
0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D"
|
|
.br
|
|
0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D"
|
|
.br
|
|
|
|
.SH AUTHORS
|
|
.TP
|
|
Hal Rosenstock
|
|
.RI < halr@voltaire.com >
|
|
.TP
|
|
Ira Weiny
|
|
.RI < weiny2@llnl.gov >
|