Blame doc/rst/ibccconfig.8.in.rst

Packit db064d
==========
Packit db064d
IBCCCONFIG
Packit db064d
==========
Packit db064d
Packit db064d
-------------------------------------
Packit db064d
configure congestion control settings
Packit db064d
-------------------------------------
Packit db064d
Packit db064d
:Date: @BUILD_DATE@
Packit db064d
:Manual section: 8
Packit db064d
:Manual group: OpenIB Diagnostics
Packit db064d
Packit db064d
Packit db064d
SYNOPSIS
Packit db064d
========
Packit db064d
Packit db064d
ibccconfig [common_options] [-c cckey] <op> <lid|guid> [port]
Packit db064d
Packit db064d
DESCRIPTION
Packit db064d
===========
Packit db064d
Packit db064d
**ibccconfig**
Packit db064d
supports the configuration of congestion control settings on switches
Packit db064d
and HCAs.
Packit db064d
Packit db064d
**WARNING -- You should understand what you are doing before using this tool.
Packit db064d
Misuse of this tool could result in a broken fabric.**
Packit db064d
Packit db064d
OPTIONS
Packit db064d
=======
Packit db064d
Packit db064d
Current supported operations and their parameters:
Packit db064d
  CongestionKeyInfo (CK) <lid|guid> <cckey> <cckeyprotectbit> <cckeyleaseperiod> <cckeyviolations>
Packit db064d
  SwitchCongestionSetting (SS) <lid|guid> <controlmap> <victimmask> <creditmask> <threshold> <packetsize> <csthreshold> <csreturndelay> <markingrate>
Packit db064d
  SwitchPortCongestionSetting (SP) <lid|guid> <portnum> <valid> <control_type> <threshold> <packet_size> <cong_parm_marking_rate> 
Packit db064d
  CACongestionSetting (CS) <lid|guid> <port_control> <control_map> <ccti_timer> <ccti_increase> <trigger_threshold> <ccti_min>
Packit db064d
  CongestionControlTable (CT) <lid|guid> <cctilimit> <index> <cctentry> <cctentry> ...
Packit db064d
Packit db064d
**--cckey, -c, <cckey>**
Packit db064d
Specify a congestion control (CC) key.  If none is specified, a key of 0 is used.
Packit db064d
Packit db064d
Packit db064d
Debugging flags
Packit db064d
---------------
Packit db064d
Packit db064d
.. include:: common/opt_d.rst
Packit db064d
.. include:: common/opt_e.rst
Packit db064d
.. include:: common/opt_h.rst
Packit db064d
.. include:: common/opt_v.rst
Packit db064d
.. include:: common/opt_V.rst
Packit db064d
Packit db064d
Addressing Flags
Packit db064d
----------------
Packit db064d
Packit db064d
.. include:: common/opt_G.rst
Packit db064d
.. include:: common/opt_L.rst
Packit db064d
.. include:: common/opt_s.rst
Packit db064d
Packit db064d
Packit db064d
Port Selection flags
Packit db064d
--------------------
Packit db064d
Packit db064d
.. include:: common/opt_C.rst
Packit db064d
.. include:: common/opt_P.rst
Packit db064d
.. include:: common/sec_portselection.rst
Packit db064d
Packit db064d
Configuration flags
Packit db064d
-------------------
Packit db064d
Packit db064d
.. include:: common/opt_y.rst
Packit db064d
.. include:: common/opt_z-config.rst
Packit db064d
Packit db064d
Packit db064d
EXAMPLES
Packit db064d
========
Packit db064d
Packit db064d
::
Packit db064d
Packit db064d
        ibccconfig SwitchCongestionSetting 2 0x1F 0x1FFFFFFFFF 0x0 0xF 8 0 0:0 1  # Configure Switch Congestion Settings
Packit db064d
        ibccconfig CACongestionSetting 1 0 0x3 150 1 0 0                          # Configure CA Congestion Settings to SL 0 and SL 1
Packit db064d
        ibccconfig CACongestionSetting 1 0 0x4 200 1 0 0                          # Configure CA Congestion Settings to SL 2
Packit db064d
        ibccconfig CongestionControlTable 1 63 0 0:0 0:1 ...                      # Configure first block of Congestion Control Table
Packit db064d
        ibccconfig CongestionControlTable 1 127 0 0:64 0:65 ...                   # Configure second block of Congestion Control Table
Packit db064d
Packit db064d
FILES
Packit db064d
=====
Packit db064d
Packit db064d
.. include:: common/sec_config-file.rst
Packit db064d
Packit db064d
AUTHOR
Packit db064d
======
Packit db064d
Packit db064d
Albert Chu
Packit db064d
        < chu11@llnl.gov >