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

NAME

7       ethextractstat2
8
9
10
11       Performs  an error analysis of a fabric and provides augmented informa‐
12       tion from a topology_file including all error counters. The  output  is
13       in  a CSV format suitable for importing into a spreadsheet or parsed by
14       other scripts. ethextractstat2 is a front  end  to  the  ethreport  and
15       ethxmlextract tools.
16

Syntax

18       ethextractstat2 topology_file [ethreport  options]
19

Options

21       --help
22
23                 Produces full help text.
24
25
26       topology_file
27
28                 Specifies topology_file to use.
29
30
31       ethreport options
32
33                 The following options are passed to ethreport. This subset is
34                 considered typical and useful for this  command.  By  design,
35                 the tool ignores -o/--output report option.
36
37
38
39
40                 -X/--infile snapshot_input
41                           Generates  a  report  using  the  data in the snap‐
42                           shot_input file. snapshot_input must have been gen‐
43                           erated  during  a previous -o snapshot run. '-' may
44                           be used as the snapshot_input to specify stdin.
45
46
47
48
49
50                 -c/--config file
51                           Specifies the error thresholds configuration  file.
52                           Default is /etc/eth-tools/ethmon.conf file.
53
54
55
56
57
58                 -E/--eth config_file
59                           Specifies  the  Intel  Ethernet configuration file.
60                           Default is /etc/eth-tools/mgt_config.xml file.
61
62
63
64
65
66                 -p plane
67                           Name of the enabled plane  defined  in  Mgt  config
68                           file, default is the first enabled plane.
69
70
71
72
73
74                 -L/--limit
75                           Limits  operation  to exact specified focus with -F
76                           for port error counters  check  (-o  errors).  Nor‐
77                           mally,  the  neighbor of each selected port is also
78                           checked. Does not affect other reports.
79
80
81
82
83
84                 -F/--focus point
85                           Specifies the focus area for report. Used to  limit
86                           scope of report. Refer to Point Syntax for details.
87
88
89
90

Point Syntax

92       ifid:value
93
94                 value is numeric ifid.
95
96
97       ifid:value:node
98
99                 value is numeric ifid, selects node with given ifid.
100
101
102       ifid:value:port:value2
103
104                 value is numeric ifid of node, value2 is port number.
105
106
107       ifid:value:portid:value2
108
109                 value is numeric ifid of node, value2 is port id.
110
111
112       mgmtifaddr:value
113
114                 value is numeric port mgmtifaddr.
115
116
117       ifaddr:value
118
119                 value is numeric node ifaddr.
120
121
122       ifaddr:value1:port:value2
123
124                 value1 is numeric node ifaddr, value2 is port number.
125
126
127       ifaddr:value1:portid:value2
128
129                 value1 is numeric node ifaddr, value2 is port id.
130
131
132       chassisid:value
133
134                 value is numeric chassisid.
135
136
137       chassisid:value1:port:value2
138
139                 value1 is numeric chassisid, value2 is port number.
140
141
142       chassisid:value1:portid:value2
143
144                 value1 is numeric chassisid, value2 is port id.
145
146
147       node:value
148
149                 value is node description (node name).
150
151
152       node:value1:port:value2
153
154                 value1  is  node description (node name), value2 is port num‐
155                 ber.
156
157
158       node:value1:portid:value2
159
160                 value1 is node description (node name), value2 is port id.
161
162
163       nodepat:value
164
165                 value is glob pattern for node description (node name).
166
167
168       nodepat:value1:port:value2
169
170                 value1 is the glob pattern for  the  node  description  (node
171                 name), value2 is port number.
172
173
174       nodepat:value1:portid:value2
175
176                 value1  is  the  glob  pattern for the node description (node
177                 name), value2 is port id.
178
179
180       nodedetpat:value
181
182                 value is glob pattern for node details.
183
184
185       nodedetpat:value1:port:value2
186
187                 value1 is the glob pattern for the node  details,  value2  is
188                 port number.
189
190
191       nodedetpat:value1:portid:value2
192
193                 value1  is  the  glob pattern for the node details, value2 is
194                 port id.
195
196
197       nodetype:value
198
199                 value is node type (SW or NIC).
200
201
202       nodetype:value1:port:value2
203
204                 value1 is node type (SW or NIC), value2 is port number.
205
206
207       nodetype:value1:portid:value2
208
209                 value1 is node type (SW or NIC), value2 is port id.
210
211
212       rate:value
213
214                 value is string for rate (25g, 50g, 75g, 100g), omits  switch
215                 mgmt port 0.
216
217
218       portstate:value
219
220                 value is a string for state (up, down, testing, unknown, dor‐
221                 mant, notactive).
222
223
224       portphysstate:value
225
226                 value is a string for  PHYs  state  (other,  unknown,  opera‐
227                 tional, standby, shutdown, reset)
228
229
230       mtucap:value
231
232                 value  is  MTU  size  (maximum size 65535), omits switch mgmt
233                 port 0.
234
235
236       linkdetpat:value
237
238                 value is glob pattern for link details.
239
240
241       portdetpat:value
242
243                 value is glob pattern for port details.
244
245
246       nodepatfile:FILENAME
247
248                 Specifies the name of file with the list of nodepats or  node
249                 descriptions.
250
251
252       nodepairpatfile:FILENAME
253
254                 Specifies the name of file with the list of node pairs, sepa‐
255                 rated by a colon.
256
257
258       ldr
259
260                 Specifies the ports with  a  non-zero  link  down  reason  or
261                 neighbor link down reason.
262
263
264       ldr:value
265
266                 Specifies  the ports with a link down reason or neighbor link
267                 down reason equal to value.
268
269
270
271       The portion of the script that calls ethreport and  ethxmlextract  fol‐
272       lows:
273
274       ethreport -x -d 10 -s -o errors -T $@ | ethxmlextract -d \;
275
276       -e Rate -e MTU -e Internal -e LinkDetails -e CableLength -e CableLabel
277
278       -e CableDetails -e Port.NodeGUID -e Port.PortGUID -e Port.PortNum
279
280       -e Port.PortType -e Port.NodeDesc -e Port.PortDetails
281
282       -e PortXmitData.Value -e PortXmitPkts.Value -e PortRcvData.Value
283
284       -e PortRcvPkts.Value -e SymbolErrors.Value -e LinkErrorRecovery.Value
285
286       -e LinkDowned.Value -e PortRcvErrors.Value
287
288       -e PortRcvRemotePhysicalErrors.Value -e PortRcvSwitchRelayErrors.Value
289
290       -e PortXmitConstraintErrors.Value -e PortRcvConstraintErrors.Value
291
292       -e LocalLinkIntegrityErrors.Value -e ExcessiveBufferOverrunErrors.Value
293
294
295

Examples

297       ethextractstat2 topology_file
298
299       ethextractstat2 topology_file -c my_ethmon.conf
300
301
302
303Copyright(C) 2020-2021         Intel Corporation            ethextractstat2(8)
Impressum