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

NAME

7       ethextracterror
8
9
10
11       Produces  a  CSV  file listing all or some of the errors in the current
12       fabric. ethextracterror is a front end to the ethreport tool. The  out‐
13       put  from  this  tool  can  be imported into a spreadsheet or parsed by
14       other scripts.
15

Syntax

17       ethextracterror [ethreport  options]
18

Options

20       --help
21
22                 Produces full help text.
23
24
25       ethreport options
26
27                 The following options are passed to ethreport. This subset is
28                 considered  typical  and  useful for this command. By design,
29                 the tool ignores -o/--output report option.
30
31
32
33
34                 -X/--infile snapshot_input
35                           Generates a report using  the  data  in  the  snap‐
36                           shot_input file. snapshot_input must have been gen‐
37                           erated during a previous -o snapshot run.  '-'  may
38                           be used as the snapshot_input to specify stdin.
39
40
41
42
43
44                 -T/--topology topology_input
45                           Uses topology_input file to augment and verify fab‐
46                           ric information. When used, various reports can  be
47                           augmented with information not available electroni‐
48                           cally. '-' may be used to specify stdin.
49
50
51
52
53
54                 -E/--eth config_file
55                           Specifies the Intel  Ethernet  configuration  file.
56                           Default is /etc/eth-tools/mgt_config.xml file.
57
58
59
60
61
62                 -p plane  Name  of  the  enabled  plane defined in Mgt config
63                           file, default is the first enabled plane.
64
65
66
67
68
69                 -F/--focus point
70                           Specifies the focus area for report. Used to  limit
71                           scope of report. Refer to Point Syntax for details.
72
73
74
75

Point Syntax

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

Examples

256       # List all the link errors in the fabric:
257
258       ethextracterror
259
260
261
262       # List all the link errors related to a switch named "coresw1":
263
264       ethextracterror -F "node:coresw1"
265
266
267
268       # List all the link errors for end-nodes:
269
270       ethextracterror -F "nodetype:NIC"
271
272
273
274Copyright(C) 2020-2021         Intel Corporation            ethextracterror(8)