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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH DUMP_FTS 8 "" "" "OpenIB Diagnostics"
   4 .SH NAME
   5 DUMP_FTS \- dump InfiniBand forwarding tables
   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 dump_fts [options] [<startlid> [<endlid>]]
  36 .SH DESCRIPTION
  37 .sp
  38 dump_fts is similar to ibroute but dumps tables for every switch found in an
  39 ibnetdiscover scan of the subnet.
  40 .sp
  41 The dump file format is compatible with loading into OpenSM using
  42 the \-R file \-U /path/to/dump\-file syntax.
  43 .SH 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 Port Selection flags
  57 .\" Define the common option -C
  58 .
  59 .sp
  60 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
  61 .\" Define the common option -P
  62 .
  63 .sp
  64 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
  65 .\" Explanation of local port selection
  66 .
  67 .SS Local port Selection
  68 .sp
  69 Multiple port/Multiple CA support: when no IB device or port is specified
  70 (see the "local umad parameters" below), the libibumad library
  71 selects the port to use by the following criteria:
  72 .INDENT 0.0
  73 .INDENT 3.5
  74 .INDENT 0.0
  75 .IP 1. 3
  76 the first port that is ACTIVE.
  77 .IP 2. 3
  78 if not found, the first port that is UP (physical link up).
  79 .UNINDENT
  80 .sp
  81 If a port and/or CA name is specified, the libibumad library attempts
  82 to fulfill the user request, and will fail if it is not possible.
  83 .sp
  84 For example:
  85 .INDENT 0.0
  86 .INDENT 3.5
  87 .sp
  88 .nf
  89 .ft C
  90 ibaddr                 # use the first port (criteria #1 above)
  91 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
  92 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
  93 ibaddr \-C mthca0 \-P 2  # use the specified port only.
  94 .ft P
  95 .fi
  96 .UNINDENT
  97 .UNINDENT
  98 .UNINDENT
  99 .UNINDENT
 100 .SS Debugging flags
 101 .\" Define the common option -d
 102 .
 103 .INDENT 0.0
 104 .TP
 105 .B \-d
 106 raise the IB debugging level.
 107 May be used several times (\-ddd or \-d \-d \-d).
 108 .UNINDENT
 109 .\" Define the common option -e
 110 .
 111 .INDENT 0.0
 112 .TP
 113 .B \-e
 114 show send and receive errors (timeouts and others)
 115 .UNINDENT
 116 .\" Define the common option -h
 117 .
 118 .sp
 119 \fB\-h, \-\-help\fP      show the usage message
 120 .\" Define the common option -v
 121 .
 122 .INDENT 0.0
 123 .TP
 124 .B \fB\-v, \-\-verbose\fP
 125 increase the application verbosity level.
 126 May be used several times (\-vv or \-v \-v \-v)
 127 .UNINDENT
 128 .\" Define the common option -V
 129 .
 130 .sp
 131 \fB\-V, \-\-version\fP     show the version info.
 132 .SS Configuration flags
 133 .\" Define the common option -t
 134 .
 135 .sp
 136 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
 137 .\" Define the common option -y
 138 .
 139 .INDENT 0.0
 140 .TP
 141 .B \fB\-y, \-\-m_key <key>\fP
 142 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
 143 is specified then a value will be prompted for.
 144 .UNINDENT
 145 .\" Define the common option --node-name-map
 146 .
 147 .sp
 148 \fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map.
 149 .INDENT 0.0
 150 .INDENT 3.5
 151 This file maps GUIDs to more user friendly names.  See FILES section.
 152 .UNINDENT
 153 .UNINDENT
 154 .\" Define the common option -z
 155 .
 156 .sp
 157 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 158 .INDENT 0.0
 159 .INDENT 3.5
 160 Default: /etc/infiniband-diags/ibdiag.conf
 161 .UNINDENT
 162 .UNINDENT
 163 .SH FILES
 164 .\" Common text for the config file
 165 .
 166 .SS CONFIG FILE
 167 .sp
 168 /etc/infiniband-diags/ibdiag.conf
 169 .sp
 170 A global config file is provided to set some of the common options for all
 171 tools.  See supplied config file for details.
 172 .\" Common text to describe the node name map file.
 173 .
 174 .SS NODE NAME MAP FILE FORMAT
 175 .sp
 176 The node name map is used to specify user friendly names for nodes in the
 177 output.  GUIDs are used to perform the lookup.
 178 .sp
 179 This functionality is provided by the opensm\-libs package.  See \fBopensm(8)\fP
 180 for the file location for your installation.
 181 .sp
 182 \fBGenerically:\fP
 183 .INDENT 0.0
 184 .INDENT 3.5
 185 .sp
 186 .nf
 187 .ft C
 188 # comment
 189 <guid> "<name>"
 190 .ft P
 191 .fi
 192 .UNINDENT
 193 .UNINDENT
 194 .sp
 195 \fBExample:\fP
 196 .INDENT 0.0
 197 .INDENT 3.5
 198 .sp
 199 .nf
 200 .ft C
 201 # IB1
 202 # Line cards
 203 0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 204 0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 205 0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 206 0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 207 0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB\-24D"
 208
 209 # Spines
 210 0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 211 0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 212 0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 213 0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 214 0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 215
 216 # GUID   Node Name
 217 0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
 218 0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
 219 0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
 220 0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
 221 .ft P
 222 .fi
 223 .UNINDENT
 224 .UNINDENT
 225 .SH SEE ALSO
 226 .sp
 227 \fBdump_lfts(8), dump_mfts(8), ibroute(8), ibswitches(8), opensm(8)\fP
 228 .SH AUTHORS
 229 .INDENT 0.0
 230 .TP
 231 .B Ira Weiny
 232 < \fI\%ira.weiny@intel.com\fP >
 233 .UNINDENT
 234 .\" Generated by docutils manpage writer.
 235 .