1opaswitchadmin(8) Master map: IFSFFCLIRG (Man Page) opaswitchadmin(8)
3
7 opaswitchadmin
8 (Switch) Performs a number of multi-step initialization and verifica‐
12 tion operations against one or more externally managed Intel(R) Omni-
13 Path switches. The operations include initial switch setup, firmware
14 upgrades, chassis reboot, and others.
15
17 opaswitchadmin [-c] [-N 'nodes'] [-L nodefile] [-O] [-P packages]
18 [-a action] [-t portsfile] [-p ports] operation...
19
21 -help Produces full help text.
22 -c Overwrites result files from any previous run before starting
25 this run.
26 -N nodes Specifies the list of nodes to execute the operation against.
29 -L nodefile
32 Specifies the file with nodes in the cluster. Default is
33 /etc/opa/switches file.
34 -P packages
37 For upgrades: Specifies the file name or directory where the
38 firmware image is to install. For the directory specified,
39 .emfw file in the directory tree is used. shell wild cards
40 may also be used within quotes.
41 -t portsfile
44 Specifies the file with list of local HFI ports used to
45 access fabrics for switch access. Default is /etc/opa/ports
46 file.
47 -p ports Specifies the list of local HFI ports used to access fabrics
50 for switch access.
51 Default is first active port. The first HFI in the system is
54 1. The first port on an HFI is 1. Uses the format hfi:port,
55 for example:
56 0:0 First active port in system.
60 0:y Port y within system.
66 x:0 First active port on HFI x.
72 x:y HFI x, port y.
78 -a action Specifies an action for firmware file for switch upgrade. The
82 action argument can be one or more of the following:
83 select Ensures firmware is in primary (default).
88 run Ensures firmware is in primary and running.
94 -O Specifies the override for firmware upgrades, bypasses the
98 previous firmware version checks, and forces the update
99 unconditionally.
100 operation Performs the specified operation, which can be one or more of
103 the following:
104 reboot Reboots switches, ensures they go down and come
109 back.
110 configure Runs wizard to set up switch configuration.
116 NOTE: You must reboot the switch for any new settings to be
122 applied.
123 upgrade Upgrades installation of all switches.
129 info Reports firmware and hardware version, part number,
135 and data rate capability of all nodes.
136 hwvpd Completes hardware Vital Product Data (VPD) report
142 of all nodes.
143 ping Pings all nodes and tests for presence.
149 fwverify Reports integrity of failsafe firmware of all
155 nodes.
156 getconfig Gets port configurations of an externally managed
162 switch.
163 For more information on operations, see Operation Details
167
169 opaswitchadmin -c reboot
170 opaswitchadmin -P /root/ChassisFw X.X.X.X.X upgrade
171 opaswitchadmin -a run -P '*.emfw' upgrade
172
174 The following environment variables are also used by this command:
175 OPASWITCHES
177 List of nodes, used in absence of -N and -L options.
178 OPASWITCHES_FILE
181 File containing list of nodes, used in absence of -N and -L
182 options.
183 FF_MAX_PARALLEL
186 Maximum concurrent operations.
187 FF_SERIALIZE_OUTPUT
190 Serialize output of parallel operations (yes or no).
191 FF_TIMEOUT_MULT
194 Multiplier for all timeouts associated with this command.
195 Used if the systems are slow for some reason.
196
199 opaswitchadmin provides detailed logging of its results. During each
200 run, the following files are produced:
201 · test.res : Appended with summary results of run.
203 · test.log : Appended with detailed results of run.
205 · save_tmp/ : Contains a directory per failed test with detailed
207 logs.
208 · test_tmp*/ : Intermediate result files while test is running.
210 The -c option removes all log files.
212 Results from opaswitchadmin are grouped into test suites, test cases,
214 and test items. A given run of opaswitchadmin represents a single test
215 suite. Within a test suite, multiple test cases occur; typically one
216 test case per chassis being operated on. Some of the more complex oper‐
217 ations may have multiple test items per test case. Each test item rep‐
218 resents a major step in the overall test case.
219 Each opaswitchadmin run appends to test.res and test.log and creates
221 temporary files in test_tmp$PID in the current directory. the test.res
222 file provides an overall summary of operations performed and their
223 results. The same information is also displayed while opaswitchadmin is
224 executing. test.log contains detailed information about what was per‐
225 formed, including the specific commands executed and the resulting out‐
226 put. The test_tmp directories contain temporary files that reflect
227 tests in progress (or killed). The logs for any failures are logged in
228 the save_temp directory with a directory per failed test case. If the
229 same test case fails more than once, save_temp retains the information
230 from the first failure. Subsequent runs of opaswitchadmin are appended
231 to test.log. Intel recommends reviewing failures and using the -c
232 option to remove old logs before subsequent runs of opaswitchadmin.
233 opaswitchadmin also appends to punchlist.csv for failing switches.
234 opaswitchadmin implicitly performs its operations in parallel. However,
236 as for the other tools, FF_MAX_PARALLEL can be exported to change the
237 degree of parallelism. Twenty (20) parallel operations is the default.
238
241 (Switch) All operations against Intel(R) Omni-Path Fabric externally-
242 managed switches (except ping) securely access the selected switches.
243 If a password has been set, the -S option must be used to securely
244 prompt for a password. In this case, the same password is used for all
245 switches.
246 reboot Reboots the given switches.
248 Use the FF_MAX_PARALLEL value to select either a rolling
251 reboot or a parallel reboot. In most cases, a parallel reboot
252 is recommended for expediency.
253 upgrade Upgrades the firmware on each specified switch. The -P option
255 selects a directory containing a .emfw file or provides an
256 explicit .emfw file for the switches. If more than one .emfw
257 file is specified, the operation is undefined. The -a option
258 selects the desired minimal state for the new firmware. Only
259 the select and run options are valid for this operation.
260 When the -a option specifies run, switches are rebooted. Use
263 the FF_MAX_PARALLEL value to select a rolling upgrade or a
264 parallel upgrade. In most cases, a parallel upgrade is recom‐
265 mended for expediency.
266 The upgrade process also sets the switch name.
268 The upgrade process is used to set, clear, or change the
270 password of the switches using the -s option. When this
271 option is specified, you are prompted for a new password to
272 be set on the switches. To reset (clear) the password, press
273 Enter when prompted. This option can be used to configure the
274 switches to not require a password for subsequent operations.
275 A change to the password does not take effect until the next
276 reboot of the switch.
277 For more information about switch firmware, refer to the
279 Intel(R) Omni-Path Fabric Switches GUI User Guide
280 and Intel(R) Omni-Path Fabric Switches Release Notes
282 configure Runs the switch setup wizard, which asks a series of ques‐
285 tions. Once the wizard has finished prompting for configura‐
286 tion information, all the selected switches are configured
287 according to the entered responses. The following items are
288 configurable for all Intel(R) Omni-Path Switch 100 Series :
289 · FM Enabled
293 · Link CRC Mode
295 · Link Width Supported
297 · OPA Node Description
299 NOTE: Typically, the Node Description is updated automatically during a
306 firmware upgrade, if it is configured properly in the switches file.
307 Updating the node description is also available using the configure
308 option without performing a firmware upgrade.
309 NOTE: You must reboot the switch for any new settings to be applied.
315 info Queries the switches and displays the following information:
318 · Firmware version
322 · Hardware version
324 · Hardware part number, including revision information
326 · Speed capability
328 · Fan status
330 · Power supply status
332 This operation also outputs a summary of various configura‐
336 tion settings for each switch within a fabric.
337 hwvpd Queries the switches and displays the Vital Product Data
339 (VPD) including:
340 · Serial number
344 · Part number
346 · Model name
348 · Hardware version
350 · Manufacturer
352 · Product description
354 · Manufacturer ID
356 · Manufacture date
358 · Manufacture time
360 ping Issues an inband packet to the switches to test for presence
364 and reports on presence/non-presence of each selected switch.
365 NOTE: It is not necessary to supply a password (using -S) for this
371 operation.
372 fwverify Verifies the integrity of the firmware images in the EEPROMs
375 of the selected switches.
376 getconfig Gets port configurations of an externally managed switch.
379 This operation also outputs a summary of various configura‐
380 tion settings for each switch within a fabric. For example,
381 in a fabric with seven switches, a report similar to the fol‐
382 lowing is displayed.
383 This summary helps determine if all switches have the same
386 configuration, and if not, indicates how many have each
387 value. If some of the values are not as expected, view the
388 test.res file to identify which switches have the undesirable
389 values.
390Copyright(C) 2015-2018 Intel Corporation opaswitchadmin(8)