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                 -A/--allports
55                           Gets PortInfo for down switch ports.
56
57
58
59
60
61                 -c/--config file
62                           Specifies the error thresholds configuration  file.
63                           Default is /etc/eth-tools/ethmon.conf file.
64
65
66
67
68
69                 -E/--eth config_file
70                           Specifies  the  Intel  Ethernet configuration file.
71                           Default is /etc/eth-tools/mgt_config.xml file.
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       mgmtifaddr:value
112
113                 value is numeric port mgmtifaddr.
114
115
116       ifaddr:value
117
118                 value is numeric node ifaddr.
119
120
121       ifaddr:value1:port:value2
122
123                 value1 is numeric node ifaddr, value2 is port number.
124
125
126       chassisid:value
127
128                 value is numeric chassisid.
129
130
131       chassisid:value1:port:value2
132
133                 value1 is numeric chassisid, value2 is port number.
134
135
136       node:value
137
138                 value is node description (node name).
139
140
141       node:value1:port:value2
142
143                 value1  is  node description (node name), value2 is port num‐
144                 ber.
145
146
147       nodepat:value
148
149                 value is glob pattern for node description (node name).
150
151
152       nodepat:value1:port:value2
153
154                 value1 is the glob pattern for  the  node  description  (node
155                 name), value2 is port number.
156
157
158       nodedetpat:value
159
160                 value is glob pattern for node details.
161
162
163       nodedetpat:value1:port:value2
164
165                 value1  is  the  glob pattern for the node details, value2 is
166                 port number.
167
168
169       nodetype:value
170
171                 value is node type (SW or NIC).
172
173
174       nodetype:value1:port:value2
175
176                 value1 is node type (SW or NIC), value2 is port number.
177
178
179       rate:value
180
181                 value is string for rate (25g, 50g, 75g, 100g), omits  switch
182                 mgmt port 0.
183
184
185       portstate:value
186
187                 value is a string for state (up, down, testing, unknown, dor‐
188                 mant, notactive).
189
190
191       portphysstate:value
192
193                 value is a string for  PHYs  state  (other,  unknown,  opera‐
194                 tional, standby, shutdown, reset)
195
196
197       mtucap:value
198
199                 value  is  MTU  size  (maximum size 65535), omits switch mgmt
200                 port 0.
201
202
203       linkdetpat:value
204
205                 value is glob pattern for link details.
206
207
208       portdetpat:value
209
210                 value is glob pattern for port details.
211
212
213       nodepatfile:FILENAME
214
215                 Specifies the name of file with the list of nodepats or  node
216                 descriptions.
217
218
219       nodepairpatfile:FILENAME
220
221                 Specifies the name of file with the list of node pairs, sepa‐
222                 rated by a colon.
223
224
225       ldr
226
227                 Specifies the ports with  a  non-zero  link  down  reason  or
228                 neighbor link down reason.
229
230
231       ldr:value
232
233                 Specifies  the ports with a link down reason or neighbor link
234                 down reason equal to value.
235
236

Examples

238       # List all the bad links in the fabric:
239
240       ethextractbadlinks
241
242
243
244       # List all the bad links to a switch named "coresw1":
245
246       ethextractbadlinks -F "node:coresw1"
247
248
249
250       # List all the bad links to end-nodes:
251
252       ethextractbadlinks -F "nodetype:NIC"
253
254
255
256Copyright(C) 2020              Intel Corporation         ethextractbadlinks(8)