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

Options

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

Report Types

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

Point Syntax

332       ifid:value
333
334                 value is numeric ifid.
335
336
337       ifid:value:node
338
339                 value is numeric ifid, selects node with given ifid.
340
341
342       ifid:value:port:value2
343
344                 value is numeric ifid of node, value2 is port number.
345
346
347       ifid:value:portid:value2
348
349                 value is numeric ifid of node, value2 is port id.
350
351
352       mgmtifaddr:value
353
354                 value is numeric port mgmtifaddr.
355
356
357       ifaddr:value
358
359                 value is numeric node ifaddr.
360
361
362       ifaddr:value1:port:value2
363
364                 value1 is numeric node ifaddr, value2 is port number.
365
366
367       ifaddr:value1:portid:value2
368
369                 value1 is numeric node ifaddr, value2 is port id.
370
371
372       chassisid:value
373
374                 value is numeric chassisid.
375
376
377       chassisid:value1:port:value2
378
379                 value1 is numeric chassisid, value2 is port number.
380
381
382       chassisid:value1:portid:value2
383
384                 value1 is numeric chassisid, value2 is port id.
385
386
387       node:value
388
389                 value is node description (node name).
390
391
392       node:value1:port:value2
393
394                 value1  is  node description (node name), value2 is port num‐
395                 ber.
396
397
398       node:value1:portid:value2
399
400                 value1 is node description (node name), value2 is port id.
401
402
403       nodepat:value
404
405                 value is glob pattern for node description (node name).
406
407
408       nodepat:value1:port:value2
409
410                 value1 is the glob pattern for  the  node  description  (node
411                 name), value2 is port number.
412
413
414       nodepat:value1:portid:value2
415
416                 value1  is  the  glob  pattern for the node description (node
417                 name), value2 is port id.
418
419
420       nodedetpat:value
421
422                 value is glob pattern for node details.
423
424
425       nodedetpat:value1:port:value2
426
427                 value1 is the glob pattern for the node  details,  value2  is
428                 port number.
429
430
431       nodedetpat:value1:portid:value2
432
433                 value1  is  the  glob pattern for the node details, value2 is
434                 port id.
435
436
437       nodetype:value
438
439                 value is node type (SW or NIC).
440
441
442       nodetype:value1:port:value2
443
444                 value1 is node type (SW or NIC), value2 is port number.
445
446
447       nodetype:value1:portid:value2
448
449                 value1 is node type (SW or NIC), value2 is port id.
450
451
452       rate:value
453
454                 value is string for rate (25g, 50g, 75g, 100g), omits  switch
455                 mgmt port 0.
456
457
458       portstate:value
459
460                 value is a string for state (up, down, testing, unknown, dor‐
461                 mant, notactive).
462
463
464       portphysstate:value
465
466                 value is a string for  PHYs  state  (other,  unknown,  opera‐
467                 tional, standby, shutdown, reset)
468
469
470       mtucap:value
471
472                 value  is  MTU  size  (maximum size 65535), omits switch mgmt
473                 port 0.
474
475
476       linkdetpat:value
477
478                 value is glob pattern for link details.
479
480
481       portdetpat:value
482
483                 value is glob pattern for port details.
484
485
486       nodepatfile:FILENAME
487
488                 Specifies the name of file with the list of nodepats or  node
489                 descriptions.
490
491
492       nodepairpatfile:FILENAME
493
494                 Specifies the name of file with the list of node pairs, sepa‐
495                 rated by a colon.
496
497
498       ldr
499
500                 Specifies the ports with  a  non-zero  link  down  reason  or
501                 neighbor link down reason.
502
503
504       ldr:value
505
506                 Specifies  the ports with a link down reason or neighbor link
507                 down reason equal to value.
508
509

Examples

511       ethreport can generate hundreds of different reports.  Commonly  gener‐
512       ated reports include the following:   ethreport -o comps -d 3
513
514         ethreport -o errors -o slowlinks
515
516         ethreport -o nodes -F mgmtifaddr:0x00066a00a000447b
517
518         ethreport -o nodes -F ifaddr:0x001175019800447b:port:1
519
520         ethreport -o nodes -F ifaddr:0x001175019800447b
521
522         ethreport -o nodes -F 'node:duster-eth2'
523
524         ethreport -o nodes -F 'node:duster-eth2:port:1'
525
526         ethreport -o nodes -F 'nodepat:d*'
527
528         ethreport -o nodes -F 'nodepat:d*:port:1'
529
530         ethreport -o nodes -F 'nodedetpat:compute*'
531
532         ethreport -o nodes -F 'nodedetpat:compute*:port:1'
533
534         ethreport -o nodes -F nodetype:NIC
535
536         ethreport -o nodes -F nodetype:NIC:port:1
537
538         ethreport -o nodes -F ifid:1
539
540         ethreport -o nodes -F ifid:1:node
541
542         ethreport -o nodes -F ifid:1:port:2
543
544         ethreport -o nodes -F chassisid:0x001175019800447b
545
546         ethreport -o nodes -F chassisid:0x001175019800447b:port:1
547
548         ethreport -o extlinks -F rate:100g
549
550         ethreport -o extlinks -F portstate:up
551
552         ethreport -o extlinks -F portphysstate:operational
553
554         ethreport -o extlinks -F 'portdetpat:*mgmt*'
555
556         ethreport -o links -F mtucap:2048
557
558         ethreport -o snapshot > file
559
560         ethreport -o topology > topology.xml
561
562         ethreport -o errors -X file
563
564
565
566Copyright(C) 2020-2022         Intel Corporation                  ethreport(8)