1
2ethxlattopology(8)           EFSFFCLIRG (Man Page)          ethxlattopology(8)
3
4
5

NAME

7       ethxlattopology
8
9
10
11       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

Syntax

17       ethxlattopology [-d  level] [-v  level] [-i   level]  [-K]  [-f   link‐
18       files]
19
20       [-o  report] [source [dest]]
21

Options

23       --help
24
25                 Produces full help text.
26
27
28       -d level
29
30                 Specifies  the  output detail level. Default is 0. Levels are
31                 additive.
32
33
34                 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
44
45
46                 1         Core switch topology files.
47
48
49
50
51
52                 2         Rack topology files.
53
54
55
56
57
58                 4         Rack group topology files.
59
60
61
62       -v level
63
64                 Specifies the verbose level. Range is 0 - 8. Default is 2.
65
66
67
68
69                 0         No output.
70
71
72
73
74
75                 1         Progress output.
76
77
78
79
80
81                 2         Reserved.
82
83
84
85
86
87                 4         Time stamps.
88
89
90
91
92
93                 8         Reserved.
94
95
96
97       -i level
98
99                 Specifies the output indent level. Default is 4.
100
101
102       -K
103
104                 Specifies DO NOT clean temporary files.
105
106
107                 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
114       -f linkfiles
115
116                 Specifies the space separated core switch linksum files.
117
118
119       -o report
120
121                 Specifies  the  report  type  for output. By default, all the
122                 sections are generated.
123
124
125                 Report Types:
126
127
128
129                 brnodes   Creates the <Node> section xml for the csv input.
130
131
132
133
134
135                 links     Creates the <LinkSummary> section xml for  the  csv
136                           input.
137
138
139
140       source
141
142                 Specifies the source csv file. Default is topology.csv.
143
144
145       dest
146
147                 Specifies the output xml file. Default is topology.xml
148
149
150                 The  default output file name can be used to specify destina‐
151                 tion folder.
152

Description

154       The ethxlattopology script  reads  your  customized  <topologyfile>.csv
155       file  from the local directory, and reads the core switch linksum files
156       specified  by  -f  argument.  Two  sample  topology  XLSX  files,   de‐
157       tailed_topology.xlsx  and  minimal_topology.xlsx,  are  located  in the
158       /usr/share/eth-tools/samples/ directory. You must create your  <topolo‐
159       gyfile>.csv  file  by editing one of the sample spreadsheets and saving
160       the Fabric Links tab as a CSV  file.  Inspect  your  <topologyfile>.csv
161       file  to  ensure  that each row contains the correct and same number of
162       comma separators. Any extraneous entries in the spreadsheet  can  cause
163       the CSV output to have extra fields. Do the same thing on the "Internal
164       xxx Links" tab to create your own  internal  core  switch  linksum  csv
165       files.
166

Example

168       ethxlattopology    -f   "/usr/share/eth-tools/samples/linksum_swd06.csv
169       /usr/share/eth-tools/samples/linksum_swd24.csv"    /tmp/detailed_topol‐
170       ogy.csv
171
172       Parsing linksum file: /usr/share/eth-tools/samples/linksum_swd06.csv
173
174       Parsing linksum file: /usr/share/eth-tools/samples/linksum_swd24.csv
175
176       Parsing /tmp/detailed_topology.csv
177
178       Generating links for Core:core1
179
180       Generating links for Core:core2
181
182       Processing Leaves of partially populated Core:core2
183
184       Processing spines of partially populated Core:core2
185
186       Generating topology.xml file(s)
187
188       Done
189
190       Both  sample  files  contain  examples of links between NIC and Edge SW
191       (rows 4-7), NIC and Core SW (rows 8-11), and Edge SW and Core SW  (rows
192       12-15).
193

Environment Variables

195       The following environment variables allow user-specified MTU.
196
197       MTU_SW_SW
198
199                 If  set,  it overrides default MTU on switch-to-switch links.
200                 Default is 10240
201
202
203       MTU_SW_NIC
204
205                 If set, it overrides default MTU on switch-to-NIC links.  De‐
206                 fault is 10240
207
208

Multi-Rail and Multi-Plane Fabrics

210       For Multi-Rail/Multi-Plane fabrics, you have the following options:
211
212       •      For  Multi-Rail  fabrics  or for a Single Plane fabric with some
213              multi-ported hosts, you can create multiple rows for a host with
214              different  Port names, and then follow the standard procedure to
215              generate <topologyfile>.xml.
216
217       •      For a Multi-Plane fabric with identical planes, the tool can  be
218              run  multiple times on the same <topologyfile>.csv modified with
219              different port names.  For example, if there are  two  identical
220              fabrics  (fabric_1 and fabric_2) connected to a single host with
221              two NICs (eth2 and eth3), the tool can be run twice like this:
222
223
224       •      For fabric_1:
225
226              In <topologyfile>.csv, set port name to be eth2 for hosts.
227
228
229       •      For fabric_2:
230
231              In <topologyfile>.csv, set port name to be eth3 for hosts.
232
233
234       •      For a fabric with both Multi-Rail and Multi-Plane segments,  you
235              can  use  a  combination of the above techniques to generate the
236              desired <topologyfile>.xml file.
237
238
239
240Copyright(C) 2020              Intel Corporation            ethxlattopology(8)