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

NAME

7       ethgentopology
8
9
10
11       Provides  a simple sample of how to generate the topology XML file used
12       for topology verification. Customers who wish to integrate topology XML
13       file  generation into their cluster design process can create their own
14       script to take information available in other  formats  and  tools  and
15       produce  the  topology  XML  file  directly.  The alternative is to use
16       ethxlattopology and have tools generate the input files it expects.
17
18       This  tool  uses  CSV  input  files  ethtopology_links.txt,   ethtopol‐
19       ogy_NICs.txt,  and  ethtopology_SWs.txt  to  generate LinkSummary, Node
20       NICs, and Node SWs information, respectively. These files  are  samples
21       of  what  might  be  produced as part of translating a user custom file
22       format into temporary intermediate CSV files.
23
24       LinkSummary information includes Link,  Cable,  and  Port  information.
25       Note that ethgentopology (not ethxmlgenerate) generates the XML version
26       string as well as the <Report> and <LinkSummary> lines. Also note  that
27       the  indent  level is at the default value of zero (0). The portions of
28       the script that call ethxmlgenerate follow:
29
30       ethxmlgenerate -X /usr/share/eth-tools/samples/ethtopology_1.txt -d  \;
31       -h Link \
32
33       -g  Rate  -g  MTU -g Internal -g LinkDetails -h Cable -g CableLength -g
34       CableLabel \
35
36       -g CableDetails -e Cable -h Port -g IfAddr -g PortNum  -g  NodeDesc  -g
37       MgmtIfAddr \
38
39       -g  NodeType  -g  PortDetails  -e Port  -h Port -g IfAddr -g PortNum -g
40       NodeDesc \
41
42       -g MgmtIfAddr -g NodeType -g PortDetails -e Port -e Link
43
44
45
46       ethxmlgenerate -X /usr/share/eth-tools/samples/ethtopology_2.txt -d  \;
47       \
48
49       -h Node -g IfAddr -g NodeDesc -g NodeDetails -e Node
50
51

Syntax

53       /usr/share/eth-tools/samples/ethgentopology [--help] [plane]
54
55       NOTE: You must use the full path to access this command.
56
57
58

Options

60       No option
61
62                 Produces sample output. See Example
63
64       --help
65
66                 Produces full help text.
67
68       plane
69
70                 Plane name. Default is 'plane'.
71
72

ethtopology_links.txt

74       This  file  can be found in /usr/share/eth-tools/samples/. For brevity,
75       this sample shows only two links. The second link shows an  example  of
76       omitting  some  information.  In the second line, the MTU, LinkDetails,
77       and other fields are not present, which is indicated by an empty  value
78       for the field (no entry between the semicolon delimiters).
79
80       NOTE:  The  following  example exceeds the available width of the page.
81       For readability, a blank line is shown between lines to make  it  clear
82       where the line ends. In an actual link file, no blank lines are used.
83
84
85       25g;2048;0;IO Server Link;11m;S4567;cable
86       model 456;0x0002c9020020e004;1;bender-eth2;0x0002c9020020e004;NIC;
87       Some info about port;0x0011750007000df6;7;Switch 1234 Leaf 4;;SW;
88
89
90
91
92       25g;;0;;;;;0x0002c9020025a678;1;mindy2-eth2;;NIC;;
93       0x0011750007000e6d;4;Switch 2345 Leaf 5;;SW;
94
95

ethtopology_NICs.txt

97       This  file  can be found in /usr/share/eth-tools/samples/. For brevity,
98       this sample shows only two nodes.
99
100       0x0002c9020020e004;bender-eth2;More details about node
101
102       0x0002c9020025a678;mindy2-eth2;Node details
103
104
105
106

ethtopology_SWs.txt

108       This file can be found in /usr/share/eth-tools/samples/.  For  brevity,
109       this sample shows only two nodes.
110
111       0x0011750007000df6;Switch 1234 Leaf 4;
112
113       0x0011750007000e6d;Switch
114       2345 Leaf 5;
115
116
117
118

Example

120       When  run  against  the  supplied topology input files, /usr/share/eth-
121       tools/samples/ethgentopology produces:
122
123       <?xml version="1.0" encoding="utf-8" ?>
124
125       <Report plane="plane">
126
127       <LinkSummary>
128
129       <Link>
130
131       <Rate>25g</Rate>
132
133       <MTU>2048</MTU>
134
135       <Internal>0</Internal>
136
137       <LinkDetails>IO Server Link</LinkDetails>
138
139       <Cable>
140
141       <CableLength>11m</CableLength>
142
143       <CableLabel>S4567</CableLabel>
144
145       <CableDetails>cable model 456</CableDetails>
146
147       </Cable>
148
149       <Port>
150
151       <IfAddr>0x001175010020e004</IfAddr>
152
153       <PortNum>1</PortNum>
154
155       <NodeDesc>bender-eth2</NodeDesc>
156
157       <MgmtIfAddr>0x001175010020e004</MgmtIfAddr>
158
159       <NodeType>NIC</NodeType>
160
161       <PortDetails>Some info about port</PortDetails>
162
163       </Port>
164
165       <Port>
166
167       <IfAddr>0x0011750107000df6</IfAddr>
168
169       <PortNum>7</PortNum>
170
171       <NodeDesc>Switch 1234 Leaf 4</NodeDesc>
172
173       <NodeType>SW</NodeType>
174
175       </Port>
176
177       </Link>
178
179       <Link>
180
181       <Rate>25g</Rate>
182
183       <Internal>0</Internal>
184
185       <Cable>
186
187       </Cable>
188
189       <Port>
190
191       <IfAddr>0x001175010025a678</IfAddr>
192
193       <PortNum>1</PortNum>
194
195       <NodeDesc>mindy2-eth2</NodeDesc>
196
197       <NodeType>NIC</NodeType>
198
199       </Port>
200
201       <Port>
202
203       <IfAddr>0x0011750107000e6d</IfAddr>
204
205       <PortNum>4</PortNum>
206
207       <NodeDesc>Switch 2345 Leaf 5</NodeDesc>
208
209       <NodeType>SW</NodeType>
210
211       </Port>
212
213       </Link>
214
215       </LinkSummary>
216
217       <Nodes>
218
219       <NICs>
220
221       <Node>
222
223       <IfAddr>0x0002c9020020e004</IfAddr>
224
225       <NodeDesc>bender-eth2</NodeDesc>
226
227       <NodeDetails>More details about node</NodeDetails>
228
229       </Node>
230
231       <Node>
232
233       <IfAddr>0x0002c9020025a678</IfAddr>
234
235       <NodeDesc>mindy2-eth2</NodeDesc>
236
237       <NodeDetails>Node details</NodeDetails>
238
239       </Node>
240
241       </NICs>
242
243       <Switches>
244
245       <Node>
246
247       <IfAddr>0x0011750107000df6</IfAddr>
248
249       <NodeDesc>Switch 1234 Leaf 4</NodeDesc>
250
251       </Node>
252
253       <Node>
254
255       <IfAddr>0x0011750107000e6d</IfAddr>
256
257       <NodeDesc>Switch 2345 Leaf 5</NodeDesc>
258
259       </Node>
260
261       </Switches>
262
263       </Nodes>
264
265       </Report>
266
267
268
269
270Copyright(C) 2020-2021         Intel Corporation             ethgentopology(8)