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                 -A/--allports
59                           Gets PortInfo for down switch ports.
60
61
62
63
64
65                 -E/--eth config_file
66                           Specifies the Intel  Ethernet  configuration  file.
67                           Default is /etc/eth-tools/mgt_config.xml file.
68
69
70
71
72
73                 -F/--focus point
74                           Specifies  the focus area for report. Used to limit
75                           scope of report. Refer to Point Syntax for details.
76
77
78
79

Point Syntax

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

Example

257       ethextractperf
258
259
260
261Copyright(C) 2020              Intel Corporation             ethextractperf(8)