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]
18                [-N] [-x] [-X  snapshot_input] [-T  topology_input]
19       [-c  file]
20                [-L] [-F  point] [-Q] [-E  file] [-p plane]
21

Options

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

Report Types

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

Point Syntax

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

Examples

479       ethreport can generate hundreds of different reports.  Commonly  gener‐
480       ated reports include the following:   ethreport -o comps -d 3
481
482         ethreport -o errors -o slowlinks
483
484         ethreport -o nodes -F mgmtifaddr:0x00066a00a000447b
485
486         ethreport -o nodes -F ifaddr:0x001175019800447b:port:1
487
488         ethreport -o nodes -F ifaddr:0x001175019800447b
489
490         ethreport -o nodes -F 'node:duster-eth2'
491
492         ethreport -o nodes -F 'node:duster-eth2:port:1'
493
494         ethreport -o nodes -F 'nodepat:d*'
495
496         ethreport -o nodes -F 'nodepat:d*:port:1'
497
498         ethreport -o nodes -F 'nodedetpat:compute*'
499
500         ethreport -o nodes -F 'nodedetpat:compute*:port:1'
501
502         ethreport -o nodes -F nodetype:NIC
503
504         ethreport -o nodes -F nodetype:NIC:port:1
505
506         ethreport -o nodes -F ifid:1
507
508         ethreport -o nodes -F ifid:1:node
509
510         ethreport -o nodes -F ifid:1:port:2
511
512         ethreport -o nodes -F chassisid:0x001175019800447b
513
514         ethreport -o nodes -F chassisid:0x001175019800447b:port:1
515
516         ethreport -o extlinks -F rate:100g
517
518         ethreport -o extlinks -F portstate:up
519
520         ethreport -o extlinks -F portphysstate:operational
521
522         ethreport -o extlinks -F 'portdetpat:*mgmt*'
523
524         ethreport -o links -F mtucap:2048
525
526         ethreport -o snapshot > file
527
528         ethreport -o topology > topology.xml
529
530         ethreport -o errors -X file
531
532
533
534Copyright(C) 2020-2021         Intel Corporation                  ethreport(8)