|
Packit |
db064d |
.\" Man page generated from reStructuredText.
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.TH IBROUTERS 8 "@BUILD_DATE@" "" "OpenIB Diagnostics"
|
|
Packit |
db064d |
.SH NAME
|
|
Packit |
db064d |
IBROUTERS \- show InfiniBand router nodes in topology
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.nr rst2man-indent-level 0
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.de1 rstReportMargin
|
|
Packit |
db064d |
\\$1 \\n[an-margin]
|
|
Packit |
db064d |
level \\n[rst2man-indent-level]
|
|
Packit |
db064d |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
Packit |
db064d |
-
|
|
Packit |
db064d |
\\n[rst2man-indent0]
|
|
Packit |
db064d |
\\n[rst2man-indent1]
|
|
Packit |
db064d |
\\n[rst2man-indent2]
|
|
Packit |
db064d |
..
|
|
Packit |
db064d |
.de1 INDENT
|
|
Packit |
db064d |
.\" .rstReportMargin pre:
|
|
Packit |
db064d |
. RS \\$1
|
|
Packit |
db064d |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
Packit |
db064d |
. nr rst2man-indent-level +1
|
|
Packit |
db064d |
.\" .rstReportMargin post:
|
|
Packit |
db064d |
..
|
|
Packit |
db064d |
.de UNINDENT
|
|
Packit |
db064d |
. RE
|
|
Packit |
db064d |
.\" indent \\n[an-margin]
|
|
Packit |
db064d |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
Packit |
db064d |
.nr rst2man-indent-level -1
|
|
Packit |
db064d |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
Packit |
db064d |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
Packit |
db064d |
..
|
|
Packit |
db064d |
.SH SYNOPSIS
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
ibrouters [options] [<topology\-file>]
|
|
Packit |
db064d |
.SH DESCRIPTION
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
ibrouters is a script which either walks the IB subnet topology or uses an
|
|
Packit |
db064d |
already saved topology file and extracts the router nodes.
|
|
Packit |
db064d |
.SH OPTIONS
|
|
Packit |
db064d |
.\" Define the common option -C
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name.
|
|
Packit |
db064d |
.\" Define the common option -P
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port.
|
|
Packit |
db064d |
.\" Define the common option -t
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
|
|
Packit |
db064d |
.\" Define the common option -y
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-y, \-\-m_key <key>\fP
|
|
Packit |
db064d |
use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
|
|
Packit |
db064d |
is specified then a value will be prompted for.
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Define the common option -h
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-h, \-\-help\fP show the usage message
|
|
Packit |
db064d |
.\" Define the common option -z
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-\-config, \-z <config_file>\fP Specify alternate config file.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
Default: @IBDIAG_CONFIG_PATH@/ibdiag.conf
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Explanation of local port selection
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.SS Local port Selection
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
Multiple port/Multiple CA support: when no IB device or port is specified
|
|
Packit |
db064d |
(see the "local umad parameters" below), the libibumad library
|
|
Packit |
db064d |
selects the port to use by the following criteria:
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.IP 1. 3
|
|
Packit |
db064d |
the first port that is ACTIVE.
|
|
Packit |
db064d |
.IP 2. 3
|
|
Packit |
db064d |
if not found, the first port that is UP (physical link up).
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
If a port and/or CA name is specified, the libibumad library attempts
|
|
Packit |
db064d |
to fulfill the user request, and will fail if it is not possible.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
For example:
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
.nf
|
|
Packit |
db064d |
.ft C
|
|
Packit |
db064d |
ibaddr # use the first port (criteria #1 above)
|
|
Packit |
db064d |
ibaddr \-C mthca1 # pick the best port from "mthca1" only.
|
|
Packit |
db064d |
ibaddr \-P 2 # use the second (active/up) port from the first available IB device.
|
|
Packit |
db064d |
ibaddr \-C mthca0 \-P 2 # use the specified port only.
|
|
Packit |
db064d |
.ft P
|
|
Packit |
db064d |
.fi
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.SH FILES
|
|
Packit |
db064d |
.\" Common text for the config file
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.SS CONFIG FILE
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
@IBDIAG_CONFIG_PATH@/ibdiag.conf
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
A global config file is provided to set some of the common options for all
|
|
Packit |
db064d |
tools. See supplied config file for details.
|
|
Packit |
db064d |
.\" Common text to describe the node name map file.
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.SS NODE NAME MAP FILE FORMAT
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
The node name map is used to specify user friendly names for nodes in the
|
|
Packit |
db064d |
output. GUIDs are used to perform the lookup.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP
|
|
Packit |
db064d |
for the file location for your installation.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fBGenerically:\fP
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
.nf
|
|
Packit |
db064d |
.ft C
|
|
Packit |
db064d |
# comment
|
|
Packit |
db064d |
<guid> "<name>"
|
|
Packit |
db064d |
.ft P
|
|
Packit |
db064d |
.fi
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fBExample:\fP
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
.nf
|
|
Packit |
db064d |
.ft C
|
|
Packit |
db064d |
# IB1
|
|
Packit |
db064d |
# Line cards
|
|
Packit |
db064d |
0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D"
|
|
Packit |
db064d |
0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D"
|
|
Packit |
db064d |
0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D"
|
|
Packit |
db064d |
0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D"
|
|
Packit |
db064d |
0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D"
|
|
Packit |
db064d |
|
|
Packit |
db064d |
# Spines
|
|
Packit |
db064d |
0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D"
|
|
Packit |
db064d |
0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D"
|
|
Packit |
db064d |
0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D"
|
|
Packit |
db064d |
0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D"
|
|
Packit |
db064d |
0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D"
|
|
Packit |
db064d |
|
|
Packit |
db064d |
# GUID Node Name
|
|
Packit |
db064d |
0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D"
|
|
Packit |
db064d |
0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D"
|
|
Packit |
db064d |
0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D"
|
|
Packit |
db064d |
0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D"
|
|
Packit |
db064d |
.ft P
|
|
Packit |
db064d |
.fi
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.SH SEE ALSO
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
ibnetdiscover(8)
|
|
Packit |
db064d |
.SH DEPENDENCIES
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
ibnetdiscover, ibnetdiscover format
|
|
Packit |
db064d |
.SH AUTHOR
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B Hal Rosenstock
|
|
Packit |
db064d |
< \fI\%halr@voltaire.com\fP >
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Generated by docutils manpage writer.
|
|
Packit |
db064d |
.
|