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

NAME

7       ethextractperf
8
9
10
11       Provides  a report of all performance counters in a CVS format suitable
12       for importing into a spreadsheet or parsed by other scripts for further
13       analysis.  It  generates  a detailed ethreport component summary report
14       and pipes the result to ethxmlextract, extracting  element  values  for
15       NodeDesc,  Chassis  ID,  PortNum, and all the performance counters. Ex‐
16       traction is performed only from the  Systems  portion  of  the  report,
17       which  does not contain Neighbor information (the Neighbor portions are
18       suppressed).
19

Syntax

21       ethextractperf [ethreport  options]
22

Options

24       --help
25
26                 Produces full help text.
27
28
29       ethreport options
30
31                 The following options are passed to ethreport. This subset is
32                 considered  typical  and  useful for this command. By design,
33                 the tool ignores -o/--output report option.
34
35
36
37
38                 -X/--infile snapshot_input
39                           Generates a report using  the  data  in  the  snap‐
40                           shot_input file. snapshot_input must have been gen‐
41                           erated during a previous -o snapshot run.  '-'  may
42                           be used as the snapshot_input to specify stdin.
43
44
45
46
47
48                 -T/--topology topology_input
49                           Uses topology_input file to augment and verify fab‐
50                           ric information. When used, various reports can  be
51                           augmented with information not available electroni‐
52                           cally. '-' may be used to specify stdin.
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                 -F/--focus point
75                           Specifies the focus area for report. Used to  limit
76                           scope of report. Refer to Point Syntax for details.
77
78
79
80

Point Syntax

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

Example

295       ethextractperf
296
297
298
299Copyright(C) 2020-2021         Intel Corporation             ethextractperf(8)