xref: /freebsd/contrib/ofed/infiniband-diags/man/ibccquery.8 (revision 2a63c3be158216222d89a073dcbd6a72ee4aab5a)
Man page generated from reStructuredText.
.
IBCCQUERY 8 "" "" "OpenIB Diagnostics"
NAME
IBCCQUERY - query congestion control settings/info . .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
ibccquery [common_options] [-c cckey] [--dgid gid] <op> <lid|guid> [port]
DESCRIPTION
ibccquery support the querying of settings and other information related to congestion control.
OPTIONS
NDENT 0.0

Current supported operations and their parameters: CongestionInfo (CI) <addr> CongestionKeyInfo (CK) <addr> CongestionLog (CL) <addr> SwitchCongestionSetting (SS) <addr> SwitchPortCongestionSetting (SP) <addr> [<portnum>] CACongestionSetting (CS) <addr> CongestionControlTable (CT) <addr> Timestamp (TI) <addr> NINDENT --cckey, -c <cckey> Specify a congestion control (CC) key. If none is specified, a key of 0 is used. --dgid <gid> destination GID: use when GRH is required in packets (IPv6 format)

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.

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
Configuration flags
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 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 NDENT 3.5
ibccquery CongestionInfo 3 # Congestion Info by lid
ibccquery SwitchPortCongestionSetting 3 # Query all Switch Port Congestion Settings
ibccquery SwitchPortCongestionSetting 3 1 # Query Switch Port Congestion Setting for port 1
NINDENT NINDENT
AUTHOR
NDENT 0.0

Albert Chu < \%chu11@llnl.gov > NINDENT Generated by docutils manpage writer.
.