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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH IBSWITCHES 8 "" "" "OpenIB Diagnostics"
   4 .SH NAME
   5 IBSWITCHES \- show InfiniBand switch nodes in topology
   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 ibswitches [options] [<topology\-file>]
  36 .SH DESCRIPTION
  37 .sp
  38 ibswitches is a script which either walks the IB subnet topology or uses an
  39 already saved topology file and extracts the switch nodes.
  40 .SH OPTIONS
  41 .\" Define the common option -C
  42 .
  43 .sp
  44 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
  45 .\" Define the common option -P
  46 .
  47 .sp
  48 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
  49 .\" Define the common option -t
  50 .
  51 .sp
  52 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
  53 .\" Define the common option -y
  54 .
  55 .INDENT 0.0
  56 .TP
  57 .B \fB\-y, \-\-m_key <key>\fP
  58 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
  59 is specified then a value will be prompted for.
  60 .UNINDENT
  61 .\" Define the common option -h
  62 .
  63 .sp
  64 \fB\-h, \-\-help\fP      show the usage message
  65 .\" Define the common option -z
  66 .
  67 .sp
  68 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
  69 .INDENT 0.0
  70 .INDENT 3.5
  71 Default: /etc/infiniband-diags/ibdiag.conf
  72 .UNINDENT
  73 .UNINDENT
  74 .\" Explanation of local port selection
  75 .
  76 .SS Local port Selection
  77 .sp
  78 Multiple port/Multiple CA support: when no IB device or port is specified
  79 (see the "local umad parameters" below), the libibumad library
  80 selects the port to use by the following criteria:
  81 .INDENT 0.0
  82 .INDENT 3.5
  83 .INDENT 0.0
  84 .IP 1. 3
  85 the first port that is ACTIVE.
  86 .IP 2. 3
  87 if not found, the first port that is UP (physical link up).
  88 .UNINDENT
  89 .sp
  90 If a port and/or CA name is specified, the libibumad library attempts
  91 to fulfill the user request, and will fail if it is not possible.
  92 .sp
  93 For example:
  94 .INDENT 0.0
  95 .INDENT 3.5
  96 .sp
  97 .nf
  98 .ft C
  99 ibaddr                 # use the first port (criteria #1 above)
 100 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 101 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 102 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 103 .ft P
 104 .fi
 105 .UNINDENT
 106 .UNINDENT
 107 .UNINDENT
 108 .UNINDENT
 109 .SH FILES
 110 .\" Common text for the config file
 111 .
 112 .SS CONFIG FILE
 113 .sp
 114 /etc/infiniband-diags/ibdiag.conf
 115 .sp
 116 A global config file is provided to set some of the common options for all
 117 tools.  See supplied config file for details.
 118 .\" Common text to describe the node name map file.
 119 .
 120 .SS NODE NAME MAP FILE FORMAT
 121 .sp
 122 The node name map is used to specify user friendly names for nodes in the
 123 output.  GUIDs are used to perform the lookup.
 124 .sp
 125 This functionality is provided by the opensm\-libs package.  See \fBopensm(8)\fP
 126 for the file location for your installation.
 127 .sp
 128 \fBGenerically:\fP
 129 .INDENT 0.0
 130 .INDENT 3.5
 131 .sp
 132 .nf
 133 .ft C
 134 # comment
 135 <guid> "<name>"
 136 .ft P
 137 .fi
 138 .UNINDENT
 139 .UNINDENT
 140 .sp
 141 \fBExample:\fP
 142 .INDENT 0.0
 143 .INDENT 3.5
 144 .sp
 145 .nf
 146 .ft C
 147 # IB1
 148 # Line cards
 149 0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 150 0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 151 0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 152 0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 153 0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB\-24D"
 154
 155 # Spines
 156 0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 157 0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 158 0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 159 0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 160 0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 161
 162 # GUID   Node Name
 163 0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
 164 0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
 165 0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
 166 0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
 167 .ft P
 168 .fi
 169 .UNINDENT
 170 .UNINDENT
 171 .SH SEE ALSO
 172 .sp
 173 ibnetdiscover(8)
 174 .SH DEPENDENCIES
 175 .sp
 176 ibnetdiscover, ibnetdiscover format
 177 .SH AUTHOR
 178 .INDENT 0.0
 179 .TP
 180 .B Hal Rosenstock
 181 < \fI\%halr@voltaire.com\fP >
 182 .UNINDENT
 183 .\" Generated by docutils manpage writer.
 184 .