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 <Topology> and  <LinkSummary>  lines.  Also  note
27       that the indent level is at the default value of zero (0). The portions
28       of 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]
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

ethtopology_links.txt

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

ethtopology_NICs.txt

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

ethtopology_SWs.txt

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

Example

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