| Sun StorEdge 3000 Family CLI 1.5 User's Guide |     |
| Sun StorEdge 3000 Family CLI 1.5 User's Guide | |
| C H A P T E R 1 |
|
Overview |
Use the Sun StorEdge
3000 Family Command-Line Interface (CLI) to manage Sun StorEdge 3000 family array controllers, examine and configure Sun StorEdge 3000 family arrays, save and restore configuration data, and to download new firmware to array controllers and JBODs. The CLI utility communicates with the storage subsystem using in-band or out-of-band communication with the RAID controller over LVD SCSI, Fibre Channel, or Ethernet connections.
|
Note - The Sun StorEdge 3120 SCSI array is a standalone JBOD. It does not have a RAID controller or RAID controller firmware to manage the disks. For a list of the available JBOD CLI commands, see JBOD Commands. |
For instructions on installing the CLI, refer to the Sun StorEdge 3000 Family Software Installation Guide.
For a complete listing of documentation that corresponds with the CLI utility, see the Installation manual and Sun StorEdge Configuration Service User's Guide for your array.
This chapter introduces the CLI and includes the following topics:
The CLI provides the capability to monitor and configure Sun StorEdge 3000 arrays from an operating system command-line interface using in-band or out-of-band interfaces.
|
Note - All methods which involve accessing a local device require superuser privileges. Only when an IP address is specified on the command line can the user invoke the CLI without being root. |
The management mode is determined based on the following:
|
Note - If the array's IP address cannot be found, the --oob option does not switch to out-of-band mode. This prevents scripts from failing when the array's IP address is not set. |
In order to access the CLI, it must be installed on the server attached to the array that you want to access. For instructions about installing the CLI, refer to the Sun StorEdge 3000 Family Software Installation Guide. To access the CLI, follow the appropriate procedure for your operating system.
1. To access the CLI, log in as root on the server that is attached to the array.
|
Note - If you do not have /usr/sbin in your PATH environment variable, you can invoke the CLI as /usr/sbin/sccli. |
To access the CLI, go to Start 
Programs Sun StorEdge 3000 Family Command Line Interface. This launches the file located in: c:\program files\sun\sccli\sccli.bat. You can modify this file if you want to change the command-line options passed to the CLI utility.
You can also access the CLI from a command shell. In the shell window, type:
Reference the Man pages and the Release Notes for the latest documentation updates.
In Solaris, Linux, HP-UX, and AIX operating systems, to access the Man page, type:
To access help in Windows, go to Start Programs Sun StorEdge 3000 Family Command Line Help.
The CLI utility supports single-command mode and interactive mode. In interactive mode no command is specified on the command line. Specifying the device name on the command line is optional. If the device name is omitted, the CLI searches for any locally-attached Sun StorEdge 3000 Family arrays. If one is found, it is selected automatically. If more than one device is found, a list of choices is displayed. If no device is found, the CLI exits with an error.
In interactive mode, specify the device on the command line. For instance, type:
# sccli 192.168.0.1 sccli: selected se3000://206.6.181.38:58632 [Sun StorEdge 3510 SN#00028E] sccli> show disks free No disks are free. sccli> quit |
Or you can specify nothing on the command line. For instance, in Solaris, type:
# sccli Available devices: 1. /dev/rdsk/c1t0d0s2 [SUN StorEdge 3310 00028E] 2. /dev/rdsk/c1t1d0s2 [SUN StorEdge 3310 00028F] Enter selection: 1 sccli> show events : sccli> quit |
In single-command mode, the name of the target device and the command to execute are specified on the command line. The CLI executes the command and exits.
To start single-command mode, type:
In single-command mode, type the entire command on the command line. For instance, in Solaris, type:
For example, in single-command mode in Windows, type:
When the CLI performs a single command, an exit code indicates the success or failure of the command. An exit code of 0 indicates success, and any non-zero code indicates the command failed.
CLI commands are case-independent. Uppercase, lowercase, or mixed case parameters, commands, and options can be used. Options have a long form and a single-letter form. Options begin with a single dash "-" for single-letter form and with two dashes "--" for long form.
In most cases, you can abbreviate command keywords to the shortest unambiguous substring. For example, abbreviate the show disks command to sh d. For example, type show lds to execute the show logical-drives command. However, to avoid ambiguity, do not abbreviate the command name.
The general syntax for commands in single-command mode is:
Except for the help, about, and version commands, all CLI commands require the specification of a device name.
The following table shows the parameters and options that are used with commands in the following chapters. TABLE 1-2 also shows the options that can be used to simplify script creation and retrieve information.
|
A single host LUN mapping for a logical unit on a host channel can be specified using 3 dotted decimals in this form. Where ch is the physical host channel number, id is the SCSI ID of the logical unit, and lun is the logical unit number. |
||
|
For more information, see Device Names for In-band Communication and Device Names for Out-of-Band Communication. |
||
|
Physical disk drives are specified as two decimal integers separated by a period. The first number is the physical channel number, and the second number is the SCSI target ID for the drive on that channel. For example, specify the disk with target ID 1 on channel 2 as 2.1. |
||
|
LVD JBOD enclosure only. This option selects the disk enclosure containing the specified disk. Specify a Solaris device name such as sd31 or c1t0d0. This option is an alternative to specifying an enclosure services device such as /dev/es/sesn when selecting a JBOD enclosure. This option does not support dual-bus JBOD enclosures. |
||
|
A list of disk specifiers, separated by commas. For example, 1.0, 1.1, 1.2. |
||
--help, --usage |
This option displays a usage message and exits without processing any commands. This option can also be used as a command. For information about the help command, see help. |
|
|
This command abbreviation, icl, provides an alternative to typing the full command name. |
||
|
A comma separated list of logical drive indexes, for example, ld0,ld1,ld2, or a list of logical drive identifiers. Note that these logical-drive numbers do not necessarily correspond to the single-digit logical drive identifiers in the firmware menu interface. The CLI logical drive indexes might change when logical drives are deleted. |
||
|
The list option displays a list of local or remote devices that the CLI manages, and exits without processing any commands. The output includes a filename or URL that can be used to access the device in subsequent commands and the SCSI INQUIRY data and serial number of the subsystem. If a network URL is specified on the command line, the output is limited to that device. If a local device filename or directory name is specified, the search is limited to matching devices. The output includes the device name, vendor, product ID, and serial number. |
||
|
A logical drive can be represented by a logical drive index (a small decimal number distinguished by an ld prefix), or a logical drive identifier (an eight-digit hexadecimal number). For example, a logical drive might be identified both by its logical drive index ld3 and its logical drive ID 71038221. For additional information, see Logical Drive Syntax. Note that these logical-drive numbers do not necessarily correspond to the single-digit logical drive identifiers in the firmware menu interface. The CLI logical drive indexes might change when logical drives are deleted. |
||
|
Logical volumes are specified using either a logical volume index, such as lv12, or an eight-digit hexadecimal logical volume ID. For additional information, see Logical Volume Syntax. Note that these logical volume numbers do not necessarily correspond to the single-digit logical volume identifiers in the firmware menu interface. The CLI logical volume indexes might change when logical volumes are deleted. |
||
|
Partitions of a logical drive or logical volume are made available to hosts by mapping each partition to a target ID and logical unit number on one or more channels on the array controller. Commands with a lun parameter accept the physical channel number, target ID, and logical unit as three decimal numbers separated by periods. For example, 4.1.2 represents physical channel 4, target ID 1, logical unit number 2. |
||
|
A comma separated list of logical volume indexes, for example, lv0,lv1,lv2, or a list of logical volume identifiers. Note that these logical volume numbers do not necessarily correspond to the single-digit logical volume identifiers in the firmware menu interface. The CLI logical volume indexes might change when logical volumes are deleted. |
||
|
Use this option to assume a no response to any yes/no prompts. Use this option to prompt the user before running scripts. |
||
|
This option accesses the selected device using out-of-band communication (through its network interface) rather than using SCSI commands. The device is specified (or discovered) using its SCSI path name (do not specify a network address or URL), but once the device has been selected, all further communication is performed over the network. This can provide better performance when the array is processing large quantities of SCSI I/O. If the IP address for the array cannot be determined, in-band communication is used instead. |
||
|
A logical drive or logical volume identifier with a suffix indicating a specific partition within the logical drive or volume, for example, ld2-03 or 2CA48914-03. The suffix is a hexadecimal number ranging from 0 to 7F. |
||
|
This option specifies the password assigned to the array controller. The user must supply the correct password when issuing potentially dangerous commands to the array over a network connection. For security reasons, it is preferable to supply this password using the CLI password command, or enter the password interactively when prompted for it. No password is required for commands which do not modify the state of the controller, or commands issued using in-band SCSI channels. |
||
|
This option accesses the selected device out-of-band, similar to the --oob option, but using the specified TCP port number. |
||
|
This option displays the version number of the CLI utility and exits without processing any commands. |
||
|
This option assumes a yes response to any yes/no prompts. Use this option to run scripts without prompting the user. |
For in-band communication, the device name includes the:
For systems using the Solaris operating system, the device name is typically specified as:
In the preceding device name code:
s2 = slice 2 of the (logical) disk. Usually, slice 2 is specified when identifying a disk for administrative purposes, but any slice number between 0 and 7 (if the slice exists) works.
An example of the device name in Solaris is:
To access a JBOD enclosure services device using Solaris, specify the device name as shown in the following example, or use the --disk option and specify the name of a disk device within the enclosure.
For Windows operating systems, the device name is specified using the Windows internal device name for the physical device where N corresponds to the disk number displayed in the Disk Administrator.
To access a RAID array using its out-of-band network interface rather than using the SCSI or FC HBA with which the array is connected to the host, specify the --oob option. This option accesses the device using a local HBA only briefly, to retrieve the array's network address, and all subsequent access is done over the network. This is useful when heavy SCSI I/O makes in-band access slow. It can also be used when the host has no path to the primary controller, but can still retrieve the IP address of the array from a LUN mapped from the secondary controller.
Alternately, if the host on which the CLI is running is not connected to the array with a SCSI or FC HBA, a URL can be specified to indicate that the CLI should connect to the remote array over the network.
In out-of-band management, the device name is typically specified as a URL in the format:
A physical disk attached to the array can be identified with any of the following:
Logical drives can be specified by one of the following alphanumeric strings:
Logical drive indexes are constructed by concatenating the string "ld" with a small, zero-based ordinal number. Whenever a logical drive is created or deleted, logical drives are renumbered so that the logical drive indexes range from 0 to n-1, where n is the number of logical drives. Care must be taken not to assume that a logical drive keeps the same logical drive index after creating or deleting any logical drive or rebooting the array controller.
Some commands accept a list of logical drives, or LD-list. This list is constructed by concatenating one or more logical drive identifiers or indexes as shown in the following examples.
This example lists logical drives using the index number.
This example lists logical drives using the local drive identifier.
|
Note - Do not include spaces before or after the commas when specifying a logical drive list. |
Logical volumes are specified by one of the following alphanumeric strings:
A list of logical volumes identifiers or indexes can be specified by concatenating one or more logical drive identifiers or logical volume indexes, separating them with commas.
This example lists logical volumes using the local volume identifier.
This example lists logical volumes using the local volume index number.
| Sun StorEdge 3000 Family CLI 1.5 User's Guide | 817-4951-10 | |
Copyright © 2004, Sun Microsystems, Inc. All rights reserved.
To Access the CLI from UNIX Operating Systems
