xref: /freebsd/contrib/ofed/infiniband-diags/man/vendstat.8 (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
Man page generated from reStructuredText.
.
VENDSTAT 8 "" "" "Open IB Diagnostics"
NAME
VENDSTAT - . .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]]
..
QUERY INFINIBAND VENDOR SPECIFIC FUNCTIONS
SYNOPSIS
vendstat [options] <lid|guid>
DESCRIPTION
vendstat uses vendor specific MADs to access beyond the IB spec vendor specific functionality. Currently, there is support for Mellanox InfiniSwitch-III (IS3) and InfiniSwitch-IV (IS4).
OPTIONS
NDENT 0.0

-N show IS3 or IS4 general information.

-w show IS3 port xmit wait counters.

-i show IS4 counter group info.

-c <num,num> configure IS4 counter groups. Configure IS4 counter groups 0 and 1. Such configuration is not persistent across IS4 reboot. First number is for counter group 0 and second is for counter group 1. Group 0 counter config values: NINDENT NDENT 0.0

:: NDENT 7.0 NDENT 3.5 0 - PortXmitDataSL0-7 1 - PortXmitDataSL8-15 2 - PortRcvDataSL0-7 NINDENT NINDENT Group 1 counter config values: NINDENT NDENT 0.0

:: 1 - PortXmitDataSL8-15 2 - PortRcvDataSL0-7 8 - PortRcvDataSL8-15

-R, --Read <addr,mask> Read configuration space record at addr

-W, --Write <addr,val,mask> Write configuration space record at addr

--dgid <gid> destination GID: use when GRH is required in packets (IPv6 format) NINDENT

Addressing Flags
Define the common option -G
. -G, --Guid The address specified is a Port GUID Define the common option -L
. -L, --Lid The address specified is a LID Define the common option -s
. -s, --sm_port <smlid> use \(aqsmlid\(aq as the target lid for SA queries.
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
Debugging flags
Define the common option -d
. NDENT 0.0

-d raise the IB debugging level. May be used several times (-ddd or -d -d -d). NINDENT 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.

Configuration flags
Define the common option -t
. -t, --timeout <timeout_ms> override the default timeout for the solicited mads. 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
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.
EXAMPLES
NDENT 0.0

:: vendstat -N 6 # read IS3 or IS4 general information vendstat -w 6 # read IS3 port xmit wait counters vendstat -i 6 12 # read IS4 port 12 counter group info vendstat -c 0,1 6 12 # configure IS4 port 12 counter groups for PortXmitDataSL vendstat -c 2,8 6 12 # configure IS4 port 12 counter groups for PortRcvDataSL NINDENT

AUTHOR
NDENT 0.0

Hal Rosenstock < \%hal.rosenstock@gmail.com > NINDENT Generated by docutils manpage writer.
.