1
2opaextractmissinglinks(8M)aster map: IFSFFCLIRG (Man Pagoep)aextractmissinglinks(8)
3
4
5

NAME

7       opaextractmissinglinks
8
9
10
11       Produces  a  CSV  file  listing all or some of the links in the fabric.
12       opaextractmissinglinks is a front end to the opareport tool that gener‐
13       ates  a report listing all or some of the links that are present in the
14       supplied topology file, but are missing in the fabric. The output  from
15       this  tool  can  be  imported  into  a  spreadsheet  or parsed by other
16       scripts.
17

Syntax

19       opaextractmissinglinks [-T topology_input] [-o report]
20       [opareport options]
21

Options

23       --help    Produces full help text.
24
25
26       -T/--topology topology_input
27                 Uses topology_input file to augment and verify fabric  infor‐
28                 mation.  When  used,  various  reports  can be augmented with
29                 information  not  available  electronically  (such  as  cable
30                 labels). '-' may be used to specify stdin.
31
32
33       -o/--output report
34                 Specifies  the  report type for output. Refer to Report Types
35                 for details.
36
37
38       opareport options
39                 The following options are passed to opareport. This subset is
40                 considered typical and useful for this command.
41
42
43
44
45                 -h/--hfi hfi
46                           Specifies the HFI, numbered 1..n. Using 0 specifies
47                           that the -p port port is a system-wide port number.
48                           (Default is 0.)
49
50
51
52
53
54                 -p/--port port
55                           Specifies  the  port, numbered 1..n. Using 0 speci‐
56                           fies the first active port. (Default is 0.)
57
58
59
60
61
62                 -X/--infile snapshot_input
63                           Generates a report using  the  data  in  the  snap‐
64                           shot_input file. snapshot_input must have been gen‐
65                           erated during a  previous  -o  snapshot  run.  When
66                           used,  the  -s, -i, -C, and -a options are ignored.
67                           '-' may be used as the  snapshot_input  to  specify
68                           stdin.
69
70
71
72
73
74                 -F/--focus point
75                           Specifies  the  focus area for report. Used for all
76                           reports except route  to  limit  scope  of  report.
77                           Refer to Point Syntax for details.
78
79
80
81

-h and -p options permit a variety of selections:

83       -h 0      First active port in system (default).
84
85
86       -h 0 -p 0 First active port in system.
87
88
89       -h x      First active port on HFI x.
90
91
92       -h x -p 0 First active port on HFI x.
93
94
95       -h 0 -p y Port y within system (no matter which ports are active).
96
97
98       -h x -p y HFI x, port y.
99
100
101

Report Types

103       verifylinks
104                 Compares  fabric (or snapshot) links to supplied topology and
105                 identifies differences and omissions.
106
107
108       verifyextlinks
109                 Compares fabric (or snapshot) links to supplied topology  and
110                 identifies  differences  and  omissions.  Limits  analysis to
111                 links external to systems.
112
113
114       verifyfilinks
115                 Compares fabric (or snapshot) links to supplied topology  and
116                 identify  differences and omissions. Limits analysis to links
117                 to FIs.
118
119
120       verifyislinks
121                 Compares fabric (or snapshot) links to supplied topology  and
122                 identify differences and omissions. Limits analysis to inter-
123                 switch links.
124
125
126       verifyextislinks
127                 Compares fabric (or snapshot) links to supplied topology  and
128                 identify differences and omissions. Limits analysis to inter-
129                 switch links external to systems.
130
131
132       verifyall Returns  verifyfis,  verifysws,  verifysms,  and  verifylinks
133                 reports.
134
135
136

Point Syntax

138       gid:value value is numeric port GID of form: subnet:guid.
139
140
141       lid:value value is numeric LID.
142
143
144       lid:value:node
145                 value is numeric LID, selects entire node with given LID.
146
147
148       lid:value:port:value2
149                 value is numeric LID of node, value2 is port number.
150
151
152       portguid:value
153                 value is numeric port GUID.
154
155
156       nodeguid:value
157                 value is numeric node GUID.
158
159
160       nodeguid:value1:port:value2
161                 value1 is numeric node GUID, value2 is port number.
162
163
164       iocguid:value
165                 value is numeric IOC GUID.
166
167
168       iocguid:value1:port:value2
169                 value1 is numeric IOC GUID, value2 is port number.
170
171
172       systemguid:value
173                 value is numeric system image GUID.
174
175
176       systemguid:value1:port:value2
177                 value1  is the numeric system image GUID, value2 is port num‐
178                 ber.
179
180
181       ioc:value value is IOC Profile ID String (IOC Name).
182
183
184       ioc:value1:port:value2
185                 value1 is IOC Profile ID String (IOC Name),  value2  is  port
186                 number.
187
188
189       iocpat:value
190                 value is glob pattern for IOC Profile ID String (IOC Name).
191
192
193       iocpat:value1:port:value2
194                 value1  is glob pattern for IOC Profile ID String (IOC Name),
195                 value2 is port number.
196
197
198       ioctype:value
199                 value is IOC type (SRP or OTHER).
200
201
202       ioctype:value1:port:value2
203                 value1 is IOC type (SRP or OTHER); value2 is port number.
204
205
206       node:value
207                 value is node description (node name).
208
209
210       node:value1:port:value2
211                 value1 is node description (node name), value2 is  port  num‐
212                 ber.
213
214
215       nodepat:value
216                 value is glob pattern for node description (node name).
217
218
219       nodepat:value1:port:value2
220                 value1  is  the  glob  pattern for the node description (node
221                 name), value2 is port number.
222
223
224       nodedetpat:value
225                 value is glob pattern for node details.
226
227
228       nodedetpat:value1:port:value2
229                 value1 is the glob pattern for the node  details,  value2  is
230                 port number.
231
232
233       nodetype:value
234                 value is node type (SW, FI, or RT).
235
236
237       nodetype:value1:port:value2
238                 value1 is node type (SW, FI, or RT), value2 is port number.
239
240
241       rate:value
242                 value  is string for rate (25g, 50g, 75g, 100g), omits switch
243                 mgmt port 0.
244
245
246       portstate:value
247                 value is a string  for  state  (down,  init,  armed,  active,
248                 notactive, initarmed).
249
250
251       portphysstate:value
252                 value  is  a string for PHYs state (polling, disabled, train‐
253                 ing, linkup, recovery, offline, test)
254
255
256       mtucap:value
257                 value is MTU size (2048, 4096,  8192,  10240),  omits  switch
258                 mgmt port 0.
259
260
261       labelpat:value
262                 value is glob pattern for cable label.
263
264
265       lengthpat:value
266                 value is glob pattern for cable length.
267
268
269       cabledetpat:value
270                 value is glob pattern for cable details.
271
272
273       cabinflenpat:value
274                 value is glob pattern for cable info length.
275
276
277       cabinfvendnamepat:value
278                 value is glob pattern for cable info vendor name.
279
280
281       cabinfvendpnpat:value
282                 value is glob pattern for cable info vendor part number.
283
284
285       cabinfvendrevpat:value
286                 value is glob pattern for cable info vendor revision.
287
288
289       cabinfvendsnpat:value
290                 value is glob pattern for cable info vendor serial number.
291
292
293       cabinftype:value
294                 value  is  either  optical, passive_copper, active_copper, or
295                 unknown.
296
297
298       linkdetpat:value
299                 value is glob pattern for link details.
300
301
302       portdetpat:value
303                 value is glob pattern for port details.
304
305
306       sm        Specifies the master subnet manager (SM).
307
308
309       smdetpat:value
310                 value is glob pattern for SM details.
311
312
313       route:point1:point2
314                 Specifies all ports along the routes between  the  two  given
315                 points.
316
317
318       led:value value is either on or off for LED port beacon.
319
320
321       linkqual:value
322                 Specifies the ports with a link quality equal to value.
323
324
325       linkqualLE:value
326                 Specifies the ports with a link quality less than or equal to
327                 value.
328
329
330       linkqualGE:value
331                 Specifies the ports with a link quality greater than or equal
332                 to value.
333
334

Examples

336       List all the missing links in the fabric:
337       opaextractmissinglinks
338
339       List all the missing links to a switch named "coresw1":
340       opaextractmissinglinks -T topology.0:0.xml -F "node:coresw1"
341
342       List all the missing connections to end-nodes:
343       opaextractmissinglinks -o verifyfilinks
344
345       List  all  the  missing  links on the 2nd HFI's fabric of a multi-plane
346       fabric:
347       opaextractmissinglinks -h 2 -T /etc/opa/topology.2:1.xml
348
349       List all the missing links between two switches:
350       opaextractmissinglinks -o verifyislinks -T topology.0:0.xml
351
352
353
354Copyright(C) 2015-2018         Intel Corporation     opaextractmissinglinks(8)