1 .\" Man page generated from reStructuredText.
3 .TH IBCCCONFIG 8 "" "" "OpenIB Diagnostics"
5 IBCCCONFIG \- configure congestion control settings
7 .nr rst2man-indent-level 0
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
19 .\" .rstReportMargin pre:
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
35 ibccconfig [common_options] [\-c cckey] [\-\-dgid gid] <op> <lid|guid> [port]
39 supports the configuration of congestion control settings on switches
42 \fBWARNING \-\- You should understand what you are doing before using this tool.
43 Misuse of this tool could result in a broken fabric.\fP
47 .B Current supported operations and their parameters:
48 CongestionKeyInfo (CK) <lid|guid> <cckey> <cckeyprotectbit> <cckeyleaseperiod> <cckeyviolations>
49 SwitchCongestionSetting (SS) <lid|guid> <controlmap> <victimmask> <creditmask> <threshold> <packetsize> <csthreshold> <csreturndelay> <markingrate>
50 SwitchPortCongestionSetting (SP) <lid|guid> <portnum> <valid> <control_type> <threshold> <packet_size> <cong_parm_marking_rate>
51 CACongestionSetting (CS) <lid|guid> <port_control> <control_map> <ccti_timer> <ccti_increase> <trigger_threshold> <ccti_min>
52 CongestionControlTable (CT) <lid|guid> <cctilimit> <index> <cctentry> <cctentry> ...
55 \fB\-\-cckey, \-c, <cckey>\fP
56 Specify a congestion control (CC) key. If none is specified, a key of 0 is used.
59 destination GID: use when GRH is required in packets (IPv6 format)
61 .\" Define the common option -d
66 raise the IB debugging level.
67 May be used several times (\-ddd or \-d \-d \-d).
69 .\" Define the common option -e
74 show send and receive errors (timeouts and others)
76 .\" Define the common option -h
79 \fB\-h, \-\-help\fP show the usage message
80 .\" Define the common option -v
84 .B \fB\-v, \-\-verbose\fP
85 increase the application verbosity level.
86 May be used several times (\-vv or \-v \-v \-v)
88 .\" Define the common option -V
91 \fB\-V, \-\-version\fP show the version info.
93 .\" Define the common option -G
96 \fB\-G, \-\-Guid\fP The address specified is a Port GUID
97 .\" Define the common option -L
100 \fB\-L, \-\-Lid\fP The address specified is a LID
101 .\" Define the common option -s
104 \fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries.
105 .SS Port Selection flags
106 .\" Define the common option -C
109 \fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name.
110 .\" Define the common option -P
113 \fB\-P, \-\-Port <ca_port>\fP use the specified ca_port.
114 .\" Explanation of local port selection
116 .SS Local port Selection
118 Multiple port/Multiple CA support: when no IB device or port is specified
119 (see the "local umad parameters" below), the libibumad library
120 selects the port to use by the following criteria:
125 the first port that is ACTIVE.
127 if not found, the first port that is UP (physical link up).
130 If a port and/or CA name is specified, the libibumad library attempts
131 to fulfill the user request, and will fail if it is not possible.
139 ibaddr # use the first port (criteria #1 above)
140 ibaddr \-C mthca1 # pick the best port from "mthca1" only.
141 ibaddr \-P 2 # use the second (active/up) port from the first available IB device.
142 ibaddr \-C mthca0 \-P 2 # use the specified port only.
149 .SS Configuration flags
150 .\" Define the common option -y
154 .B \fB\-y, \-\-m_key <key>\fP
155 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
156 is specified then a value will be prompted for.
158 .\" Define the common option -z
161 \fB\-\-config, \-z <config_file>\fP Specify alternate config file.
164 Default: /etc/infiniband-diags/ibdiag.conf
173 ibccconfig SwitchCongestionSetting 2 0x1F 0x1FFFFFFFFF 0x0 0xF 8 0 0:0 1 # Configure Switch Congestion Settings
174 ibccconfig CACongestionSetting 1 0 0x3 150 1 0 0 # Configure CA Congestion Settings to SL 0 and SL 1
175 ibccconfig CACongestionSetting 1 0 0x4 200 1 0 0 # Configure CA Congestion Settings to SL 2
176 ibccconfig CongestionControlTable 1 63 0 0:0 0:1 ... # Configure first block of Congestion Control Table
177 ibccconfig CongestionControlTable 1 127 0 0:64 0:65 ... # Configure second block of Congestion Control Table
183 .\" Common text for the config file
187 /etc/infiniband-diags/ibdiag.conf
189 A global config file is provided to set some of the common options for all
190 tools. See supplied config file for details.
195 < \fI\%chu11@llnl.gov\fP >
197 .\" Generated by docutils manpage writer.