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] 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: snapshotSUFFIX.xml.
57
58
59       -c file
60
61                 Specifies the error thresholds configuration  file.  The  de‐
62                 fault is /etc/eth-tools/ethmon.si.conf.
63
64
65       -E file
66
67                 Ethernet  Mgt  configuration  file.  The default is /etc/eth-
68                 tools/mgt_config.xml.
69
70
71       -p planes
72
73                 Fabric planes separated by space. The default  is  the  first
74                 enabled  plane  defined  in config file. Value 'ALL' will use
75                 all enabled planes.
76
77
78       reports
79
80                 Supports the following reports:
81
82
83
84                 errors    Specifies link error analysis.
85
86
87
88
89
90                 slowlinks Specifies links running slower than expected.
91
92
93
94
95
96                 misconfiglinks
97                           Specifies links configured to run slower than  sup‐
98                           ported.
99
100
101
102
103
104                 misconnlinks
105                           Specifies links connected with mismatched speed po‐
106                           tential.
107
108
109
110
111
112                 all       Includes all  reports  above.  (errors,  slowlinks,
113                           misconfiglinks, and misconnlinks)
114
115
116
117
118
119                 verifylinks
120                           Verifies links against topology input.
121
122
123
124
125
126                 verifyextlinks
127                           Verifies   links  against  topology  input.  Limits
128                           analysis to links external to systems.
129
130
131
132
133
134                 verifyniclinks
135                           Verifies  links  against  topology  input.   Limits
136                           analysis to NIC links.
137
138
139
140
141
142                 verifyislinks
143                           Verifies   links  against  topology  input.  Limits
144                           analysis to inter-switch links.
145
146
147
148
149
150                 verifyextislinks
151                           Verifies  links  against  topology  input.   Limits
152                           analysis to inter-switch links external to systems.
153
154
155
156
157
158                 verifynics
159                           Verifies NICs against topology input.
160
161
162
163
164
165                 verifysws Verifies switches against topology input.
166
167
168
169
170
171                 verifynodes
172                           Verifies NICs and switches against topology input.
173
174
175
176
177
178                 verifyall Verifies links, NICs, and switches against topology
179                           input.
180
181
182
183
184       A punchlist  of  bad  links  is  also  appended  to  the  file:  FF_RE‐
185       SULT_DIR/punchlist.csv
186

Examples

188       ethlinkanalysis errors
189
190       ethlinkanalysis slowlinks
191
192
193
194Copyright(C) 2020-2021         Intel Corporation            ethlinkanalysis(8)