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

NAME

7       ethreport
8
9
10
11       Provides  powerful  fabric analysis and reporting capabilities. Must be
12       run on a host connected to the Intel(R) Ethernet Fabric  with  the  In‐
13       tel(R) Ethernet Fabric Suite FastFabric Toolset installed.
14

Syntax

16       ethreport  [-v][-q] [--timeout] [-o  report]
17       [-d  detail] [-N] [-x] [-X  snapshot_input] [-T  topology_input]
18       [-A] [-c  file] [-L] [-F  point] [-Q] [-E  file]
19

Options

21       --help
22
23                 Produces full help text.
24
25
26       -v/--verbose
27
28                 Returns verbose output.
29
30
31       -q/--quiet
32
33                 Disables progress reports.
34
35
36       --timeout
37
38                 Specifies the timeout (wait time for response) in ms. Default
39                 is 1000 ms.
40
41
42       -o/--output report
43
44                 Specifies the report type for output. Refer to  Report  Types
45                 for details.
46
47
48       -d/--detail level
49
50                 Specifies the level of detail 0-n for output. Default is 2.
51
52
53       -N/--noname
54
55                 Omits node.
56
57
58       -x/--xml
59
60                 Produces output in XML.
61
62
63       -X/--infile snapshot_input
64
65                 Generates a report using the data in the snapshot_input file.
66                 snapshot_input must have been generated during a previous  -o
67                 snapshot  run. '-' may be used as the snapshot_input to spec‐
68                 ify stdin.
69
70
71       -T/--topology topology_input
72
73                 Uses topology_input file to augment and verify fabric  infor‐
74                 mation.  When used, various reports can be augmented with in‐
75                 formation not available electronically. '-' may  be  used  to
76                 specify stdin.
77
78
79       -A/--allports
80
81                 Gets PortInfo for down switch ports.
82
83
84       -c/--config file
85
86                 Specifies the error thresholds configuration file. Default is
87                 /etc/eth-tools/ethmon.conf file.
88
89
90       -E/--ethconfig file
91
92                 Specifies the Intel Ethernet configuration file.  Default  is
93                 /etc/eth-tools/mgt_config.xml file.
94
95
96       -L/--limit
97
98                 Limits  operation  to  exact specified focus with -F for port
99                 error counters check (-o errors). Normally, the  neighbor  of
100                 each selected port is also checked. Does not affect other re‐
101                 ports.
102
103
104       -F/--focus point
105
106                 Specifies the focus area for report.
107
108
109                 Limits output to reflect a subsection of the fabric. May  not
110                 work  with all reports. (For example, the verify* reports may
111                 ignore the option or not generate useful results.)
112
113       -Q/--quietfocus
114
115                 Excludes focus description from report.
116
117
118

Report Types

120       comps
121
122                 Summary of all systems in fabric.
123
124
125       brcomps
126
127                 Brief summary of all systems in fabric.
128
129
130       nodes
131
132                 Summary of all node types in fabric.
133
134
135       brnodes
136
137                 Brief summary of all node types in fabric.
138
139
140       ifids
141
142                 Summary of all ifids in the fabric.
143
144
145       linkinfo
146
147                 Summary of all links with ifids in the fabric.
148
149
150       links
151
152                 Summary of all links.
153
154
155       extlinks
156
157                 Summary of links external to systems.
158
159
160       niclinks
161
162                 Summary of links to NICs.
163
164
165       islinks
166
167                 Summary of inter-switch links.
168
169
170       extislinks
171
172                 Summary of inter-switch links external to systems.
173
174
175       slowlinks
176
177                 Summary of links running slower than expected.
178
179
180       slowconfiglinks
181
182                 Summary of links configured to run slower than supported, in‐
183                 cludes slowlinks.
184
185
186       slowconnlinks
187
188                 Summary  of  links connected with mismatched speed potential,
189                 includes slowconfiglinks.
190
191
192       misconfiglinks
193
194                 Summary of links configured to run slower than supported.
195
196
197       misconnlinks
198
199                 Summary of links connected with mismatched speed potential.
200
201
202       errors
203
204                 Summary of links whose errors exceed counts in the configura‐
205                 tion file.
206
207
208       otherports
209
210                 Summary of ports not connected to the fabric.
211
212
213       verifynics
214
215                 Compares  fabric  (or snapshot) NICs to supplied topology and
216                 identifies differences and omissions.
217
218
219       verifysws
220
221                 Compares fabric (or snapshot) switches to  supplied  topology
222                 and identifies differences and omissions.
223
224
225       verifynodes
226
227                 Returns verifynics and verifysws reports.
228
229
230       verifylinks
231
232                 Compares  fabric (or snapshot) links to supplied topology and
233                 identifies differences and omissions.
234
235
236       verifyextlinks
237
238                 Compares fabric (or snapshot) links to supplied topology  and
239                 identifies  differences  and  omissions.  Limits  analysis to
240                 links external to systems.
241
242
243       verifyniclinks
244
245                 Compares fabric (or snapshot) links to supplied topology  and
246                 identify  differences and omissions. Limits analysis to links
247                 to NICs.
248
249
250       verifyislinks
251
252                 Compares fabric (or snapshot) links to supplied topology  and
253                 identify differences and omissions. Limits analysis to inter-
254                 switch links.
255
256
257       verifyextislinks
258
259                 Compares fabric (or snapshot) links to supplied topology  and
260                 identify differences and omissions. Limits analysis to inter-
261                 switch links external to systems.
262
263
264       verifyall
265
266                 Returns verifynics, verifysws, and verifylinks reports.
267
268
269       all
270
271                 Returns comps, nodes, links, extlinks, slowconnlinks, and er‐
272                 rors reports.
273
274
275       snapshot
276
277                 Outputs  snapshot  of the fabric state for later use as snap‐
278                 shot_input. This implies -x. May not be combined  with  other
279                 reports. When selected, -F and -N options are ignored.
280
281
282       topology
283
284                 Outputs  the  topology  of the fabric for later use as topol‐
285                 ogy_input. This implies -x. May not be  combined  with  other
286                 reports.  Use with detail level 3 or more to get Port element
287                 under Node in output xml.
288
289
290       fabricinfo
291
292                 Fabric information.
293
294
295       none
296
297                 No report.
298
299
300

Point Syntax

302       ifid:value
303
304                 value is numeric ifid.
305
306
307       ifid:value:node
308
309                 value is numeric ifid, selects node with given ifid.
310
311
312       ifid:value:port:value2
313
314                 value is numeric ifid of node, value2 is port number.
315
316
317       mgmtifaddr:value
318
319                 value is numeric port mgmtifaddr.
320
321
322       ifaddr:value
323
324                 value is numeric node ifaddr.
325
326
327       ifaddr:value1:port:value2
328
329                 value1 is numeric node ifaddr, value2 is port number.
330
331
332       chassisid:value
333
334                 value is numeric chassisid.
335
336
337       chassisid:value1:port:value2
338
339                 value1 is numeric chassisid, value2 is port number.
340
341
342       node:value
343
344                 value is node description (node name).
345
346
347       node:value1:port:value2
348
349                 value1 is node description (node name), value2 is  port  num‐
350                 ber.
351
352
353       nodepat:value
354
355                 value is glob pattern for node description (node name).
356
357
358       nodepat:value1:port:value2
359
360                 value1  is  the  glob  pattern for the node description (node
361                 name), value2 is port number.
362
363
364       nodedetpat:value
365
366                 value is glob pattern for node details.
367
368
369       nodedetpat:value1:port:value2
370
371                 value1 is the glob pattern for the node  details,  value2  is
372                 port number.
373
374
375       nodetype:value
376
377                 value is node type (SW or NIC).
378
379
380       nodetype:value1:port:value2
381
382                 value1 is node type (SW or NIC), value2 is port number.
383
384
385       rate:value
386
387                 value  is string for rate (25g, 50g, 75g, 100g), omits switch
388                 mgmt port 0.
389
390
391       portstate:value
392
393                 value is a string for state (up, down, testing, unknown, dor‐
394                 mant, notactive).
395
396
397       portphysstate:value
398
399                 value  is  a  string  for  PHYs state (other, unknown, opera‐
400                 tional, standby, shutdown, reset)
401
402
403       mtucap:value
404
405                 value is MTU size (maximum size  65535),  omits  switch  mgmt
406                 port 0.
407
408
409       linkdetpat:value
410
411                 value is glob pattern for link details.
412
413
414       portdetpat:value
415
416                 value is glob pattern for port details.
417
418
419       nodepatfile:FILENAME
420
421                 Specifies  the name of file with the list of nodepats or node
422                 descriptions.
423
424
425       nodepairpatfile:FILENAME
426
427                 Specifies the name of file with the list of node pairs, sepa‐
428                 rated by a colon.
429
430
431       ldr
432
433                 Specifies  the  ports  with  a  non-zero  link down reason or
434                 neighbor link down reason.
435
436
437       ldr:value
438
439                 Specifies the ports with a link down reason or neighbor  link
440                 down reason equal to value.
441
442

Examples

444       ethreport  can  generate hundreds of different reports. Commonly gener‐
445       ated reports include the following:   ethreport -o comps -d 3
446
447         ethreport -o errors -o slowlinks
448
449         ethreport -o nodes -F mgmtifaddr:0x00066a00a000447b
450
451         ethreport -o nodes -F ifaddr:0x001175019800447b:port:1
452
453         ethreport -o nodes -F ifaddr:0x001175019800447b
454
455         ethreport -o nodes -F 'node:duster-eth2'
456
457         ethreport -o nodes -F 'node:duster-eth2:port:1'
458
459         ethreport -o nodes -F 'nodepat:d*'
460
461         ethreport -o nodes -F 'nodepat:d*:port:1'
462
463         ethreport -o nodes -F 'nodedetpat:compute*'
464
465         ethreport -o nodes -F 'nodedetpat:compute*:port:1'
466
467         ethreport -o nodes -F nodetype:NIC
468
469         ethreport -o nodes -F nodetype:NIC:port:1
470
471         ethreport -o nodes -F ifid:1
472
473         ethreport -o nodes -F ifid:1:node
474
475         ethreport -o nodes -F ifid:1:port:2
476
477         ethreport -o nodes -F chassisid:0x001175019800447b
478
479         ethreport -o nodes -F chassisid:0x001175019800447b:port:1
480
481         ethreport -o extlinks -F rate:100g
482
483         ethreport -o extlinks -F portstate:up
484
485         ethreport -o extlinks -F portphysstate:operational
486
487         ethreport -o extlinks -F 'portdetpat:*mgmt*'
488
489         ethreport -o links -F mtucap:2048
490
491         ethreport -o snapshot > file
492
493         ethreport -o topology > topology.xml
494
495         ethreport -o errors -X file
496
497
498
499Copyright(C) 2020              Intel Corporation                  ethreport(8)