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

NAME

7       ethextractbadlinks
8
9
10
11       Produces a CSV file listing all or some of the links that exceed ethre‐
12       port -o error thresholds. ethextractbadlinks is  a  front  end  to  the
13       ethreport  tool.  The  output  from  this  tool  can be imported into a
14       spreadsheet or parsed by other scripts.
15

Syntax

17       ethextractbadlinks [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                 -c/--config file
55                           Specifies the error thresholds configuration  file.
56                           Default is /etc/eth-tools/ethmon.conf file.
57
58
59
60
61
62                 -E/--eth config_file
63                           Specifies  the  Intel  Ethernet configuration file.
64                           Default is /etc/eth-tools/mgt_config.xml file.
65
66
67
68
69
70                 -p plane  Name of the enabled plane  defined  in  Mgt  config
71                           file, default is the first enabled plane.
72
73
74
75
76
77                 -L/--limit
78                           Limits  operation  to exact specified focus with -F
79                           for port error counters  check  (-o  errors).  Nor‐
80                           mally,  the  neighbor of each selected port is also
81                           checked. Does not affect other reports.
82
83
84
85
86
87                 -F/--focus point
88                           Specifies the focus area for report. Used to  limit
89                           the  scope of report. Refer to Point Syntax for de‐
90                           tails.
91
92
93
94

Point Syntax

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

Examples

275       # List all the bad links in the fabric:
276
277       ethextractbadlinks
278
279
280
281       # List all the bad links to a switch named "coresw1":
282
283       ethextractbadlinks -F "node:coresw1"
284
285
286
287       # List all the bad links to end-nodes:
288
289       ethextractbadlinks -F "nodetype:NIC"
290
291
292
293Copyright(C) 2020-2022         Intel Corporation         ethextractbadlinks(8)