xref: /freebsd/contrib/ofed/infiniband-diags/man/iblinkinfo.8 (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
Man page generated from reStructuredText.
.
IBLINKINFO 8 "" "" "OpenIB Diagnostics"
NAME
IBLINKINFO - report link info for all links in the fabric . .nr rst2man-indent-level 0 . \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .rstReportMargin pre:
. RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .rstReportMargin post:
.. . RE indent \\n[an-margin]
old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1 new: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
SYNOPSIS
iblinkinfo <options>
DESCRIPTION
iblinkinfo reports link info for each port in an IB fabric, node by node. Optionally, iblinkinfo can do partial scans and limit its output to parts of a fabric.
OPTIONS
--down, -d Print only nodes which have a port in the "Down" state. --line, -l Print all information for each link on one line. Default is to print a header with the node information and then a list for each port (useful for grep\(aqing output). --additional, -p Print additional port settings (<LifeTime>,<HoqLife>,<VLStallCount>) --switches-only Show only switches in output. --cas-only Show only CAs in output.
Partial Scan flags
The node to start a partial scan can be specified with the following addresses. Define the common option -G
. --port-guid, -G <port_guid> Specify a port_guid Define the common option -D for Directed routes
. -D, --Direct <dr_path> The address specified is a directed route NDENT 0.0 NDENT 3.5
Examples:
 -D "0" # self port
 -D "0,1,2,1,4" # out via port 1, then 2, ...

 (Note the second number in the path specified must match the port being
 used. This can be specified using the port selection flag \(aq-P\(aq or the
 port found through the automatic selection process.)
NINDENT NINDENT Note: For switches results are printed for all ports not just switch port 0. --switch, -S <port_guid> same as "-G". (provided only for backward compatibility) How much of the scan to be printed can be controled with the following. --all, -a Print all nodes found in a partial fabric scan. Normally a partial fabric scan will return only the node specified. This option will print the other nodes found as well. --hops, -n <hops> Specify the number of hops away from a specified node to scan. This is useful to expand a partial fabric scan beyond the node specified.
Cache File flags
Define the common option load-cache
. --load-cache <filename> Load and use the cached ibnetdiscover data stored in the specified filename. May be useful for outputting and learning about other fabrics or a previous state of a fabric. Define the common option diff
. --diff <filename> Load cached ibnetdiscover data and do a diff comparison to the current network or another cache. A special diff output for ibnetdiscover output will be displayed showing differences between the old and current fabric. By default, the following are compared for differences: switches, channel adapters, routers, and port connections. Define the common option diffcheck
. --diffcheck <key(s)> Specify what diff checks should be done in the --diff option above. Comma separate multiple diff check key(s). The available diff checks are: sw = switches, ca = channel adapters, router = routers, port = port connections, lid = lids, nodedesc = node descriptions. Note that port, lid, and nodedesc are checked only for the node types that are specified (e.g. sw, ca, router). If port is specified alongside lid or nodedesc, remote port lids and node descriptions will also be compared. --filterdownports <filename> Filter downports indicated in a ibnetdiscover cache. If a port was previously indicated as down in the specified cache, and is still down, do not output it in the resulting output. This option may be particularly useful for environments where switches are not fully populated, thus much of the default iblinkinfo info is considered unuseful. See ibnetdiscover for information on caching ibnetdiscover output.
Port Selection flags
Define the common option -C
. -C, --Ca <ca_name> use the specified ca_name. Define the common option -P
. -P, --Port <ca_port> use the specified ca_port. Explanation of local port selection
.
Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria: NDENT 0.0 NDENT 3.5 NDENT 0.0
1. 3
the first port that is ACTIVE.
2. 3
if not found, the first port that is UP (physical link up). NINDENT If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible. For example: NDENT 0.0 NDENT 3.5
ibaddr # use the first port (criteria #1 above)
ibaddr -C mthca1 # pick the best port from "mthca1" only.
ibaddr -P 2 # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2 # use the specified port only.
NINDENT NINDENT NINDENT NINDENT
Configuration flags
Define the common option -z
. --config, -z <config_file> Specify alternate config file. NDENT 0.0 NDENT 3.5 Default: /etc/infiniband-diags/ibdiag.conf NINDENT NINDENT Define the common option -z
. NDENT 0.0

--outstanding_smps, -o <val> Specify the number of outstanding SMP\(aqs which should be issued during the scan Default: 2 NINDENT Define the common option --node-name-map
. --node-name-map <node-name-map> Specify a node name map. NDENT 0.0 NDENT 3.5 This file maps GUIDs to more user friendly names. See FILES section. NINDENT NINDENT Define the common option -t
. -t, --timeout <timeout_ms> override the default timeout for the solicited mads. Define the common option -y
. NDENT 0.0

-y, --m_key <key> use the specified M_key for requests. If non-numeric value (like \(aqx\(aq) is specified then a value will be prompted for. NINDENT

Debugging flags
Define the common option -e
. NDENT 0.0

-e show send and receive errors (timeouts and others) NINDENT Define the common option -h
. -h, --help show the usage message Define the common option -v
. NDENT 0.0

-v, --verbose increase the application verbosity level. May be used several times (-vv or -v -v -v) NINDENT Define the common option -V
. -V, --version show the version info.

EXIT STATUS
0 on success, -1 on failure to scan the fabric, 1 if check mode is used and inconsistencies are found.
FILES
Common text for the config file
.
CONFIG FILE
/etc/infiniband-diags/ibdiag.conf A global config file is provided to set some of the common options for all tools. See supplied config file for details. Common text to describe the node name map file.
.
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. This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation. Generically: NDENT 0.0 NDENT 3.5
# comment
<guid> "<name>"
NINDENT NINDENT Example: NDENT 0.0 NDENT 3.5
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB-24D"

# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB-12D"

# GUID Node Name
0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D"
NINDENT NINDENT
AUTHOR
NDENT 0.0

Ira Weiny < \%ira.weiny@intel.com > NINDENT Generated by docutils manpage writer.
.