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

NAME

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

Syntax

17       ethextractifids [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                 -E/--eth config_file
45                           Specifies  the  Intel  Ethernet configuration file.
46                           Default is /etc/eth-tools/mgt_config.xml file.
47
48
49
50
51
52                 -p plane  Name of the enabled plane  defined  in  Mgt  config
53                           file, default is the first enabled plane.
54
55
56
57
58
59                 -F/--focus point
60                           Specifies  the focus area for report. Used to limit
61                           scope of report. Refer to Point Syntax for details.
62
63
64
65

Point Syntax

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

Examples

246       # List all the ifids in the fabric:
247
248       ethextractifids
249
250
251
252       # List all the ifids of end-nodes:
253
254       ethextractifids -F "nodetype:NIC"
255
256
257
258Copyright(C) 2020-2022         Intel Corporation            ethextractifids(8)
Impressum