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

NAME

7       opaportconfig
8
9
10
11       (Host  or  Switch)  Controls the configuration and state of a specified
12       Intel(R) Omni-Path Host Fabric Interface (HFI) port on the  local  host
13       or a remote switch.
14
15       NOTE:  This  tool  is  designed for expert users only. Non-expert users
16       should use other tools such as opaenableports, opadisableports and opa‐
17       portinfo for basic functionality.
18
19

Syntax

21       opaportconfig [-l lid[-m dest_port]] [-h hfi] [-p port] [-r secs] [-z]
22       [-S state] [-P physstate] [-s speed] [-w width] [-c LTPCRC] [-K mkey]
23       [-v] [-x] [-L lid] [< sub command>]
24

Options

26       --help    Produces full help text.
27
28
29       -l lid    Specifies the destination LID. Default is local port.
30
31
32       -m dest_port
33                 Specifies  the  destination  port. Default is port with given
34                 LID. Used to access switch ports.
35
36
37       -h hfi    Specifies the HFI to send through/to. Default is first HFI.
38
39
40       -p port   Specifies the port to send through/to. Default is first port.
41
42
43       -K mkey   Specifies the SM management key to access remote ports.
44
45
46       sub command
47                 Specifies the one of the following choices:
48
49
50
51
52                 enable    Enables port.
53
54
55
56
57
58                 disable   Disables port.
59
60
61
62
63
64                 bounce    Bounces port.
65
66
67
68
69
70                 NOTE: Bouncing remote ports may cause timeouts.
71
72
73
74
75
76                 ledon     Turns port LED on.
77
78
79
80
81
82                 ledoff    Turns port LED off.
83
84
85
86

Configuration Options

88       -r secs   Repeats to keep the port down for  the  specified  amount  of
89                 seconds.
90
91
92       -S state  Specifies the new state. Default is 0.
93
94
95
96
97                 0         No-op.
98
99
100
101
102
103                 1         Down.
104
105
106
107
108
109                 2         Initiate.
110
111
112
113
114
115                 3         Armed.
116
117
118
119
120
121                 4         Active.
122
123
124
125       -P physstate
126                 Specifies the new physical state. Default is 0.
127
128
129
130
131
132       NOTE: All transitions are valid.
133
134
135
136
137              0         No-op.
138
139
140
141
142
143              2         Polling.
144
145
146
147
148
149              3         Disabled.
150
151
152
153
154
155              11        Phy-Test. Current physstate must be disabled.
156
157
158
159       -s speed  Specifies  the  new  link  speeds  enabled.  Default is 0. To
160                 enable multiple speeds, use the sum of the desired speeds.
161
162
163
164
165                 0         No-op.
166
167
168
169
170
171                 2         0x0002 - 25 Gb/s.
172
173
174
175       -w width  Specifies the new link  widths  enabled.  Default  is  0.  To
176                 enable multiple widths, use sum of desired widths.
177
178
179
180
181                 0         No-op.
182
183
184
185
186
187                 1         0x01 - 1x.
188
189
190
191
192
193                 2         0x02 - 2x.
194
195
196
197
198
199                 4         0x04 - 3x.
200
201
202
203
204
205                 8         0x08 - 4x.
206
207
208
209       -c LTPCRC Specifies the new LTP CRCs enabled. Default is 0.
210                 To enable multiple LTP CRCs, use sum of desired LTP CRCs.
211
212
213
214
215                 0         No-op.
216
217
218
219
220
221                 1         0x1 - 14-bit LTP CRC mode.
222
223
224
225
226
227                 2         0x2 - 16-bit LTP CRC mode.
228
229
230
231
232
233                 4         0x4 - 48-bit LTP CRC mode.
234
235
236
237
238                 8         0x8 - 12/16 bits per lane LTP CRC mode.
239
240
241
242

-h and -p options permit a variety of selections:

244       -h 0      First active port in system (default).
245
246
247       -h 0 -p 0 First active port in system.
248
249
250       -h x      First active port on HFI x.
251
252
253       -h x -p 0 First active port on HFI x.
254
255
256       -h 0 -p y Port y within system (no matter which ports are active).
257
258
259       -h x -p y HFI x, port y.
260
261
262

Debug Options

264       -v        Verbose  output.  Additional  invocations  turn on debugging,
265                 openib debugging, and libibumad debugging.
266
267
268       -z        Does  not  get  port  information  first;  clears  most  port
269                 attributes.
270
271
272       -L lid    Sets PortInfo.LID = lid.
273
274

Examples

276       opaportconfig -w 1
277       opaportconfig -p 1 -h 2 -w 3
278

Description

280       Port  configuration  is  transient  in  nature.  If  the  given host is
281       rebooted or its Intel(R) Omni-Path Fabric Stack is restarted, the  port
282       reverts  to its default configuration and state. Typically, the default
283       state is to have the port enabled with all speeds and widths  supported
284       by the given HFI port.
285
286       To  access  switch ports using this command, the -l and -m options must
287       be given. The -l option specifies the lid of switch port 0 (the logical
288       management port for the switch) and -m specifies the actual switch port
289       to access. If SMA mkeys are used, the -K option is  also  needed.  How‐
290       ever,  the  Intel(R) Omni-Path Fabric Suite Fabric Manager does not use
291       SMA mkeys by default, therefore this option may not be required.
292
293       NOTE: The /etc/init.d/opaportconfig script is provided as an example of
294       changing  port  speed  every  time the server boots. This script can be
295       edited, then scheduled, using chkconfig to control link settings on any
296       set of HFI ports.
297
298
299       CAUTION:  When  using  this  command  to  disable or reconfigure switch
300       ports, if the final port in the path between the Fabric Management Node
301       and the switch is disabled or fails to come online, then opaenableports
302       is not able to reenable it. In this  case,  the  switch  CLI  and/or  a
303       switch reboot may be needed to correct the situation.
304
305
306
307Copyright(C) 2015-2018         Intel Corporation              opaportconfig(1)