Blame doc/man/sminfo.8.in

Packit db064d
.\" Man page generated from reStructuredText.
Packit db064d
.
Packit db064d
.TH SMINFO 8 "@BUILD_DATE@" "" "Open IB Diagnostics"
Packit db064d
.SH NAME
Packit db064d
sminfo \- query InfiniBand SMInfo attribute
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
sminfo [options] sm_lid | sm_dr_path [modifier]
Packit db064d
.SH DESCRIPTION
Packit db064d
.sp
Packit db064d
Optionally set and display the output of a sminfo query in human readable
Packit db064d
format. The target SM is the one listed in the local port info, or the SM
Packit db064d
specified by the optional SM lid or by the SM direct routed path.
Packit db064d
.sp
Packit db064d
Note: using sminfo for any purposes other then simple query may be very
Packit db064d
dangerous, and may result in a malfunction of the target SM.
Packit db064d
.SH OPTIONS
Packit db064d
.INDENT 0.0
Packit db064d
.TP
Packit db064d
.B \fB\-s, \-\-state <state>\fP set SM state
Packit db064d
0 not active
Packit db064d
.sp
Packit db064d
1 discovering
Packit db064d
.sp
Packit db064d
2 standby
Packit db064d
.sp
Packit db064d
3 master
Packit db064d
.UNINDENT
Packit db064d
.sp
Packit db064d
\fB\-p, \-\-priority <priority>\fP set priority (0\-15)
Packit db064d
.sp
Packit db064d
\fB\-a, \-\-activity <val>\fP set activity count
Packit db064d
.SS Addressing Flags
Packit db064d
.\" Define the common option -D for Directed routes
Packit db064d
.
Packit db064d
.sp
Packit db064d
\fB\-D, \-\-Direct\fP     The address specified is a directed route
Packit db064d
.INDENT 0.0
Packit db064d
.INDENT 3.5
Packit db064d
.sp
Packit db064d
.nf
Packit db064d
.ft C
Packit db064d
Examples:
Packit db064d
   [options] \-D [options] "0"          # self port
Packit db064d
   [options] \-D [options] "0,1,2,1,4"  # out via port 1, then 2, ...
Packit db064d
Packit db064d
   (Note the second number in the path specified must match the port being
Packit db064d
   used.  This can be specified using the port selection flag \(aq\-P\(aq or the
Packit db064d
   port found through the automatic selection process.)
Packit db064d
.ft P
Packit db064d
.fi
Packit db064d
.UNINDENT
Packit db064d
.UNINDENT
Packit db064d
.\" Define the common option -G
Packit db064d
.
Packit db064d
.sp
Packit db064d
\fB\-G, \-\-Guid\fP     The address specified is a Port GUID
Packit db064d
.\" Define the common option -L
Packit db064d
.
Packit db064d
.sp
Packit db064d
\fB\-L, \-\-Lid\fP   The address specified is a LID
Packit db064d
.SS Port Selection flags
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
.\" 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
.SS Debugging flags
Packit db064d
.\" Define the common option -d
Packit db064d
.
Packit db064d
.INDENT 0.0
Packit db064d
.TP
Packit db064d
.B \-d
Packit db064d
raise the IB debugging level.
Packit db064d
May be used several times (\-ddd or \-d \-d \-d).
Packit db064d
.UNINDENT
Packit db064d
.\" Define the common option -e
Packit db064d
.
Packit db064d
.INDENT 0.0
Packit db064d
.TP
Packit db064d
.B \-e
Packit db064d
show send and receive errors (timeouts and others)
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 -v
Packit db064d
.
Packit db064d
.INDENT 0.0
Packit db064d
.TP
Packit db064d
.B \fB\-v, \-\-verbose\fP
Packit db064d
increase the application verbosity level.
Packit db064d
May be used several times (\-vv or \-v \-v \-v)
Packit db064d
.UNINDENT
Packit db064d
.\" Define the common option -V
Packit db064d
.
Packit db064d
.sp
Packit db064d
\fB\-V, \-\-version\fP     show the version info.
Packit db064d
.SS Configuration flags
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 -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
.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
.SH EXAMPLES
Packit db064d
.INDENT 0.0
Packit db064d
.TP
Packit db064d
.B ::
Packit db064d
sminfo                  # local port\(aqs sminfo
Packit db064d
sminfo 32               # show sminfo of lid 32
Packit db064d
sminfo  \-G 0x8f1040023  # same but using guid address
Packit db064d
.UNINDENT
Packit db064d
.SH SEE ALSO
Packit db064d
.sp
Packit db064d
smpdump (8)
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
.