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

NAME

7       ethlinkanalysis
8
9
10
11       Encapsulates  the  capabilities  for  link analysis. Additionally, this
12       tool includes cable and fabric topology verification capabilities. This
13       tool  is built on top of ethreport (and its analysis capabilities), and
14       accepts the same syntax for input topology and snapshot files.
15
16       In addition to being able to run assorted ethreport link  analysis  re‐
17       ports,  and generate human-readable output, this tool additionally ana‐
18       lyzes the results and appends a concise summary of issues found to  the
19       FF_RESULT_DIR/punchlist.csv file.
20

Syntax

22       ethlinkanalysis  [-U]  [-T   topology_inputs]  [-X  snapshot_input] [-x
23       snapshot_suffix]
24
25       [-c  file] [-E  file] [-p  planes] [-f  host_files]  reports ...
26

Options

28       --help
29
30                 Produces full help text.
31
32
33       -U
34
35                 Omits unexpected devices and links  in  punchlist  file  from
36                 verify reports.
37
38
39       -T topology_inputs
40
41                 Specifies  the  name of topology input filenames separated by
42                 space. See ethreport for more information  on  topology_input
43                 files.
44
45
46       -X snapshot_input
47
48                 Performs  analysis  using  data  in   snapshot_input.   snap‐
49                 shot_input must have been generated via a previous  ethreport
50                 -o snapshot run.
51
52
53       -x snapshot_suffix
54
55                 Creates  a  snapshot  file.  The  files are created in FF_RE‐
56                 SULT_DIR   with   names    of    the    form:    snapshotSUF‐
57                 FIX.<plane_name>.xml.
58
59
60       -c file
61
62                 Specifies  the  error  thresholds configuration file. The de‐
63                 fault is /etc/eth-tools/ethmon.si.conf.
64
65
66       -E file
67
68                 Ethernet Mgt configuration file.  The  default  is  /etc/eth-
69                 tools/mgt_config.xml.
70
71
72       -p planes
73
74                 Fabric  planes  separated  by space. The default is the first
75                 enabled plane defined in config file. Value  'ALL'  will  use
76                 all enabled planes
77
78
79       -f host_files
80
81                 Hosts  files  separated by space. It overrides the HostsFiles
82                 defined in Mgt config  file  for  the  corresponding  planes.
83                 Value  'DEFAULT'  will use the HostFile defined in Mgt config
84                 file for the corresponding plane
85
86
87       reports
88
89                 Supports the following reports:
90
91
92
93                 errors    Specifies link error analysis.
94
95
96
97
98
99                 slowlinks Specifies links running slower than expected.
100
101
102
103
104
105                 misconfiglinks
106                           Specifies links configured to run slower than  sup‐
107                           ported.
108
109
110
111
112
113                 misconnlinks
114                           Specifies links connected with mismatched speed po‐
115                           tential.
116
117
118
119
120
121                 all       Includes all  reports  above.  (errors,  slowlinks,
122                           misconfiglinks, and misconnlinks)
123
124
125
126
127
128                 verifylinks
129                           Verifies links against topology input.
130
131
132
133
134
135                 verifyextlinks
136                           Verifies   links  against  topology  input.  Limits
137                           analysis to links external to systems.
138
139
140
141
142
143                 verifyniclinks
144                           Verifies  links  against  topology  input.   Limits
145                           analysis to NIC links.
146
147
148
149
150
151                 verifyislinks
152                           Verifies   links  against  topology  input.  Limits
153                           analysis to inter-switch links.
154
155
156
157
158
159                 verifyextislinks
160                           Verifies  links  against  topology  input.   Limits
161                           analysis to inter-switch links external to systems.
162
163
164
165
166
167                 verifynics
168                           Verifies NICs against topology input.
169
170
171
172
173
174                 verifysws Verifies switches against topology input.
175
176
177
178
179
180                 verifynodes
181                           Verifies NICs and switches against topology input.
182
183
184
185
186
187                 verifyall Verifies links, NICs, and switches against topology
188                           input.
189
190
191
192
193       A punchlist  of  bad  links  is  also  appended  to  the  file:  FF_RE‐
194       SULT_DIR/punchlist.csv
195

Examples

197       ethlinkanalysis errors
198
199       ethlinkanalysis slowlinks
200
201       ethlinkanalysis -p 'p1 p2' -f 'hosts1 DEFAULT' errors
202
203
204
205Copyright(C) 2020-2022         Intel Corporation            ethlinkanalysis(8)