1ethgentopology(8) EFSFFCLIRG (Man Page) ethgentopology(8)
3
7 ethgentopology
8 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 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 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 ethxmlgenerate -X /usr/share/eth-tools/samples/ethtopology_1.txt -d \;
31 -h Link \
32 -g Rate -g MTU -g Internal -g LinkDetails -h Cable -g CableLength -g
34 CableLabel \
35 -g CableDetails -e Cable -h Port -g IfAddr -g PortNum -g PortId -g Nod‐
37 eDesc
38 \ -g MgmtIfAddr -g NodeType -g PortDetails -e Port -h Port -g IfAddr
39 -g PortNum \ -g PortId -g NodeDesc
40 -g MgmtIfAddr -g NodeType -g PortDetails -e Port -e Link
41 ethxmlgenerate -X /usr/share/eth-tools/samples/ethtopology_2.txt -d \;
45 \
46 -h Node -g IfAddr -g NodeDesc -g NodeDetails -e Node
48
51 /usr/share/eth-tools/samples/ethgentopology [--help] [plane]
52 NOTE: You must use the full path to access this command.
54
58 No option
59 Produces sample output. See Example
61 --help
63 Produces full help text.
65 plane
67 Plane name. Default is 'plane'.
69
72 This file can be found in /usr/share/eth-tools/samples/. For brevity,
73 this sample shows only two links. The second link shows an example of
74 omitting some information. In the second line, the MTU, LinkDetails,
75 and other fields are not present, which is indicated by an empty value
76 for the field (no entry between the semicolon delimiters).
77 NOTE: The following example exceeds the available width of the page.
79 For readability, a blank line is shown between lines to make it clear
80 where the line ends. In an actual link file, no blank lines are used.
81 25g;2048;0;IO Server Link;11m;S4567;cable
84 model 456;0x0002c9020020e004;1;20e004,bender-
85 eth2;0x0002c9020020e004;NIC;
86 Some info about port;0x0011750007000df6;7;Eth7;Switch 1234 Leaf 4;;SW;
87 25g;;0;;;;;0x0002c9020025a678;1;25a678;mindy2-eth2;;NIC;;
92 0x0011750007000e6d;4;Eth4;Switch 2345 Leaf 5;;SW;
93
96 This file can be found in /usr/share/eth-tools/samples/. For brevity,
97 this sample shows only two nodes.
98 0x0002c9020020e004;bender-eth2;More details about node
100 0x0002c9020025a678;mindy2-eth2;Node details
102
107 This file can be found in /usr/share/eth-tools/samples/. For brevity,
108 this sample shows only two nodes.
109 0x0011750007000df6;Switch 1234 Leaf 4;
111 0x0011750007000e6d;Switch
113 2345 Leaf 5;
114
119 When run against the supplied topology input files, /usr/share/eth-
120 tools/samples/ethgentopology produces:
121 <?xml version="1.0" encoding="utf-8" ?>
123 <Report plane="plane">
125 <LinkSummary>
127 <Link>
129 <Rate>25g</Rate>
131 <MTU>2048</MTU>
133 <Internal>0</Internal>
135 <LinkDetails>IO Server Link</LinkDetails>
137 <Cable>
139 <CableLength>11m</CableLength>
141 <CableLabel>S4567</CableLabel>
143 <CableDetails>cable model 456</CableDetails>
145 </Cable>
147 <Port>
149 <IfAddr>0x001175010020e004</IfAddr>
151 <PortNum>1</PortNum>
153 <PortId>20e004</PortId> <NodeDesc>bender-eth2</NodeDesc>
155 <MgmtIfAddr>0x001175010020e004</MgmtIfAddr>
157 <NodeType>NIC</NodeType>
159 <PortDetails>Some info about port</PortDetails>
161 </Port>
163 <Port>
165 <IfAddr>0x0011750107000df6</IfAddr>
167 <PortNum>7</PortNum>
169 <PortId>Eth7</PortId> <NodeDesc>Switch 1234 Leaf 4</NodeDesc>
171 <NodeType>SW</NodeType>
173 </Port>
175 </Link>
177 <Link>
179 <Rate>25g</Rate>
181 <Internal>0</Internal>
183 <Cable>
185 </Cable>
187 <Port>
189 <IfAddr>0x001175010025a678</IfAddr>
191 <PortNum>1</PortNum>
193 <PortId>25a678</PortId> <NodeDesc>mindy2-eth2</NodeDesc>
195 <NodeType>NIC</NodeType>
197 </Port>
199 <Port>
201 <IfAddr>0x0011750107000e6d</IfAddr>
203 <PortNum>4</PortNum>
205 <PortId>Eth4</PortId> <NodeDesc>Switch 2345 Leaf 5</NodeDesc>
207 <NodeType>SW</NodeType>
209 </Port>
211 </Link>
213 </LinkSummary>
215 <Nodes>
217 <NICs>
219 <Node>
221 <IfAddr>0x0002c9020020e004</IfAddr>
223 <NodeDesc>bender-eth2</NodeDesc>
225 <NodeDetails>More details about node</NodeDetails>
227 </Node>
229 <Node>
231 <IfAddr>0x0002c9020025a678</IfAddr>
233 <NodeDesc>mindy2-eth2</NodeDesc>
235 <NodeDetails>Node details</NodeDetails>
237 </Node>
239 </NICs>
241 <Switches>
243 <Node>
245 <IfAddr>0x0011750107000df6</IfAddr>
247 <NodeDesc>Switch 1234 Leaf 4</NodeDesc>
249 </Node>
251 <Node>
253 <IfAddr>0x0011750107000e6d</IfAddr>
255 <NodeDesc>Switch 2345 Leaf 5</NodeDesc>
257 </Node>
259 </Switches>
261 </Nodes>
263 </Report>
265Copyright(C) 2020-2022 Intel Corporation ethgentopology(8)