A P P E N D I X  B

 


Command Syntax and Options

This chapter describes how to reference the s3kdlres man page and describes the s3kdlres syntax and options. Topics covered include:


Referencing the Man Page

This section explains how to reference the man or help page depending on your operating system.

For the Solaris operating system, type:

man -M /opt/SUNWsscs/man s3kdlres

For the Linux operating system, type:

man 1m -M /opt/SUNWsscs/man s3kdlres

For the Windows operating system, view the file located in /program files/Sun/sccli/s3kdlres.txt.


Command Syntax

This section describes the s3kdlres command syntax.

s3kdlres <XMLfile> [options]



Note - The XML save, download fw, and nvram reset commands can be skipped by specifying the --restore option. In this form, the XML file specified on the command line is read and used to restore the configuration. (See --restore=settings|channels|maps|all for more information.)





Note - Not all configuration settings can be restored with sccli commands.
See Configuration Settings That Are Restored for the list of parameters that are restored by the --restore option. See Configuration Settings That Are Not Restored for a list of settings that are not restored by running the s3kdlres script.




Command Options

s3kdlres options are listed and described in TABLE B-1.

TABLE B-1 s3kdlres Script Options

Option

Description

--device=IP address

Run out-of-band by specifying an IP address.

You can run in-band by specifying an in-band device recognized by sccli, but running in-band "unmaps" the host LUN after the nvram reset. It might not be possible for sccli to reset the controller after the nvram reset. Further manual assistance might be required using the RS-232 interface.

 

When prompted, the channel setting (target ID), and the host LUN need to be restored for the operating system device used. Refer to the Sun StorEdge 3000 Family CLI User's Guide for details on specifying in-band devices.

Only one device can be specified for each script execution. The default IP address is 192.168.1.1

Note: Migrating the firmware using an out-of-band connection is preferred over an in-band connection.

--password=password

Password for out-of-band interface only.

This option is needed if running out-of-band and the RAID controller password is set.

--cli=path-to-cli

By default, for Solaris and Linux operating systems, the script looks for sccli as /opt/SUNWsscs/sbin/sccli. For Microsoft Windows, the default path name is the directory where the sccli package is installed. If that fails, the script uses C:\Program Files\Sun\sccli\sccli. An alternate sccli can be specified using this option.

--quiet

Do not echo sccli commands. Normally, sccli commands are echoed.

--timeout=n

Timeout for sccli commands in seconds. The default timeout for sccli commands is 1200 seconds (20 minutes). This timeout does not specify when sccli returns, but instead triggers the script to wake up and kill the sccli process.

 

This option might be required for very congested or long-haul network VPNs. If the script times out, depending on when the timeout occurred, you might need to recover with a --restore. If it happened before the firmware download, the script can be restarted. If it happened during or after the firmware download, the script cannot be restarted from the beginning due to the firmware check --restore all can be used to finish the configuration restore.

--restore=settings|channels|maps|all

This option skips the interactive end-to-end process of the script. It assumes that the controller is upgraded and that nvram has been reset. In addition, it assumes that sccli can communicate with the controller. The options are further described below.

--restore=settings

This option restores the parameters listed in Configuration Settings That Are Restored.

 

Notes:

The factory default setting for Self-Monitoring Analysis and Reporting Technology (SMART) is detect-clone-replace in firmware 4.xx. SMART determines whether disk drives perform predictive failure analysis. The default setting was disabled in firmware 3.2x. The script does not restore a value of disabled. All other values (detect-only, detect-perpetual-clone, and detect-clone-replace) are restored.

 

The factory setting for polling interval is 30s in firmware 4.13 and later. The default setting was Disabled in firmware 3.2x. The script will not restore a value of 15s. All other values are restored.

 

(Sun StorEdge 3310 SCSI array only) The factory default setting for queue-depth is 1024 in firmware 4.xx. The default setting was 256 in firmware 3.2x. The script does not restore a value of 256. All other values are restored.

--restore=channels

Restores the channel type (disk or host) and target IDs.

--restore=maps

Restores the LUN mappings.

--restore=all

Restores all of the above options. In addition, a controller reset is performed after the channels are restored. The restoration is done in the following order:

1. settings

2. channels

3. controller reset

4. maps

Internally, the script performs the equivalent of --restore=all after the firmware download/nvram reset during the interactive process.