1opagentopology(8) Master map: IFSFFCLIRG (Man Page) opagentopology(8)
3
7 opagentopology
8 Generates sample topology verification XML. Provides an example of
12 using opaxmlgenerate and is a prototype for customization.
13 Uses CSV input files opatopology_links.txt, opatopology_FIs.txt, and
15 opatopology_SWs.txt to generate LinkSummary, Node FIs, and Node SWs
16 information respectively. These files are samples of what might be pro‐
17 duced as part of translating a user custom file format into temporary
18 intermediate CSV files.
19 LinkSummary information includes Link, Cable, and Port information.
21 Note that opagentopology (not opaxmlgenerate) generates the XML version
22 string as well as the <Topology> and <LinkSummary> lines. Also note
23 that the indent level is at the default value of zero (0). The portions
24 of the script that call opaxmlgenerate follow:
25 opaxmlgenerate -X /usr/share/opa/samples/opatopology_1.txt -d ;
27 -h Link -g Rate -g Rate_Int -g MTU -g LinkDetails -h Cable
28 -g CableLength -g CableLabel -g CableDetails -e Cable -h Port
29 -g NodeGUID -g PortNum -g NodeDesc -g PortGUID -g NodeType -g Node‐
30 Type_Int
31 -g PortDetails -e Port -h Port -g NodeGUID -g PortNum -g NodeDesc -g
32 PortGUID
33 -g NodeType -g NodeType_Int -g PortDetails -e Port -e Link
34 opaxmlgenerate -X /usr/share/opa/samples/opatopology_2.txt -d ;
37 -h Node -g NodeGUID -g NodeDesc -g NodeDetails -g HostName -g NodeType
38 -g NodeType_Int -g NumPorts -e Node
39
42 This file can be found in /usr/share/opa/samples/. For brevity, this
43 sample shows only two links. The second link shows an example of omit‐
44 ting some information. In the second line, the MTU, LinkDetails, and
45 other fields are not present, which is indicated by an empty value for
46 the field (no entry between the semicolon delimiters).
47 NOTE: The following example exceeds the available width of the page.
49 For readability, a blank line is shown between lines to make it clear
50 where the line ends. In an actual link file, no blank lines are used.
51 25g;2048;0;IO Server Link;11m;S4567;cable
54 model 456;0x0002c9020020e004;1;bender HFI-1;0x0002c9020020e004;FI;
55 Some info about port;0x0011750007000df6;7;Switch 1234 Leaf 4;;SW;
56 25g;;0;;;;;0x0002c9020025a678;1;mindy2 HFI-1;;FI;;
60 0x0011750007000e6d;4;Switch 2345 Leaf 5;;SW;
61
64 This file can be found in /usr/share/opa/samples/. For brevity, this
65 sample shows only two nodes.
66 0x0002c9020020e004;bender HFI-1;More details about node
68 0x0002c9020025a678;mindy2 HFI-1;Node details
69
74 This file can be found in /usr/share/opa/samples/. For brevity, this
75 sample shows only two nodes.
76 0x0011750007000df6;Switch 1234 Leaf 4; 0x0011750007000e6d;Switch
78 2345 Leaf 5;
79
84 This file can be found in /usr/share/opa/samples/. For brevity, this
85 sample shows only one node.
86 0x0002c9020025a678;1;mindy2 HFI-1;0x0011750007000e6d;FI;details
88 about SM
89
93 When run against the supplied topology input files, opagentopology
94 produces:
95 <?xml version="1.0" encoding="utf-8" ?>
97 <Topology>
98 <LinkSummary>
99 <Link>
100 <Rate>25g</Rate>
101 <MTU>2048</MTU>
102 <Internal>0</Internal>
103 <LinkDetails>IO Server Link</LinkDetails>
104 <Cable>
105 <CableLength>11m</CableLength>
106 <CableLabel>S4567</CableLabel>
107 <CableDetails>cable model 456</CableDetails>
108 </Cable>
109 <Port>
110 <NodeGUID>0x0002c9020020e004</NodeGUID>
111 <PortNum>1</PortNum>
112 <NodeDesc>bender HFI-1</NodeDesc>
113 <PortGUID>0x0002c9020020e004</PortGUID>
114 <NodeType>FI</NodeType>
115 <PortDetails>Some info about port</PortDetails>
116 </Port>
117 <Port>
118 <NodeGUID>0x0011750007000df6</NodeGUID>
119 <PortNum>7</PortNum>
120 <NodeDesc>Switch 1234 Leaf 4</NodeDesc>
121 <NodeType>SW</NodeType>
122 </Port>
123 </Link>
124 <Link>
125 <Rate>25g</Rate>
126 <Internal>0</Internal>
127 <Cable>
128 </Cable>
129 <Port>
130 <NodeGUID>0x0002c9020025a678</NodeGUID>
131 <PortNum>1</PortNum>
132 <NodeDesc>mindy2 HFI-1</NodeDesc>
133 <NodeType>FI</NodeType>
134 </Port>
135 <Port>
136 <NodeGUID>0x0011750007000e6d</NodeGUID>
137 <PortNum>4</PortNum>
138 <NodeDesc>Switch 2345 Leaf 5</NodeDesc>
139 <NodeType>SW</NodeType>
140 </Port>
141 </Link>
142 </LinkSummary>
143 <Nodes>
144 <FIs>
145 <Node>
146 <NodeGUID>0x0002c9020020e004</NodeGUID>
147 <NodeDesc>bender HFI-1</NodeDesc>
148 <NodeDetails>More details about node</NodeDetails>
149 </Node>
150 <Node>
151 <NodeGUID>0x0002c9020025a678</NodeGUID>
152 <NodeDesc>mindy2 HFI-1</NodeDesc>
153 <NodeDetails>Node details</NodeDetails>
154 </Node>
155 </FIs>
156 <Switches>
157 <Node>
158 <NodeGUID>0x0011750007000df6</NodeGUID>
159 <NodeDesc>Switch 1234 Leaf 4</NodeDesc>
160 </Node>
161 <Node>
162 <NodeGUID>0x0011750007000e6d</NodeGUID>
163 <NodeDesc>Switch 2345 Leaf 5</NodeDesc>
164 </Node>
165 </Switches>
166 <SMs>
167 <SM>
168 <NodeGUID>0x0002c9020025a678</NodeGUID>
169 <PortNum>1</PortNum>
170 <NodeDesc>mindy2 HFI-1</NodeDesc>
171 <PortGUID>0x0011750007000e6d</PortGUID>
172 <NodeType>FI</NodeType>
173 <SMDetails>details about SM</SMDetails>
174 </SM>
175 </SMs>
176 </Nodes>
177 </Topology>
178Copyright(C) 2015-2018 Intel Corporation opagentopology(8)