Blame doc/man/ibping.8

Packit db064d
.\" Man page generated from reStructuredText.
Packit db064d
.
Packit db064d
.TH IBPING 8 "" "" "Open IB Diagnostics"
Packit db064d
.SH NAME
Packit db064d
IBPING \- ping an InfiniBand address
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
ibping [options] <dest lid | guid>
Packit db064d
.SH DESCRIPTION
Packit db064d
.sp
Packit db064d
ibping uses vendor mads to validate connectivity between IB nodes.
Packit db064d
On exit, (IP) ping like output is show. ibping is run as client/server.
Packit db064d
Default is to run as client. Note also that a default ping server is
Packit db064d
implemented within the kernel.
Packit db064d
.SH OPTIONS
Packit db064d
.sp
Packit db064d
\fB\-c, \-\-count\fP
Packit db064d
stop after count packets
Packit db064d
.sp
Packit db064d
\fB\-f, \-\-flood\fP
Packit db064d
flood destination: send packets back to back without delay
Packit db064d
.sp
Packit db064d
\fB\-o, \-\-oui\fP
Packit db064d
use specified OUI number to multiplex vendor mads
Packit db064d
.sp
Packit db064d
\fB\-S, \-\-Server\fP
Packit db064d
start in server mode (do not return)
Packit db064d
.SS Addressing Flags
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
.\" 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 -s
Packit db064d
.
Packit db064d
.sp
Packit db064d
\fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.
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 Configuration flags
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: /usr/local/etc/infiniband-diags/ibdiag.conf
Packit db064d
.UNINDENT
Packit db064d
.UNINDENT
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
.SS Debugging flags
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 -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 -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
.SH FILES
Packit db064d
.\" Common text for the config file
Packit db064d
.
Packit db064d
.SS CONFIG FILE
Packit db064d
.sp
Packit db064d
/usr/local/etc/infiniband-diags/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 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
.