1opaxlattopology(8) Master map: IFSFFCLIRG (Man Page) opaxlattopology(8)
3
7 opaxlattopology
8 Generates a topology XML file of a cluster using your customized
12 <topologyfile>.csv, linksum_swd06.csv, and linksum_swd24.csv as input.
13 The output topology XML file can be used to bring up and verify the
14 cluster.
15 NOTE: The <topologyfile>.csv input file must be present in the same
17 directory from which the script operates, but the linksum CSV files are
18 read from the /usr/share/opa/samples directory.
19
22 opaxlattopology [-d level] [-v level] [-i level] [-K] [-s hfi_suffix]
23 [source [dest]]
24
26 --help Produces full help text.
27 -d level Specifies the output detail level. Default = 0. Levels are
30 additive.
31 By default, the top level is always produced. Switch, rack,
34 and rack group topology files can be added to the output by
35 choosing the appropriate level. If the output at the group or
36 rack level is specified, then group or rack names must be
37 provided in the spreadsheet. Detailed output can be specified
38 in any combination. A directory for each topology XML file is
39 created hierarchically, with group directories (if specified)
40 at the highest level, followed by rack and switch directories
41 (if specified).
42 1 Intel(R) Omni-Path Edge Switch 100 Series topology
46 files.
47 2 Rack topology files.
53 4 Rack group topology files.
59 -v level Specifies the verbose level. Range = 0 - 8. Default = 2.
63 0 No output.
68 1 Progress output.
74 2 Reserved.
80 4 Time stamps.
86 8 Reserved.
92 -i level Specifies the output indent level. Default = 4.
96 -K Specifies DO NOT clean temporary files.
99 Prevents temporary files in each topology directory from
102 being removed. Temporary files contain CSV formatted lists of
103 links, HFIs, and switches used to create a topology XML file.
104 Temporary files are not typically needed after a topology
105 file is created, however they are used for creating
106 linksum_swd06.csv and linksum_swd24.csv files, or can be
107 retained for subsequent inspection or processing.
108 -s hfi_suffix
110 Used on Multi-Rail or Multi-Plane fabrics. Can be used to
111 override the default hfi1_0.
112 For Multi-Plane fabric, use the tool multiple times with a
115 different hfi-suffix.
116 For Multi-Rail fabric, specify HostName as "HostName HfiName"
118 in the spreadsheet.
119 -o report Specifies the report type for output. By default, all the
121 sections are generated.
122 Report Types:
125 brnodes Creates the <Node> section xml for the csv input.
129 links Creates the <LinkSummary> section xml for the csv
135 input.
136
140 The opaxlattopology script reads your customized <topologyfile>.csv
141 file from the local directory, and reads the other files from
142 /usr/share/opa/samples/linksum_swd06.csv and /usr/share/opa/sam‐
143 ples/linksum_swd24.csv. Two sample topology XLSX files, detailed_topol‐
144 ogy.xlsx and minimal_topology.xlsx, are located in the
145 /usr/share/opa/samples/ directory. You must create your <topology‐
146 file>.csv file by editing one of the sample spreadsheets and saving the
147 Fabric Links tab as a CSV file. Inspect your <topologyfile>.csv file to
148 ensure that each row contains the correct and same number of comma sep‐
149 arators. Any extraneous entries in the spreadsheet can cause the CSV
150 output to have extra fields.
151 The script outputs one or more topology files starting with topol‐
153 ogy.0:0.xml. Your <topologyfile>.csv input file must be present in the
154 same directory from which the script operates, but the linksum CSV
155 files are read from the /usr/share/opa/samples directory.
156
158 opaxlattopology
159 # reads default input 'topology.csv' and creates default
160 # output 'topology.0:0.xml'
161 opaxlattopology fabric_2.csv
163 # reads input 'fabric_2.csv' and creates default output
164 Both sample files contain examples of links between HFI and Edge SW
166 (rows 4-7), HFI and Core SW (rows 8-11), and Edge SW and Core SW (rows
167 12-15).
168
170 The following environment variables allow user-specified MTU.
171 MTU_SW_SW If set, it overrides default MTU on switch-to-switch links.
173 Default = 10240
174 MTU_SW_HFI
177 If set, it overrides default MTU on switch-to-HFI links.
178 Default = 10240
179
182 The linksum_swd06.csv and linksum_swd24.csv files are provided as
183 stand-alone files in the /usr/share/opa/samples directory. However,
184 they can be recreated (or modified) from the spreadsheet, if needed, by
185 performing the following steps:
186 1) Save each of the following from your custom <topologyfile>.xlsx
189 file as individual .csv files:
190 · Internal SWD06 Links tab as linksum_swd06.csv
192 · Internal SWD24 Links tab as linksum_swd24.csv
194 · Fabric Links tab as <topologyfile>.csv
196 2) For each saved <topologyfile>.csv file, run the script with the -K
199 option.
200 3) Upon completion of the script, save the top level linksum.csv file
203 as linksum_swd06.csv or linksum_swd24.csv as appropriate.
204
207 By default, the opaxlattopology script considers all of the hosts to
208 have a single HFI (hfi1_0).
209 For Multi-Rail/Multi-Plane fabrics, you have the following options:
211 · For Multi-Rail fabrics or for a Single Plane fabric with some
213 multi-ported hosts, you can edit the Host Name in your custom‐
214 ized <topologyfile>.csv file to include the HFI Name (for exam‐
215 ple: HostName HfiName) and then follow the standard procedure to
216 generate <topologyfile>.xml.
217 · For a Multi-Plane fabric with identical planes, the tool can be
219 run multiple times on the same <topologyfile>.csv with different
220 -s hfi_suffix options. For example, if there are two identical
221 fabrics (fabric_1 and fabric_2) connected to a single host with
222 two HFIs (hfi1_0 and hfi1_1), the tool can be run twice like
223 this:
224 · For fabric_1:
227 opaxlattopology <topologyfile>.csv <topologyfile>.xml
229 · For fabric_2:
234 opaxlattopology -s hfi1_1 <topologyfile>.csv <topologyfile>.xml
236 · For a fabric with both Multi-Rail and Multi-Plane segments, you
242 can use a combination of the above techniques to generate the
243 desired <topologyfile>.xml file.
244Copyright(C) 2015-2018 Intel Corporation opaxlattopology(8)