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

NAME

7       ethextractstat
8
9
10
11       Performs  an error analysis of a fabric and provides augmented informa‐
12       tion from a topology_file. The report  provides  cable  information  as
13       well as symbol error counts.
14
15       ethextractstat  generates  a detailed ethreport errors report that also
16       has a topology file (see ethreport for more information about  topology
17       files).  The report is piped to ethxmlextract which extracts values for
18       Link, Cable and Port. (The port element names  are  context-sensitive.)
19       Note  that ethxmlextract generates two extraction records for each link
20       (one for each port on the link); therefore, ethextractstat  merges  the
21       two  records  into a single record and removes redundant link and cable
22       information.
23
24       ethextractstat contains a while read loop that reads the  CSV  line-by-
25       line, uses cut to remove redundant information, and outputs the data on
26       a common line.
27

Syntax

29       ethextractstat topology_file [ethreport  options]
30

Options

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

Point Syntax

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

Examples

293       ethextractstat topology_file
294
295       ethextractstat topology_file -c my_ethmon.conf
296
297
298
299Copyright(C) 2020-2022         Intel Corporation             ethextractstat(8)