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                 -A/--allports
62                           Gets PortInfo for down switch ports.
63
64
65
66
67
68                 -c/--config file
69                           Specifies  the error thresholds configuration file.
70                           Default is /etc/eth-tools/ethmon.conf file.
71
72
73
74
75
76                 -E/--eth config_file
77                           Specifies the Intel  Ethernet  configuration  file.
78                           Default is /etc/eth-tools/mgt_config.xml file.
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       mgmtifaddr:value
118
119                 value is numeric port mgmtifaddr.
120
121
122       ifaddr:value
123
124                 value is numeric node ifaddr.
125
126
127       ifaddr:value1:port:value2
128
129                 value1 is numeric node ifaddr, value2 is port number.
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       node:value
143
144                 value is node description (node name).
145
146
147       node:value1:port:value2
148
149                 value1  is  node description (node name), value2 is port num‐
150                 ber.
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       nodedetpat:value
165
166                 value is glob pattern for node details.
167
168
169       nodedetpat:value1:port:value2
170
171                 value1  is  the  glob pattern for the node details, value2 is
172                 port number.
173
174
175       nodetype:value
176
177                 value is node type (SW or NIC).
178
179
180       nodetype:value1:port:value2
181
182                 value1 is node type (SW or NIC), value2 is port number.
183
184
185       rate:value
186
187                 value is string for rate (25g, 50g, 75g, 100g), omits  switch
188                 mgmt port 0.
189
190
191       portstate:value
192
193                 value is a string for state (up, down, testing, unknown, dor‐
194                 mant, notactive).
195
196
197       portphysstate:value
198
199                 value is a string for  PHYs  state  (other,  unknown,  opera‐
200                 tional, standby, shutdown, reset)
201
202
203       mtucap:value
204
205                 value  is  MTU  size  (maximum size 65535), omits switch mgmt
206                 port 0.
207
208
209       linkdetpat:value
210
211                 value is glob pattern for link details.
212
213
214       portdetpat:value
215
216                 value is glob pattern for port details.
217
218
219       nodepatfile:FILENAME
220
221                 Specifies the name of file with the list of nodepats or  node
222                 descriptions.
223
224
225       nodepairpatfile:FILENAME
226
227                 Specifies the name of file with the list of node pairs, sepa‐
228                 rated by a colon.
229
230
231       ldr
232
233                 Specifies the ports with  a  non-zero  link  down  reason  or
234                 neighbor link down reason.
235
236
237       ldr:value
238
239                 Specifies  the ports with a link down reason or neighbor link
240                 down reason equal to value.
241
242
243
244       The portion of the script that calls ethreport and  ethxmlextract  fol‐
245       lows:
246
247       ethreport -x -Q -d 10 -o errors -T "$@" | ethxmlextract -H -d \; \
248
249       -e Link:id -e Rate -e LinkDetails -e CableLength \
250
251       -e CableLabel -e CableDetails -e Port.NodeDesc -e Port.PortNum
252
253
254

Examples

256       ethextractstat topology_file
257
258       ethextractstat topology_file -c my_ethmon.conf
259
260
261
262Copyright(C) 2020              Intel Corporation             ethextractstat(8)