xref: /freebsd/contrib/ofed/infiniband-diags/man/ibccconfig.8 (revision a03411e84728e9b267056fd31c7d1d9d1dc1b01e)
Man page generated from reStructuredText.
.
IBCCCONFIG 8 "" "" "OpenIB Diagnostics"
NAME
IBCCCONFIG - configure congestion control settings . .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
ibccconfig [common_options] [-c cckey] [--dgid gid] <op> <lid|guid> [port]
DESCRIPTION
ibccconfig supports the configuration of congestion control settings on switches and HCAs. WARNING -- You should understand what you are doing before using this tool. Misuse of this tool could result in a broken fabric.
OPTIONS
NDENT 0.0

Current supported operations and their parameters: CongestionKeyInfo (CK) <lid|guid> <cckey> <cckeyprotectbit> <cckeyleaseperiod> <cckeyviolations> SwitchCongestionSetting (SS) <lid|guid> <controlmap> <victimmask> <creditmask> <threshold> <packetsize> <csthreshold> <csreturndelay> <markingrate> SwitchPortCongestionSetting (SP) <lid|guid> <portnum> <valid> <control_type> <threshold> <packet_size> <cong_parm_marking_rate> CACongestionSetting (CS) <lid|guid> <port_control> <control_map> <ccti_timer> <ccti_increase> <trigger_threshold> <ccti_min> CongestionControlTable (CT) <lid|guid> <cctilimit> <index> <cctentry> <cctentry> ... NINDENT --cckey, -c, <cckey> Specify a congestion control (CC) key. If none is specified, a key of 0 is used. --dgid <dgid> 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

EXAMPLES
NDENT 0.0 NDENT 3.5
ibccconfig SwitchCongestionSetting 2 0x1F 0x1FFFFFFFFF 0x0 0xF 8 0 0:0 1 # Configure Switch Congestion Settings
ibccconfig CACongestionSetting 1 0 0x3 150 1 0 0 # Configure CA Congestion Settings to SL 0 and SL 1
ibccconfig CACongestionSetting 1 0 0x4 200 1 0 0 # Configure CA Congestion Settings to SL 2
ibccconfig CongestionControlTable 1 63 0 0:0 0:1 ... # Configure first block of Congestion Control Table
ibccconfig CongestionControlTable 1 127 0 0:64 0:65 ... # Configure second block of Congestion Control Table
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.
AUTHOR
NDENT 0.0

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