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

NAME

7       ethextractmissinglinks
8
9
10
11       Produces  a  CSV  file  listing all or some of the links in the fabric.
12       ethextractmissinglinks is a front end to the ethreport tool that gener‐
13       ates  a report listing all or some of the links that are present in the
14       supplied topology file, but are missing in the fabric. The output  from
15       this  tool  can  be  imported  into  a  spreadsheet  or parsed by other
16       scripts.
17

Syntax

19       ethextractmissinglinks [-T topology_input] [-o report]
20       [ethreport  options]
21

Options

23       --help
24
25                 Produces full help text.
26
27
28       -T/--topology topology_input
29
30                 Specifies the topology file to  verify  against.  Default  is
31                 /etc/eth-tools/topology.0:0.xml
32
33
34       -o/--output report
35
36                 Specifies  the  report type for output. Refer to Report Types
37                 for details.
38
39
40       ethreport options
41
42                 The following options are passed to ethreport. This subset is
43                 considered typical and useful for this command.
44
45
46
47
48                 -X/--infile snapshot_input
49                           Generates  a  report  using  the  data in the snap‐
50                           shot_input file. snapshot_input must have been gen‐
51                           erated  during  a previous -o snapshot run. '-' may
52                           be used as the snapshot_input to specify stdin.
53
54
55
56
57
58                 -E/--eth config_file
59                           Specifies the Intel  Ethernet  configuration  file.
60                           Default is /etc/eth-tools/mgt_config.xml file.
61
62
63
64
65
66                 -F/--focus point
67                           Specifies  the focus area for report. Used to limit
68                           scope of report. Refer to Point Syntax for details.
69
70
71
72

Report Types

74       verifylinks
75
76                 Compares fabric (or snapshot) links to supplied topology  and
77                 identifies differences and omissions.
78
79
80       verifyextlinks
81
82                 Compares  fabric (or snapshot) links to supplied topology and
83                 identifies differences  and  omissions.  Limits  analysis  to
84                 links external to systems.
85
86
87       verifyniclinks
88
89                 Compares  fabric (or snapshot) links to supplied topology and
90                 identify differences and omissions. Limits analysis to  links
91                 to NICs.
92
93
94       verifyislinks
95
96                 Compares  fabric (or snapshot) links to supplied topology and
97                 identify differences and omissions. Limits analysis to inter-
98                 switch links.
99
100
101       verifyextislinks
102
103                 Compares  fabric (or snapshot) links to supplied topology and
104                 identify differences and omissions. Limits analysis to inter-
105                 switch links external to systems.
106
107
108       verifyall
109
110                 Returns verifynics, verifysws, and verifylinks reports.
111
112
113

Point Syntax

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

Examples

257       List all the missing links in the fabric:
258
259            ethextractmissinglinks
260
261
262
263       List all the missing links to a switch named "coresw1":
264
265            ethextractmissinglinks -T topology.0:0.xml -F "node:coresw1"
266
267
268
269       List all the missing connections to end-nodes:
270
271            ethextractmissinglinks -o verifyniclinks
272
273
274
275       List all the missing links between two switches:
276
277            ethextractmissinglinks -o verifyislinks -T topology.0:0.xml
278
279
280
281Copyright(C) 2020              Intel Corporation     ethextractmissinglinks(8)
Impressum