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

NAME

7       opachassisadmin
8
9
10
11       (Switch)  Performs  a  number  of multi-step chassis initialization and
12       verification operations,  including  initial  chassis  setup,  firmware
13       upgrades, chassis reboot, and others.
14

Syntax

16       opachassisadmin [-c] [-F chassisfile] [-H 'chassis'] [-P packages]
17       [-a action] [-I fm_bootstate] [-S] [-d upload_dir] [-s securityfiles]
18       operation...
19

Options

21       --help    Produces full help text.
22
23
24       -c        Overwrites  the  result  files  from  any previous run before
25                 starting this run.
26
27
28       -F chassisfile
29                 Specifies the file with chassis in cluster.  The  default  is
30                 /etc/opa/chassis.
31
32
33       -H chassis
34                 Specifies  the  list  of  chassis  to  execute  the operation
35                 against.
36
37
38       -P packages
39                 Specifies the filenames and directories of firmware images to
40                 install.
41
42
43
44                 ·      For  directories specified, all .pkg, .dpkg, and .spkg
45                        files in directory tree are used. shell wild cards may
46                        also be used within quotes.
47
48                 ·      For fmconfig, filename of FM config file is used.
49
50                 ·      For   fmgetconfig,  filename  to  upload  to  (default
51                        opafm.xml) is used.
52
53
54
55       -a action Specifies the action for the supplied file.  The  default  is
56                 push.
57
58
59
60                 For chassis upgrade:
61
62
63
64
65                           push      Ensures  firmware is in primary or alter‐
66                                     nate.
67
68
69
70
71
72                           select    Ensures firmware is in primary.
73
74
75
76
77
78                           run       Ensures firmware is in primary  and  run‐
79                                     ning.
80
81
82
83
84
85
86
87                 For chassis fmconfig :
88
89
90
91
92                           push      Ensures  the  configuration  file  is  in
93                                     chassis.
94
95
96
97
98
99                           run       After push, restarts FM on master,  stops
100                                     on secondary.
101
102
103
104
105
106                           runall    After push, restarts FM on all management
107                                     modules.
108
109
110
111
112
113
114                 For chassis fmcontrol :
115
116
117
118
119                           stop      Stops FM on all management modules.
120
121
122
123
124
125                           run       Ensures FM running on master, stopped  on
126                                     secondary.
127
128
129
130
131
132                           runall
133                                     Ensures FM running on all management mod‐
134                                     ules.
135
136
137
138
139
140                           restart   Restarts FM  on  master,  stops  on  sec‐
141                                     ondary.
142
143
144
145
146
147                           restartall
148                                     Restarts FM on all MM.
149
150
151
152
153
154
155                 For chassis fmsecurityfiles :
156
157
158
159
160                           push      Ensures FM security files are in chassis.
161
162
163
164
165
166                           restart   After  push,  restarts FM on master, stop
167                                     on slave.
168
169
170
171
172
173                           restartall
174                                     After push, restarts FM on all MM
175
176
177
178
179       -I fm_bootstate
180                 Specifies the fmconfig and fmcontrol install options.
181
182
183
184                 disable   Disables FM start at chassis boot.
185
186
187
188
189
190                 enable    Enables FM start on master at chassis boot.
191
192
193
194
195
196                 enableall Enables FM start on all MM at chassis boot.
197
198
199
200
201       -d upload_dir
202                 Specifies the directory to upload FM configuration files  to;
203                 default is uploads.
204
205
206       -S        Securely prompts for password for user on chassis.
207
208
209       -s securityFiles
210                 Specifies  the  security  files to install. Default is *.pem.
211                 For Chassis fmsecurityfiles, filenames/directories  of  secu‐
212                 rity  files  to install. For directories specified, all secu‐
213                 rity files in directory tree are used.  Shell  wildcards  may
214                 also be used within quotes.
215
216
217                 For   Chassis  fmgetsecurityfiles,  filename  to  upload  to.
218                 Default is *.pem
219
220       operation Specifies the operation to perform. Can be one or more of:
221
222
223
224                 reboot    Reboots chassis, ensures  they  go  down  and  come
225                           back.
226
227
228
229
230
231                 configure Runs wizard to perform chassis configuration.
232
233
234
235
236
237                 upgrade   Upgrades install of all chassis.
238
239
240
241
242
243                 getconfig Gets basic configuration of chassis.
244
245
246
247
248
249                 fmconfig  FM configuration operation on all chassis.
250
251
252
253
254
255                 fmgetconfig
256                           Fetches FM configuration from all chassis.
257
258
259
260
261
262                 fmcontrol Controls FM on all chassis.
263
264
265
266
267
268                 fmsecurityfiles
269                           FM security files operation on all chassis.
270
271
272
273
274
275                 fmgetsecurityfiles
276                           Fetches FM security files from all chassis.
277
278
279       For more information on the operations that can be performed, see Oper‐
280       ation Details
281
282

Example

284       opachassisadmin -c reboot
285       opachassisadmin -P /root/ChassisFw4.2.0.0.1 upgrade
286       opachassisadmin -H 'chassis1 chassis2' reboot
287       CHASSIS='chassis1 chassis2' opachassis_admin reboot
288       opachassisadmin -a run -P '*.pkg' upgrade
289

Environment Variables

291       The following environment variables are also used by this command:
292
293       CHASSIS   List of chassis, used if -H and -F option not supplied.
294
295
296       CHASSIS_FILE
297                 File containing list of chassis, used in absence  of  -F  and
298                 -H.
299
300
301       FF_MAX_PARALLEL
302                 Maximum concurrent operations.
303
304
305       FF_SERIALIZE_OUTPUT
306                 Serializes output of parallel operations (yes or no).
307
308
309       FF_TIMEOUT_MULT
310                 Multiplier  for  all  timeouts  associated with this command.
311                 Used if the systems are slow for some reason.
312
313
314       UPLOADS_DIR
315                 Directory to upload to, used in absence of -d.
316
317
318

Operation Details

320       (Switch) All chassis operations log into the chassis  as  chassis  user
321       admin.  Intel  recommends  using the -S option to securely prompt for a
322       password, in which case the same password  is  used  for  all  chassis.
323       Alternately, the password may be put in the environment or the opafast‐
324       fabric.conf file using FF_CHASSIS_ADMIN_PASSWORD.
325
326       All versions of Intel(R) Omni-Path Switch 100  Series  firmware  permit
327       SSH  keys  to be configured within the chassis for secure password-less
328       login. In  this  case,  there  is  no  need  to  configure  a  FF_CHAS‐
329       SIS_ADMIN_PASSWORD  ; and, FF_CHASSIS_LOGIN_METHOD can be SSH. Refer to
330       the Intel(R) Omni-Path Fabric Suite FastFabric User Guide
331
332        for more information.
333
334       upgrade   Upgrades the firmware on each chassis or slot specified.  The
335                 -P  option  selects a directory containing .pkg files or pro‐
336                 vides an explicit list of .pkg files for the  chassis  and/or
337                 slots.  The  -a  option selects the desired minimal state for
338                 the new firmware. For each chassis and/or slot  selected  for
339                 upgrade,  the  .pkg  file applicable to that slot is selected
340                 and used. If more than one .pkg file is specified of a  given
341                 card type, the operation is undefined.
342
343
344                 The  upgrade is intelligent and does not upgrade chassis that
345                 already have the desired firmware in the  desired  state  (as
346                 specified by -a).
347
348                 When  the  -a  option  specifies  run,  chassis  that are not
349                 already running the desired firmware are rebooted. By select‐
350                 ing  the proper FF_MAX_PARALLEL value, a rolling upgrade or a
351                 parallel upgrade may be accomplished. In most cases, a paral‐
352                 lel upgrade is recommended for expediency.
353
354                 For  more  information  about  chassis firmware, refer to the
355                 Intel(R) Omni-Path Fabric Switches GUI User Guide
356
357                 and Intel(R) Omni-Path Fabric Switches Release Notes
358
359
360       configure Runs the chassis setup wizard, which asks a series  of  ques‐
361                 tions.  Once the wizard has finished prompting for configura‐
362                 tion information, all the  selected  chassis  are  configured
363                 through  the  CLI  interface  according to the responses. The
364                 following options may be configured for all chassis:
365
366
367
368                 ·      Syslog server IP address, TCP/UDP port number,  syslog
369                        facility code, and the chassis LogMode.
370
371
372                 ·      NTP server
373
374
375                 ·      Local time zone
376
377
378                 ·      Link CRC Mode
379
380
381                 ·      Link width supported
382
383
384                 ·      Node description
385
386
387
388
389       reboot    Reboots  the  given chassis and ensures they go down and come
390                 back up by pinging them during the reboot process.
391
392
393                 By selecting the  proper  FF_MAX_PARALLEL  value,  a  rolling
394                 reboot  or  a  parallel  reboot  may be accomplished. In most
395                 cases, a parallel upgrade is recommended for expediency.
396
397       getconfig Retrieves basic information from a chassis  such  as  syslog,
398                 NTP  configuration, timezone info, Link CRC Mode, Link Width,
399                 and node description.
400
401
402       fmconfig  Updates the Fabric Manager configuration file on each chassis
403                 specified.  The  -P  option selects a file to transfer to the
404                 chassis. The -a option selects the desired minimal state  for
405                 the   new  configuration  and  controls  whether  the  FM  is
406                 started/restarted after the file is updated.  The  -I  option
407                 can  be  used  to  configure  the  FM  start  at boot for the
408                 selected chassis.
409
410
411       fmgetconfig
412                 Uploads the FM configuration file from all selected  chassis.
413                 The  file  is uploaded to the selected uploads directory. The
414                 -P option specifies the desired destination  filename  within
415                 the uploads directory.
416
417
418       fmcontrol Allows the FM to be controlled on each chassis specified. The
419                 -a option selects the desired state for the FM.
420
421
422                 The -I option  configures  the  FM  start  at  boot  for  the
423                 selected chassis.
424
425       fmsecurityfiles
426                 Updates  the FM security files on each chassis specified. The
427                 -s option selects file(s) to transfer to the chassis. The  -a
428                 option selects the desired minimal state for the new security
429                 files. In this release, push is the only supported action.
430
431
432       fmgetsecurityfiles
433                 Uploads the FM security files from all selected chassis.  The
434                 files  are uploaded to the selected uploads directory. The -s
435                 option specifies the desired destination filename within  the
436                 uploads directory.
437
438

Logging

440       opachassisadmin  provides  detailed logging of its results. During each
441       run, the following files are produced:
442
443       test.res  This file is appended with summary results of run.
444
445
446       test.log  This file is appended with detailed results of run.
447
448
449       save_tmp/ This file is  contains  a  directory  per  failed  test  with
450                 detailed logs.
451
452
453       test_tmp*/
454                 This file contains the intermediate results while the test is
455                 running.
456
457
458       The -c option removes all log files.
459

ssh Keys

461       When performing operations against chassis, Intel recommends setting up
462       SSH  keys.  If  SSH keys are not set up, all chassis must be configured
463       with the same admin password. In this case, Intel recommends using  the
464       -S  option.  The -S option avoids the need to keep the password in con‐
465       figuration files.
466

Results

468       Results from opachassisadmin are grouped into test suites, test  cases,
469       and test items. A given run of opachassisadmin represents a single test
470       suite. Within a test suite, multiple test cases  occur;  typically  one
471       test case per chassis being operated on. Some of the more complex oper‐
472       ations may have multiple test items per test case. Each test item  rep‐
473       resents a major step in the overall test case.
474
475       Each  opachassisadmin run appends to test.res and test.log, and creates
476       temporary files in test_tmp$PID in the current directory. The  test.res
477       file  provides  an  overall  summary  of operations performed and their
478       results. The same information is also displayed  while  opachassisadmin
479       is  executing.  test.log  contains  detailed information about what was
480       performed, including the specific commands executed and  the  resulting
481       output.  The  test_tmp directories contain temporary files that reflect
482       tests in progress (or killed). The logs for any failures are logged  in
483       the  save_temp  directory with a directory per failed test case. If the
484       same test case fails more than once, save_temp retains the  information
485       from the first failure. Subsequent runs of opachassisadmin are appended
486       to test.log. Intel recommends  reviewing  failures  and  using  the  -c
487       option to remove old logs before subsequent runs of opachassisadmin.
488
489       opachassisadmin  implicitly  performs  its operations in parallel. How‐
490       ever, as for the other tools, FF_MAX_PARALLEL can be exported to change
491       the  degree  of  parallelism.  Twenty  (20)  parallel operations is the
492       default.
493
494
495
496Copyright(C) 2015-2018         Intel Corporation            opachassisadmin(8)
Impressum