1
2opalinkanalysis(8)     Master map: IFSFFCLIRG (Man Page)    opalinkanalysis(8)
3
4
5

NAME

7       opalinkanalysis
8
9
10
11       (Switch) Encapsulates the capabilities for link analysis. Additionally,
12       this tool includes cable and fabric topology verification capabilities.
13       This tool is built on top of opareport (and its analysis capabilities),
14       and accepts the same syntax for input topology and snapshot files.
15
16       In addition to being able  to  run  assorted  opareport  link  analysis
17       reports,  and  generate  human-readable  output, this tool additionally
18       analyzes the results and appends a concise summary of issues  found  to
19       the FF_RESULT_DIR/punchlist.csv file.
20

Syntax

22       opalinkanalysis [-U] [-t portsfile] [-p ports] [-T topology_input]
23       [-X snapshot_input] [-x snapshot_suffix] [-c file] reports ...
24

Options

26       --help    Produces full help text.
27
28
29       -U        Omits  unexpected  devices  and  links in punchlist file from
30                 verify reports.
31
32
33       -t portsfile
34                 Specifies the file with list  of  local  HFI  ports  used  to
35                 access fabric(s) for analysis, default is /etc/opa/ports.
36
37
38       -p ports  Specifies  the list of local HFI ports used to access fabrics
39                 for analysis.
40
41
42                 Default is first active port. The first HFI in the system  is
43                 1. The first port on an HFI is 1. Uses the format hfi:port,
44                 for example:
45
46
47
48                 0:0       First active port in system.
49
50
51
52
53
54                 0:y       Port y within system.
55
56
57
58
59
60                 x:0       First active port on HFI x.
61
62
63
64
65
66                 x:y
67                           HFI x, port y.
68
69
70
71       -T topology_input
72                 Specifies  the  name of a topology input file to use. Any  %P
73                 markers in this filename are replaced with the hfi:port being
74                 operated  on (such as 0:0 or 1:2). Default is /etc/opa/topol‐
75                 ogy.%P.xml. If NONE is specified, does  not  use  any  topol‐
76                 ogy_input files. See opareport for more information on topol‐
77                 ogy_input files.
78
79
80       -X snapshot_input
81                 Performs  analysis  using  data  in   snapshot_input.   snap‐
82                 shot_input  must have been generated via a previous opareport
83                 -o snapshot run. If an errors report is  specified,  snapshot
84                 must  have  been generated with the opareport -s option. When
85                 this option is used, only one port may be specified to select
86                 a topology_input file (unless -T specified). When this option
87                 is used, clearerrors and clearhwerrors reports are  not  per‐
88                 mitted.
89
90
91       -x snapshot_suffix
92                 Creates a snapshot file per selected port. The files are cre‐
93                 ated in FF_RESULT_DIR with names of the form: snapshotSUFFIX.
94                 HFI:PORT.xml.
95
96
97       -c file   Specifies   the  error  thresholds  configuration  file.  The
98                 default is /etc/opa/opamon.si.conf.
99
100
101       reports   Supports the following reports:
102
103
104
105                 errors    Specifies link error analysis.
106
107
108
109
110
111                 slowlinks Specifies links running slower than expected.
112
113
114
115
116
117                 misconfiglinks
118                           Specifies links configured to run slower than  sup‐
119                           ported.
120
121
122
123
124
125                 misconnlinks
126                           Specifies  links  connected  with  mismatched speed
127                           potential.
128
129
130
131
132
133                 all       Includes all  reports  above.  (errors,  slowlinks,
134                           misconfiglinks, and misconnlinks)
135
136
137
138
139
140                 verifylinks
141                           Verifies links against topology input.
142
143
144
145
146
147                 verifyextlinks
148                           Verifies links against topology input. Limits anal‐
149                           ysis to links external to systems.
150
151
152
153
154
155                 verifyfilinks
156                           Verifies links against topology input. Limits anal‐
157                           ysis to FI links.
158
159
160
161
162
163                 verifyislinks
164                           Verifies links against topology input. Limits anal‐
165                           ysis to inter-switch links.
166
167
168
169
170
171                 verifyextislinks
172                           Verifies links against topology input. Limits anal‐
173                           ysis to inter-switch links external to systems.
174
175
176
177
178
179                 verifyfis Verifies FIs against topology input.
180
181
182
183
184
185                 verifysws Verifies switches against topology input.
186
187
188
189
190
191                 verifynodes
192                           Verifies  FIs, switches, and routers against topol‐
193                           ogy input.
194
195
196
197
198
199                 verifysms Verifies SMs against topology input.
200
201
202
203
204
205                 verifyall Verifies links, FIs,  switches,  routers,  and  SMs
206                           against topology input.
207
208
209
210
211
212                 clearerrors
213                           Clears error counters, uses PM if available.
214
215
216
217
218
219                 clearhwerrors
220                           Clears hardware error counters, bypasses PM.
221
222
223
224
225
226                 clear     Includes clearerrors and clearhwerrors.
227
228
229
230
231       A   punchlist   of   bad   links   is   also   appended  to  the  file:
232       FF_RESULT_DIR/punchlist.csv
233

Examples

235       opalinkanalysis errors
236       opalinkanalysis errors clearerrors
237       opalinkanalysis -p '1:1 1:2 2:1 2:2'
238

Environment Variables

240       The following environment variables are also used by this command:
241
242       PORTS     List of ports, used in absence of -t and -p.
243
244
245       PORTS_FILE
246                 File containing list of ports, used in absence of -t and -p.
247
248
249       FF_TOPOLOGY_FILE
250                 File containing topology_input, used in absence of -T.
251
252
253
254Copyright(C) 2015-2018         Intel Corporation            opalinkanalysis(8)