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

NAME

7       ethextractmissinglinks
8
9
10
11       Produces  a  CSV  file  listing all or some of the links in the fabric.
12       ethextractmissinglinks is a front end to the ethreport 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       ethextractmissinglinks [-T topology_input] [-o report]
20       [ethreport  options]
21

Options

23       --help
24
25                 Produces full help text.
26
27
28       -T/--topology topology_input
29
30                 Specifies the topology file to  verify  against.  Default  is
31                 /etc/eth-tools/topology.xml
32
33
34       -o/--output report
35
36                 Specifies  the  report type for output. Refer to Report Types
37                 for details.
38
39
40       ethreport options
41
42                 The following options are passed to ethreport. This subset is
43                 considered typical and useful for this command.
44
45
46
47
48                 -X/--infile snapshot_input
49                           Generates  a  report  using  the  data in the snap‐
50                           shot_input file. snapshot_input must have been gen‐
51                           erated  during  a previous -o snapshot run. '-' may
52                           be used as the snapshot_input to specify stdin.
53
54
55
56
57
58                 -E/--eth config_file
59                           Specifies the Ethernet Mgt configuration file.  De‐
60                           fault is /etc/eth-tools/mgt_config.xml file.
61
62
63
64
65
66                 -p plane
67                           Name  of  the  enabled  plane defined in Mgt config
68                           file, default is the first enabled plane.
69
70
71
72
73
74                 -F/--focus point
75                           Specifies the focus area for report. Used to  limit
76                           scope of report. Refer to Point Syntax for details.
77
78
79
80

Report Types

82       verifylinks
83
84                 Compares  fabric (or snapshot) links to supplied topology and
85                 identifies differences and omissions.
86
87
88       verifyextlinks
89
90                 Compares fabric (or snapshot) links to supplied topology  and
91                 identifies  differences  and  omissions.  Limits  analysis to
92                 links external to systems.
93
94
95       verifyniclinks
96
97                 Compares fabric (or snapshot) links to supplied topology  and
98                 identify  differences and omissions. Limits analysis to links
99                 to NICs.
100
101
102       verifyislinks
103
104                 Compares fabric (or snapshot) links to supplied topology  and
105                 identify differences and omissions. Limits analysis to inter-
106                 switch links.
107
108
109       verifyextislinks
110
111                 Compares fabric (or snapshot) links to supplied topology  and
112                 identify differences and omissions. Limits analysis to inter-
113                 switch links external to systems.
114
115
116       verifyall
117
118                 Returns verifynics, verifysws, and verifylinks reports.
119
120
121

Point Syntax

123       ifid:value
124
125                 value is numeric ifid.
126
127
128       ifid:value:node
129
130                 value is numeric ifid, selects node with given ifid.
131
132
133       ifid:value:port:value2
134
135                 value is numeric ifid of node, value2 is port number.
136
137
138       ifid:value:portid:value2
139
140                 value is numeric ifid of node, value2 is port id.
141
142
143       mgmtifaddr:value
144
145                 value is numeric port mgmtifaddr.
146
147
148       ifaddr:value
149
150                 value is numeric node ifaddr.
151
152
153       ifaddr:value1:port:value2
154
155                 value1 is numeric node ifaddr, value2 is port number.
156
157
158       ifaddr:value1:portid:value2
159
160                 value1 is numeric node ifaddr, value2 is port id.
161
162
163       chassisid:value
164
165                 value is numeric chassisid.
166
167
168       chassisid:value1:port:value2
169
170                 value1 is numeric chassisid, value2 is port number.
171
172
173       chassisid:value1:portid:value2
174
175                 value1 is numeric chassisid, value2 is port id.
176
177
178       node:value
179
180                 value is node description (node name).
181
182
183       node:value1:port:value2
184
185                 value1 is node description (node name), value2 is  port  num‐
186                 ber.
187
188
189       node:value1:portid:value2
190
191                 value1 is node description (node name), value2 is port id.
192
193
194       nodepat:value
195
196                 value is glob pattern for node description (node name).
197
198
199       nodepat:value1:port:value2
200
201                 value1  is  the  glob  pattern for the node description (node
202                 name), value2 is port number.
203
204
205       nodepat:value1:portid:value2
206
207                 value1 is the glob pattern for  the  node  description  (node
208                 name), value2 is port id.
209
210
211       nodedetpat:value
212
213                 value is glob pattern for node details.
214
215
216       nodedetpat:value1:port:value2
217
218                 value1  is  the  glob pattern for the node details, value2 is
219                 port number.
220
221
222       nodedetpat:value1:portid:value2
223
224                 value1 is the glob pattern for the node  details,  value2  is
225                 port id.
226
227
228       nodetype:value
229
230                 value is node type (SW or NIC).
231
232
233       nodetype:value1:port:value2
234
235                 value1 is node type (SW or NIC), value2 is port number.
236
237
238       nodetype:value1:portid:value2
239
240                 value1 is node type (SW or NIC), value2 is port id.
241
242
243       rate:value
244
245                 value  is string for rate (25g, 50g, 75g, 100g), omits switch
246                 mgmt port 0.
247
248
249       portstate:value
250
251                 value is a string for state (up, down, testing, unknown, dor‐
252                 mant, notactive).
253
254
255       portphysstate:value
256
257                 value  is  a  string  for  PHYs state (other, unknown, opera‐
258                 tional, standby, shutdown, reset)
259
260
261       mtucap:value
262
263                 value is MTU size (maximum size  65535),  omits  switch  mgmt
264                 port 0.
265
266
267       linkdetpat:value
268
269                 value is glob pattern for link details.
270
271
272       portdetpat:value
273
274                 value is glob pattern for port details.
275
276
277       nodepatfile:FILENAME
278
279                 Specifies  the name of file with the list of nodepats or node
280                 descriptions.
281
282
283       nodepairpatfile:FILENAME
284
285                 Specifies the name of file with the list of node pairs, sepa‐
286                 rated by a colon.
287
288
289       ldr
290
291                 Specifies  the  ports  with  a  non-zero  link down reason or
292                 neighbor link down reason.
293
294
295       ldr:value
296
297                 Specifies the ports with a link down reason or neighbor  link
298                 down reason equal to value.
299
300

Examples

302       List all the missing links in the fabric:
303
304            ethextractmissinglinks
305
306
307
308       List all the missing links to a switch named "coresw1":
309
310            ethextractmissinglinks -T topology.plane.xml -F "node:coresw1"
311
312
313
314       List all the missing connections to end-nodes:
315
316            ethextractmissinglinks -o verifyniclinks
317
318
319
320       List all the missing links between two switches:
321
322            ethextractmissinglinks -o verifyislinks -T topology.plane.xml
323
324
325
326Copyright(C) 2020-2022         Intel Corporation     ethextractmissinglinks(8)
Impressum