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

NAME

7       ethfabricanalysis
8
9
10
11       Performs analysis of the fabric.
12

Syntax

14       ethfabricanalysis  [-b|-e]  [-s]  [-d   dir]  [-c   file] [-E file] [-p
15       planes] [-T  topology_inputs]
16

Options

18       --help
19
20                 Produces full help text.
21
22       -b
23
24                 Specifies the baseline mode. Default is compare/check mode.
25
26       -e
27
28                 Evaluates health only. Default is compare/check mode.
29
30       -s
31
32                 Saves history of failures (errors/differences).
33
34       -d dir
35
36                 Specifies the top-level directory  for  saving  baseline  and
37                 history   of  failed  checks.  Default  is  /var/usr/lib/eth-
38                 tools/analysis
39
40       -c file
41
42                 Specifies  the  error  thresholds  config   file.Default   is
43                 /etc/eth-tools/ethmon.conf
44
45       -E file
46
47                 Specifies  Ethernet  Mgt  configuration  file. The default is
48                 /etc/eth-tools/mgt_config.xml.
49
50
51       -p planes
52
53                 Specifies Fabric planes separated by space.  The  default  is
54                 the  first  enabled plane defined in config file. Value 'ALL'
55                 will use all enabled planes.
56
57
58       -T topology_inputs
59
60                 Specifies the name of topology input filenames  separated  by
61                 space. See Details and ethreport for more information.
62

Example

64       ethfabricanalysis
65
66       The fabric analysis tool checks the following:
67
68       •      Fabric  links  (both internal to switch chassis and external ca‐
69              bles)
70
71       •      Fabric components (nodes, links, systems, and  their  configura‐
72              tion)
73
74       •      Fabric error counters and link speed mismatches
75
76       NOTE:  The comparison includes components on the fabric. Therefore, op‐
77       erations such as shutting down a server cause the server to  no  longer
78       appear  on  the fabric and are flagged as a fabric change or failure by
79       ethfabricanalysis.
80
81

Environment Variables

83       The following environment variables are also used by this command:
84
85       FF_ANALYSIS_DIR
86
87                 Top-level directory for baselines and failed health checks.
88

Details

90       You can specify the topology_input file to be used with one of the fol‐
91       lowing methods:
92
93       •      On the command line using the -T option.
94
95       •      Using the TopologyFile specified in Ethernet Mgt config file.
96
97       If the specified file does not exist, no topology_input file is used.
98
99       For more information on topology_input, refer to ethreport
100
101       By  default,  the error analysis includes counters and slow links (that
102       is, links running below enabled speeds). You can change this using  the
103       FF_FABRIC_HEALTH  configuration  parameter  in ethfastfabric.conf. This
104       parameter specifies the ethreport options and reports to  be  used  for
105       the health analysis.
106
107       When  a  topology_input  file  is used, it can also be useful to extend
108       FF_FABRIC_HEALTH to include fabric topology verification  options  such
109       as -o verifylinks.
110
111       The  thresholds  for  counter  analysis  default to /etc/eth-tools/eth‐
112       mon.conf. However, you can specify an alternate configuration file  for
113       thresholds  using  the  -c  option. The ethmon.si.conf file can also be
114       used to check for any non-zero values for signal integrity  (SI)  coun‐
115       ters.
116
117       All  files  generated  by  ethfabricanalysis start with fabric in their
118       file name.
119
120       The ethfabricanalysis tool generates files such as the following within
121       FF_ANALYSIS_DIR :
122
123       Health Check
124
125
126       •      latest/fabric.<plane_name>.errors stdout of ethreport for errors
127              encountered during fabric error analysis.
128
129
130       •      latest/fabric.<plane_name>.errors.stderr  stderr  of   ethreport
131              during fabric error analysis.
132
133
134       Baseline
135
136
137       During  a  baseline  run,  the  following  files  are  also  created in
138       FF_ANALYSIS_DIR/latest.
139
140       •      baseline/fabric.<plane_name>.snapshot.xml ethreport snapshot  of
141              complete fabric components and configuration.
142
143
144       •      baseline/fabric.<plane_name>.comps  ethreport  summary of fabric
145              components and basic configuration.
146
147
148       •      baseline/fabric.<plane_name>.links ethreport summary of internal
149              and external links.
150
151
152       Full Analysis
153
154
155       •      latest/fabric.<plane_name>.snapshot.xml  ethreport  snapshot  of
156              complete fabric components and configuration.
157
158
159       •      latest/fabric.<plane_name>.snapshot.stderr stderr  of  ethreport
160              during snapshot.
161
162
163       •      latest/fabric.<plane_name>.errors stdout of ethreport for errors
164              encountered during fabric error analysis.
165
166
167       •      latest/fabric.<plane_name>.errors.stderr  stderr  of   ethreport
168              during fabric error analysis.
169
170
171       •      latest/fabric.<plane_name>.comps  stdout of ethreport for fabric
172              components and configuration.
173
174
175       •      latest/fabric.<plane_name>.comps.stderr stderr of ethreport  for
176              fabric components.
177
178
179       •      latest/fabric.<plane_name>.comps.diff  diff of baseline and lat‐
180              est fabric components.
181
182
183       •      latest/fabric.<plane_name>.links stdout of ethreport summary  of
184              internal and external links.
185
186
187       •      latest/fabric.<plane_name>.links.stderr stderr of ethreport sum‐
188              mary of internal and external links.
189
190
191       •      latest/fabric.<plane_name>.links.diff diff of baseline and  lat‐
192              est fabric internal and external links.
193
194
195       •      latest/fabric.<plane_name>.links.changes.stderr stderr of ethre‐
196              port comparison of links.
197
198
199       •      latest/fabric.<plane_name>.links.changes ethreport comparison of
200              links  against  baseline.  This is typically easier to read than
201              the links.diff file and contains the same information.
202
203
204       •      latest/fabric.<plane_name>.comps.changes.stderr stderr of ethre‐
205              port comparison of components.
206
207
208       •      latest/fabric.<plane_name>.comps.changes ethreport comparison of
209              components against baseline. This is typically  easier  to  read
210              than the comps.diff file and contains the same information.
211
212
213       The  .diff  and  .changes files are only created if differences are de‐
214       tected.
215
216       If the -s option is used and failures are detected,  files  related  to
217       the  checks  that  failed are also copied to the time-stamped directory
218       name under FF_ANALYSIS_DIR.
219

Fabric Items Checked Against the Baseline

221       Based on ethreport -o links:
222
223       •      Unconnected/down/missing cables
224
225       •      Added/moved cables
226
227       •      Changes in link width and speed
228
229       •      Changes to IfAddr in fabric (replacement of NIC or Switch  hard‐
230              ware)
231
232       •      Adding/Removing  Nodes  [NIC,  Virtual  NICs,  Virtual Switches,
233              Physical Switches,  Physical  Switch  internal  switching  cards
234              (leaf/spine)]
235
236       •      Changes to server or switch names
237
238       Based on ethreport -o comps:
239
240       •      Overlap with items from links report
241
242       •      Changes in port MTU
243
244       •      Changes in port speed/width enabled or supported
245
246       •      Changes  in NIC or switch device IDs/revisions/VendorID (for ex‐
247              ample, ASIC hardware changes)
248
249       •      Changes in port Capability mask (which  features/agents  run  on
250              port/server)
251
252       •      Changes to IOUs/IOCs/IOC Services provided
253
254
255

Fabric Items Also Checked During Health Check

257       Based on ethreport -s -o errors -o slowlinks:
258
259       •      error  counters  on  all  Intel(R)  Ethernet  Fabric ports (NIC,
260              switch external and switch  internal)  checked  against  config‐
261              urable thresholds.
262
263       •      Typically identifies potential fabric errors, such as symbol er‐
264              rors.
265
266       •      May also identify transient congestion, depending on  the  coun‐
267              ters that are monitored.
268
269       •      Link active speed/width as compared to Enabled speed.
270
271       •      Identifies  links  whose  active  speed/width  is < min (enabled
272              speed/width on each side of link).
273
274       •      This typically reflects bad cables or bad ports or poor  connec‐
275              tions.
276
277       •      Side effect is the verification of fabric health.
278
279
280
281Copyright(C) 2020              Intel Corporation          ethfabricanalysis(8)