1ethxlattopology(8) EFSFFCLIRG (Man Page) ethxlattopology(8)
3
7 ethxlattopology
8 Generates a topology XML file of a cluster using your customized
12 <topologyfile>.csv and core switch linksum files, e.g.
13 linksum_swd06.csv, and linksum_swd24.csv as input. The output topology
14 XML file can be used to bring up and verify the cluster.
15
17 ethxlattopology [-d level] [-v level] [-i level] [-K] [-N] [-f
18 linkfiles]
19 [-o report] [-p plane] [source [dest]]
21
23 --help
24 Produces full help text.
26 -d level
29 Specifies the output detail level. Default is 0. Levels are
31 additive.
32 By default, the top level is always produced. Switch, rack,
35 and rack group topology files can be added to the output by
36 choosing the appropriate level. If the output at the group or
37 rack level is specified, then group or rack names must be
38 provided in the spreadsheet. Detailed output can be specified
39 in any combination. A directory for each topology XML file is
40 created hierarchically, with group directories (if specified)
41 at the highest level, followed by rack and switch directories
42 (if specified).
43 1 Core switch topology files.
47 2 Rack topology files.
53 4 Rack group topology files.
59 -v level
63 Specifies the verbose level. Range is 0 - 8. Default is 2.
65 0 No output.
70 1 Progress output.
76 2 Reserved.
82 4 Time stamps.
88 8 Reserved.
94 -i level
98 Specifies the output indent level. Default is 4.
100 -K
103 Specifies DO NOT clean temporary files.
105 Prevents temporary files in each topology directory from be‐
108 ing removed. Temporary files contain CSV formatted lists of
109 links, NICs, and switches used to create a topology XML file.
110 Temporary files are not typically needed after a topology
111 file is created, or can be retained for subsequent inspection
112 or processing.
113 -N
115 Specifies DO NOT generate Port Numbers from Port IDs.
117 This will introduce slightly poorer topology loading perfor‐
120 mance. Useful when have difficulty to generate Port Numbers,
121 such as complicated Port ID formats, or not enough Port IDs
122 to train the Port Number generator.
123 -f linkfiles
125 Specifies the space separated core switch linksum files.
127 -o report
130 Specifies the report type for output. By default, all the
132 sections are generated.
133 Report Types:
136 brnodes Creates the <Node> section xml for the csv input.
140 links Creates the <LinkSummary> section xml for the csv
146 input.
147 -p plane
151 Plane name (default 'plane').
153 source
155 Specifies the source csv file. Default is topology.csv.
157 dest
160 Specifies the output xml file. Default is topology.xml
162 The default output file name can be used to specify destina‐
165 tion folder.
166
168 The ethxlattopology script reads your customized <topologyfile>.csv
169 file from the local directory, and reads the core switch linksum files
170 specified by -f argument. Two sample topology XLSX files, de‐
171 tailed_topology.xlsx and minimal_topology.xlsx, are located in the
172 /usr/share/eth-tools/samples/ directory. You must create your <topolo‐
173 gyfile>.csv file by editing one of the sample spreadsheets and saving
174 the Fabric Links tab as a CSV file. Inspect your <topologyfile>.csv
175 file to ensure that each row contains the correct and same number of
176 comma separators. Any extraneous entries in the spreadsheet can cause
177 the CSV output to have extra fields. Do the same thing on the "Internal
178 xxx Links" tab to create your own internal core switch linksum csv
179 files.
180
182 ethxlattopology -f "/usr/share/eth-tools/samples/linksum_swd06.csv
183 /usr/share/eth-tools/samples/linksum_swd24.csv" /tmp/detailed_topol‐
184 ogy.csv
185 Parsing linksum file: /usr/share/eth-tools/samples/linksum_swd06.csv
187 Parsing linksum file: /usr/share/eth-tools/samples/linksum_swd24.csv
189 Parsing /tmp/detailed_topology.csv
191 Generating links for Core:core1
193 Generating links for Core:core2
195 Processing Leaves of partially populated Core:core2
197 Processing spines of partially populated Core:core2
199 Generating topology.xml file(s)
201 Done
203 Both sample files contain examples of links between NIC and Edge SW
205 (rows 4-7), NIC and Core SW (rows 8-11), and Edge SW and Core SW (rows
206 12-15).
207
209 The following environment variables allow user-specified MTU.
210 MTU_SW_SW
212 If set, it overrides default MTU on switch-to-switch links.
214 Default is 10240
215 MTU_SW_NIC
218 If set, it overrides default MTU on switch-to-NIC links. De‐
220 fault is 10240
221
224 For Multi-Rail/Multi-Plane fabrics, you have the following options:
225 • For Multi-Rail fabrics or for a Single Plane fabric with some
227 multi-ported hosts, you can create multiple rows for a host with
228 different Port names, and then follow the standard procedure to
229 generate <topologyfile>.xml.
230 • For a Multi-Plane fabric with identical planes, the tool can be
232 run multiple times on the same <topologyfile>.csv modified with
233 different port names. For example, if there are two identical
234 fabrics (fabric_1 and fabric_2) connected to a single host with
235 two NICs (eth2 and eth3), the tool can be run twice like this:
236 • For fabric_1:
239 In <topologyfile>.csv, set port name to be eth2 for hosts.
241 • For fabric_2:
244 In <topologyfile>.csv, set port name to be eth3 for hosts.
246 • For a fabric with both Multi-Rail and Multi-Plane segments, you
249 can use a combination of the above techniques to generate the
250 desired <topologyfile>.xml file.
251Copyright(C) 2020-2021 Intel Corporation ethxlattopology(8)