.\" Man page generated from reStructuredText.

.

.TH IBCCCONFIG 8 "@BUILD_DATE@" "" "OpenIB Diagnostics"

.SH NAME

IBCCCONFIG \- configure congestion control settings

.

.nr rst2man-indent-level 0

.

.de1 rstReportMargin

\\$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]

..

.de1 INDENT

.\" .rstReportMargin pre:

. RS \\$1

. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]

. nr rst2man-indent-level +1

.\" .rstReportMargin post:

..

.de UNINDENT

. 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]]

.in \\n[rst2man-indent\\n[rst2man-indent-level]]u

..

.SH SYNOPSIS

.sp

ibccconfig [common_options] [\-c cckey] <op> <lid|guid> [port]

.SH DESCRIPTION

.sp

\fBibccconfig\fP

supports the configuration of congestion control settings on switches

and HCAs.

.sp

\fBWARNING \-\- You should understand what you are doing before using this tool.

Misuse of this tool could result in a broken fabric.\fP

.SH OPTIONS

.INDENT 0.0

.TP

.B 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> ...

.UNINDENT

.sp

\fB\-\-cckey, \-c, <cckey>\fP

Specify a congestion control (CC) key.  If none is specified, a key of 0 is used.

.SS Debugging flags

.\" Define the common option -d

.

.INDENT 0.0

.TP

.B \-d

raise the IB debugging level.

May be used several times (\-ddd or \-d \-d \-d).

.UNINDENT

.\" Define the common option -e

.

.INDENT 0.0

.TP

.B \-e

show send and receive errors (timeouts and others)

.UNINDENT

.\" Define the common option -h

.

.sp

\fB\-h, \-\-help\fP      show the usage message

.\" Define the common option -v

.

.INDENT 0.0

.TP

.B \fB\-v, \-\-verbose\fP

increase the application verbosity level.

May be used several times (\-vv or \-v \-v \-v)

.UNINDENT

.\" Define the common option -V

.

.sp

\fB\-V, \-\-version\fP     show the version info.

.SS Addressing Flags

.\" Define the common option -G

.

.sp

\fB\-G, \-\-Guid\fP     The address specified is a Port GUID

.\" Define the common option -L

.

.sp

\fB\-L, \-\-Lid\fP   The address specified is a LID

.\" Define the common option -s

.

.sp

\fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.

.SS Port Selection flags

.\" Define the common option -C

.

.sp

\fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.

.\" Define the common option -P

.

.sp

\fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.

.\" Explanation of local port selection

.

.SS Local port Selection

.sp

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:

.INDENT 0.0

.INDENT 3.5

.INDENT 0.0

.IP 1. 3

the first port that is ACTIVE.

.IP 2. 3

if not found, the first port that is UP (physical link up).

.UNINDENT

.sp

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.

.sp

For example:

.INDENT 0.0

.INDENT 3.5

.sp

.nf

.ft C

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.

.ft P

.fi

.UNINDENT

.UNINDENT

.UNINDENT

.UNINDENT

.SS Configuration flags

.\" Define the common option -y

.

.INDENT 0.0

.TP

.B \fB\-y, \-\-m_key <key>\fP

use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)

is specified then a value will be prompted for.

.UNINDENT

.\" Define the common option -z

.

.sp

\fB\-\-config, \-z  <config_file>\fP Specify alternate config file.

.INDENT 0.0

.INDENT 3.5

Default: @IBDIAG_CONFIG_PATH@/ibdiag.conf

.UNINDENT

.UNINDENT

.SH EXAMPLES

.INDENT 0.0

.INDENT 3.5

.sp

.nf

.ft C

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

.ft P

.fi

.UNINDENT

.UNINDENT

.SH FILES

.\" Common text for the config file

.

.SS CONFIG FILE

.sp

@IBDIAG_CONFIG_PATH@/ibdiag.conf

.sp

A global config file is provided to set some of the common options for all

tools.  See supplied config file for details.

.SH AUTHOR

.INDENT 0.0

.TP

.B Albert Chu

< \fI\%chu11@llnl.gov\fP >

.UNINDENT

.\" Generated by docutils manpage writer.

.