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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH IBROUTE 8 "" "" "Open IB Diagnostics"
   4 .SH NAME
   5 IBROUTE \-
   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 QUERY INFINIBAND SWITCH FORWARDING TABLES
  34 .SS SYNOPSIS
  35 .sp
  36 ibroute [options] [<dest dr_path|lid|guid> [<startlid> [<endlid>]]]
  37 .SS DESCRIPTION
  38 .sp
  39 ibroute uses SMPs to display the forwarding tables (unicast
  40 (LinearForwardingTable or LFT) or multicast (MulticastForwardingTable or MFT))
  41 for the specified switch LID and the optional lid (mlid) range.
  42 The default range is all valid entries in the range 1...FDBTop.
  43 .SS OPTIONS
  44 .INDENT 0.0
  45 .TP
  46 .B \fB\-a, \-\-all\fP
  47 show all lids in range, even invalid entries
  48 .TP
  49 .B \fB\-n, \-\-no_dests\fP
  50 do not try to resolve destinations
  51 .TP
  52 .B \fB\-M, \-\-Multicast\fP
  53 show multicast forwarding tables
  54 In this case, the range parameters are specifying the mlid range.
  55 .UNINDENT
  56 .SS Addressing Flags
  57 .\" Define the common option -D for Directed routes
  58 .
  59 .sp
  60 \fB\-D, \-\-Direct\fP     The address specified is a directed route
  61 .INDENT 0.0
  62 .INDENT 3.5
  63 .sp
  64 .nf
  65 .ft C
  66 Examples:
  67    [options] \-D [options] "0"          # self port
  68    [options] \-D [options] "0,1,2,1,4"  # out via port 1, then 2, ...
  69
  70    (Note the second number in the path specified must match the port being
  71    used.  This can be specified using the port selection flag \(aq\-P\(aq or the
  72    port found through the automatic selection process.)
  73 .ft P
  74 .fi
  75 .UNINDENT
  76 .UNINDENT
  77 .\" Define the common option -G
  78 .
  79 .sp
  80 \fB\-G, \-\-Guid\fP     The address specified is a Port GUID
  81 .\" Define the common option -L
  82 .
  83 .sp
  84 \fB\-L, \-\-Lid\fP   The address specified is a LID
  85 .\" Define the common option -s
  86 .
  87 .sp
  88 \fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.
  89 .SS Port Selection flags
  90 .\" Define the common option -C
  91 .
  92 .sp
  93 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
  94 .\" Define the common option -P
  95 .
  96 .sp
  97 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
  98 .\" Explanation of local port selection
  99 .
 100 .SS Local port Selection
 101 .sp
 102 Multiple port/Multiple CA support: when no IB device or port is specified
 103 (see the "local umad parameters" below), the libibumad library
 104 selects the port to use by the following criteria:
 105 .INDENT 0.0
 106 .INDENT 3.5
 107 .INDENT 0.0
 108 .IP 1. 3
 109 the first port that is ACTIVE.
 110 .IP 2. 3
 111 if not found, the first port that is UP (physical link up).
 112 .UNINDENT
 113 .sp
 114 If a port and/or CA name is specified, the libibumad library attempts
 115 to fulfill the user request, and will fail if it is not possible.
 116 .sp
 117 For example:
 118 .INDENT 0.0
 119 .INDENT 3.5
 120 .sp
 121 .nf
 122 .ft C
 123 ibaddr                 # use the first port (criteria #1 above)
 124 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 125 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 126 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 127 .ft P
 128 .fi
 129 .UNINDENT
 130 .UNINDENT
 131 .UNINDENT
 132 .UNINDENT
 133 .SS Debugging flags
 134 .\" Define the common option -d
 135 .
 136 .INDENT 0.0
 137 .TP
 138 .B \-d
 139 raise the IB debugging level.
 140 May be used several times (\-ddd or \-d \-d \-d).
 141 .UNINDENT
 142 .\" Define the common option -e
 143 .
 144 .INDENT 0.0
 145 .TP
 146 .B \-e
 147 show send and receive errors (timeouts and others)
 148 .UNINDENT
 149 .\" Define the common option -h
 150 .
 151 .sp
 152 \fB\-h, \-\-help\fP      show the usage message
 153 .\" Define the common option -v
 154 .
 155 .INDENT 0.0
 156 .TP
 157 .B \fB\-v, \-\-verbose\fP
 158 increase the application verbosity level.
 159 May be used several times (\-vv or \-v \-v \-v)
 160 .UNINDENT
 161 .\" Define the common option -V
 162 .
 163 .sp
 164 \fB\-V, \-\-version\fP     show the version info.
 165 .SS Configuration flags
 166 .\" Define the common option -t
 167 .
 168 .sp
 169 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
 170 .\" Define the common option -y
 171 .
 172 .INDENT 0.0
 173 .TP
 174 .B \fB\-y, \-\-m_key <key>\fP
 175 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
 176 is specified then a value will be prompted for.
 177 .UNINDENT
 178 .\" Define the common option --node-name-map
 179 .
 180 .sp
 181 \fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map.
 182 .INDENT 0.0
 183 .INDENT 3.5
 184 This file maps GUIDs to more user friendly names.  See FILES section.
 185 .UNINDENT
 186 .UNINDENT
 187 .\" Define the common option -z
 188 .
 189 .sp
 190 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 191 .INDENT 0.0
 192 .INDENT 3.5
 193 Default: /etc/infiniband-diags/ibdiag.conf
 194 .UNINDENT
 195 .UNINDENT
 196 .SS FILES
 197 .\" Common text for the config file
 198 .
 199 .SS CONFIG FILE
 200 .sp
 201 /etc/infiniband-diags/ibdiag.conf
 202 .sp
 203 A global config file is provided to set some of the common options for all
 204 tools.  See supplied config file for details.
 205 .\" Common text to describe the node name map file.
 206 .
 207 .SS NODE NAME MAP FILE FORMAT
 208 .sp
 209 The node name map is used to specify user friendly names for nodes in the
 210 output.  GUIDs are used to perform the lookup.
 211 .sp
 212 This functionality is provided by the opensm\-libs package.  See \fBopensm(8)\fP
 213 for the file location for your installation.
 214 .sp
 215 \fBGenerically:\fP
 216 .INDENT 0.0
 217 .INDENT 3.5
 218 .sp
 219 .nf
 220 .ft C
 221 # comment
 222 <guid> "<name>"
 223 .ft P
 224 .fi
 225 .UNINDENT
 226 .UNINDENT
 227 .sp
 228 \fBExample:\fP
 229 .INDENT 0.0
 230 .INDENT 3.5
 231 .sp
 232 .nf
 233 .ft C
 234 # IB1
 235 # Line cards
 236 0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 237 0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 238 0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 239 0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 240 0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB\-24D"
 241
 242 # Spines
 243 0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 244 0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 245 0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 246 0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 247 0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 248
 249 # GUID   Node Name
 250 0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
 251 0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
 252 0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
 253 0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
 254 .ft P
 255 .fi
 256 .UNINDENT
 257 .UNINDENT
 258 .SS EXAMPLES
 259 .sp
 260 Unicast examples
 261 .INDENT 0.0
 262 .TP
 263 .B ::
 264 ibroute 4               # dump all lids with valid out ports of switch with lid 4
 265 ibroute \-a 4            # same, but dump all lids, even with invalid out ports
 266 ibroute \-n 4            # simple dump format \- no destination resolution
 267 ibroute 4 10            # dump lids starting from 10 (up to FDBTop)
 268 ibroute 4 0x10 0x20     # dump lid range
 269 ibroute \-G 0x08f1040023 # resolve switch by GUID
 270 ibroute \-D 0,1          # resolve switch by direct path
 271 .UNINDENT
 272 .sp
 273 Multicast examples
 274 .INDENT 0.0
 275 .TP
 276 .B ::
 277 ibroute \-M 4                # dump all non empty mlids of switch with lid 4
 278 ibroute \-M 4 0xc010 0xc020  # same, but with range
 279 ibroute \-M \-n 4             # simple dump format
 280 .UNINDENT
 281 .SS SEE ALSO
 282 .sp
 283 ibtracert (8)
 284 .SS AUTHOR
 285 .INDENT 0.0
 286 .TP
 287 .B Hal Rosenstock
 288 < \fI\%halr@voltaire.com\fP >
 289 .UNINDENT
 290 .\" Generated by docutils manpage writer.
 291 .