contrib/ofed/infiniband-diags/man/ibccquery.8

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH IBCCQUERY 8 "" "" "OpenIB Diagnostics"
   4 .SH NAME
   5 IBCCQUERY \- query congestion control settings/info
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  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
  32 ..
  33 .SH SYNOPSIS
  34 .sp
  35 ibccquery [common_options] [\-c cckey] [\-\-dgid gid] <op> <lid|guid> [port]
  36 .SH DESCRIPTION
  37 .sp
  38 ibccquery support the querying of settings and other information related
  39 to congestion control.
  40 .SH OPTIONS
  41 .INDENT 0.0
  42 .TP
  43 .B Current supported operations and their parameters:
  44 CongestionInfo (CI) <addr>
  45 CongestionKeyInfo (CK) <addr>
  46 CongestionLog (CL) <addr>
  47 SwitchCongestionSetting (SS) <addr>
  48 SwitchPortCongestionSetting (SP) <addr> [<portnum>]
  49 CACongestionSetting (CS) <addr>
  50 CongestionControlTable (CT) <addr>
  51 Timestamp (TI) <addr>
  52 .UNINDENT
  53 .sp
  54 \fB\-\-cckey, \-c <cckey>\fP
  55 Specify a congestion control (CC) key.  If none is specified, a key of 0 is used.
  56 \fB\-\-dgid <gid>\fP
  57 destination GID: use when GRH is required in packets (IPv6 format)
  58 .SS Debugging flags
  59 .\" Define the common option -d
  60 .
  61 .INDENT 0.0
  62 .TP
  63 .B \-d
  64 raise the IB debugging level.
  65 May be used several times (\-ddd or \-d \-d \-d).
  66 .UNINDENT
  67 .\" Define the common option -e
  68 .
  69 .INDENT 0.0
  70 .TP
  71 .B \-e
  72 show send and receive errors (timeouts and others)
  73 .UNINDENT
  74 .\" Define the common option -h
  75 .
  76 .sp
  77 \fB\-h, \-\-help\fP      show the usage message
  78 .\" Define the common option -v
  79 .
  80 .INDENT 0.0
  81 .TP
  82 .B \fB\-v, \-\-verbose\fP
  83 increase the application verbosity level.
  84 May be used several times (\-vv or \-v \-v \-v)
  85 .UNINDENT
  86 .\" Define the common option -V
  87 .
  88 .sp
  89 \fB\-V, \-\-version\fP     show the version info.
  90 .SS Addressing Flags
  91 .\" Define the common option -G
  92 .
  93 .sp
  94 \fB\-G, \-\-Guid\fP     The address specified is a Port GUID
  95 .\" Define the common option -L
  96 .
  97 .sp
  98 \fB\-L, \-\-Lid\fP   The address specified is a LID
  99 .\" Define the common option -s
 100 .
 101 .sp
 102 \fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.
 103 .SS Port Selection flags
 104 .\" Define the common option -C
 105 .
 106 .sp
 107 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
 108 .\" Define the common option -P
 109 .
 110 .sp
 111 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
 112 .\" Explanation of local port selection
 113 .
 114 .SS Local port Selection
 115 .sp
 116 Multiple port/Multiple CA support: when no IB device or port is specified
 117 (see the "local umad parameters" below), the libibumad library
 118 selects the port to use by the following criteria:
 119 .INDENT 0.0
 120 .INDENT 3.5
 121 .INDENT 0.0
 122 .IP 1. 3
 123 the first port that is ACTIVE.
 124 .IP 2. 3
 125 if not found, the first port that is UP (physical link up).
 126 .UNINDENT
 127 .sp
 128 If a port and/or CA name is specified, the libibumad library attempts
 129 to fulfill the user request, and will fail if it is not possible.
 130 .sp
 131 For example:
 132 .INDENT 0.0
 133 .INDENT 3.5
 134 .sp
 135 .nf
 136 .ft C
 137 ibaddr                 # use the first port (criteria #1 above)
 138 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 139 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 140 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 141 .ft P
 142 .fi
 143 .UNINDENT
 144 .UNINDENT
 145 .UNINDENT
 146 .UNINDENT
 147 .SS Configuration flags
 148 .\" Define the common option -y
 149 .
 150 .INDENT 0.0
 151 .TP
 152 .B \fB\-y, \-\-m_key <key>\fP
 153 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
 154 is specified then a value will be prompted for.
 155 .UNINDENT
 156 .\" Define the common option -z
 157 .
 158 .sp
 159 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 160 .INDENT 0.0
 161 .INDENT 3.5
 162 Default: /etc/infiniband-diags/ibdiag.conf
 163 .UNINDENT
 164 .UNINDENT
 165 .SH FILES
 166 .\" Common text for the config file
 167 .
 168 .SS CONFIG FILE
 169 .sp
 170 /etc/infiniband-diags/ibdiag.conf
 171 .sp
 172 A global config file is provided to set some of the common options for all
 173 tools.  See supplied config file for details.
 174 .SH EXAMPLES
 175 .INDENT 0.0
 176 .INDENT 3.5
 177 .sp
 178 .nf
 179 .ft C
 180 ibccquery CongestionInfo 3              # Congestion Info by lid
 181 ibccquery SwitchPortCongestionSetting 3 # Query all Switch Port Congestion Settings
 182 ibccquery SwitchPortCongestionSetting 3 1 # Query Switch Port Congestion Setting for port 1
 183 .ft P
 184 .fi
 185 .UNINDENT
 186 .UNINDENT
 187 .SH AUTHOR
 188 .INDENT 0.0
 189 .TP
 190 .B Albert Chu
 191 < \fI\%chu11@llnl.gov\fP >
 192 .UNINDENT
 193 .\" Generated by docutils manpage writer.
 194 .