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                 -A/--allports
51                           Gets PortInfo for down switch ports.
52
53
54
55
56
57                 -c/--config file
58                           Specifies the error thresholds configuration  file.
59                           Default is /etc/eth-tools/ethmon.conf file.
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                 -L/--limit
74                           Limits operation to exact specified focus  with  -F
75                           for  port  error  counters  check (-o errors). Nor‐
76                           mally, the neighbor of each selected port  is  also
77                           checked. Does not affect other reports.
78
79
80
81
82
83                 -F/--focus point
84                           Specifies  the focus area for report. Used to limit
85                           scope of report. Refer to Point Syntax for details.
86
87
88
89

Point Syntax

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

Examples

259       ethextractstat2 topology_file
260
261       ethextractstat2 topology_file -c my_ethmon.conf
262
263
264
265Copyright(C) 2020              Intel Corporation            ethextractstat2(8)