C H A P T E R 17 |
Using the Command-Line Interface |
This chapter explains how to use the text-based command-line interface that provides the same functions as the Sun StorageTek RAID Manager graphical user interface (GUI) in environments where a GUI is not available.
This chapter provides a description, syntax, and examples for each CLI command. Text that you enter literally is shown in bold. Optional parameters are shown enclosed in [square brackets]. Variables for which you must substitute values are shown in italics. When you may select between multiple parameters, options are separated by a bar ( | ).
This chapter contains the following sections:
This section contains the following subsections:
The command-line interface is used interactively or in batch mode. With interactive mode, enter commands at the prompt. In batch mode, create scripts and run the script in the appropriate shell. For example:
In either mode, if the command fails, you immediately see an error message for the command that failed. Other script messages that you might encounter indicate the command completed successfully, or the command was aborted.
To access the online help, type arcconf, then press Enter.
The return values are as follows:
0x00: SUCCESS
0x01: FAILURE
0x02: ABORT
The command was aborted because parameters failed validation
0x03: INVALID_ARGUMENTS
The arguments are incorrect. (Displays COMMAND help)
0x04: UNSUPPORTED
The adapter specified does not exist (special case for INVALID_ARGUMENTS)
The command-line interface event log shows the results of a command in the form of the following:
Additionally, when using the romupdate or driverupdate commands, the event log displays the old and new version of the firmware or driver being updated.
This feature allows you to save logs documenting all commands. The following is an example of saving a firmware update event log.
The error log keeps an inventory of all relevant information from an event failure. The error log file also contains return codes (for details see Identifying Return Codes) that help diagnose why a command failed.
When saving an event log, you can specify the log name and path by using the eventlog optional parameter, type name-of-CLI eventlog path, then press Enter.
This feature allows you to save logs documenting all event failures. The following is an example of saving a driver update error log.
This section provides information on the following arcconf commands:
Enables or disables the copyback feature, which attempts to keep drives in the original slot order after rebuilds.
arcconf copyback controller-number on | off
Enables or disables the copyback feature.
Creates a new logical drive. You must provide the channel and device ID of the physical devices.
On redundant logical drives, arcconf performs auto synchronization.
arcconf create controller-number logicaldrive [stripesize size] [legs number] [name name] [priority low | medium | high] [Method build | clear | quick] [ron | roff] [wt | tb | wbb]] [size | max] [RAID-number] [channel-number channel-ID-number] [noprompt]
arcconf create controller-number logicaldrive rvolume volume [logical-drive-number] [logical-drive-number] [noprompt]
A logical drive will be created
Optional parameter to specifying a stripe size. The size can be 16, 32, 64, 128, 256, 512 and 1024 KB. The default is 256 KB.
Optional parameter to specify the number of legs in the multi-layer array. Value is an integer for RAID 0x. For RAID 50/60--2 - 16 legs, 3 - 16 drives/leg, 48 drives max
Optional parameter to specify the alias name of a logical device that appears in the utilities. Value is a string of up to 16 characters.
Initialization priority for logical drive to be created.
Initialization method for the logical drive.
Turn on or off logical drive read cache
wt / wb: disable or enable logical drive write cache write-through. wbb: enable logical drive write cache write-back enabled when protected by a battery
The size of the logical drive in megabytes. Use max to set size to available space.
RAID level for the new logical drive. 0, 1, 1E, 10, 5, 5EE, 50, 6, 60, and volume are supported.
The space-delimited channel number and device number pairs for each device to add to the logical drive.
The RAID level for a RAID volume logical drive.
Logical drive numbers for two or more logical drives to be concatenated into the RAID volume. At least two must be used.
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
Sets the background consistency check modes of the controller.
arcconf datascrub controller-number on | off | period days [noprompt]
on turns the background consistency check on.
off turns the background consistency check off.
period days the number of days to complete a background consistency check. period automatically turns on the background consistency check days indicates a minimum of 10 days (quick) and a maximum of 365 days (slow)
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
Deletes a logical drive. All data stored on the logical drive will be lost. Spanned drives cannot be deleted with this function.
arcconf delete controller-number logicaldrive logical-drive-number-to-delete | all logical-drive-number logical-drive-number [noprompt]
arcconf delete controller-number logicaldrive all [noprompt]
The number of the logical drive to be deleted. all deletes all logical drives.
Logical drive numbers for two or more logical drives.
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
Updates Windows device drivers. When given a directory name, it attempts to update a driver to the version found in the given directory.
Note - This command is available only on Windows systems. |
arcconf driverupdate directory-path
The directory path containing the driver that you want to update.
Lists information about the controllers, logical drives, and physical devices. This information can include (but is not limited to) the following items:
arcconf getconfig controller-number [ad | ld | pd | al]
Logical drive information only
Physical device information only
Obtains controller log information. Provides access to the status and event logs of a controller.
arcconf getlogs controller-number device | dead | event [clear | tabular]
Retrieve a log of any device errors the controller has encountered
Retrieve a log that records any occurrences of defunct devices
Retrieve a log of special events that may have occurred (for example, rebuilds, LDMs, and so on)
Optional, clears the specified controller log
Optional, displays logs in a table format
The getstatus function displays the status of any background command that is currently running. Including information about the most recent rebuild, synchronization, logical-drive migration, and compaction/expansion. The information includes the type of operation, status, logical drive number, logical drive size, and percentage of the operation completed.
arcconf getstatus controller-number
Lists version information for all controllers or a specific controller’s software components, including information about the BIOS, driver, firmware currently running, and firmware that will run after a reboot.
Note - The firmware version that will run after a reboot is called the “staged” firmware. |
arcconf getversion controller-number
The controller number. If no controller number is specified, information for all controllers is retrieved.
Identifies a physical or logical device by blinking its LEDs
arcconf identify controller-number logicaldrive logical-drive-number
arcconf identify controller-number device channel-number ID-number
The number of the logical drive to be identified
The channel and ID number for the device to be identified
Loads a feature key onto a Sun controller
arcconf key controller-number set key-number
type the key number provided by Sun
Morphs a logical device from one raid level to another (RAID Level Migration). Expands a logical device from original to one with larger capacity (Online Capacity Expansion). Can be used to make mirrored sets.
arcconf modify controller-number from logical-drive-number to [stripe-size | init-priority | legs | [size | max] RAID-number | channel-number ID-number[channel-number ID-number]] [noprompt]
The logical drive to be modified
The stripe size in KB. Options are 16, 32, 64, 128, 256, 512, and 1024. the default is 256 KB.
The priority level of the modification. Options are low, med, and high.
The number of subarrays for a RAID level-50 or RAID level 60 array. Possible values are 2-16 legs and 3-16 drives/leg (to 48 drives maximum).
Desired size in MB or max to use all available space on the disk
The RAID level for the logical drive 0, 1, 5, 5EE, or 10.
Note - The channel number and ID number parameters is the list of devices that will contain the target modification object. |
The channel number for the device
The device_ID (device number) for the device
Note - Channel and device_ID are repeatable parameters. |
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
Enables the controller to check for the removal of any disk drives in the ready state and to check for the connection of any new disk drives to the controller. The command returns when the rescan is complete.
arcconf rescan controller-number
Allows new firmware and BIOS to be flashed to the controller. A reboot is required for the new firmware to take effect.
Note - This function is only supported in Windows and Linux. Be sure to copy the *.UFI update files from the CD and not from the BIOS / firmware update diskettes. |
arcconf romupdate controller-number basename
The name of the ROM image basename or the fully qualified name if you have a set of controller ROM images.
Note - All UFI files must be in the same directory prior to invoking arcconf. If you are copying UFI files from floppy images, be sure to check all images. |
Sets the state of the controller audible alarm, if present.
arcconf setalarm controller-number on | off | silence | test
Quiets the currently sounding alarm
Changes a logical drive’s cache mode.
arcconf setcache controller-number logicaldrive logical-drive-number [ron | rof] [wt | tb | wbb] [noprompt]
arcconf setcache controller-number device channel-number ID-number [ron | roff] [wt | tb | wbb] [noprompt]
The number of the logical drive whose cache will be altered
Turn on or off logical drive read cache
wt / wb: disable or enable logical drive write cache write-through. wbb: enable logical drive write cache write-back when protected by a battery
The channel number and device number for the device
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
Resets the controller's configuration. Logical drives are deleted, hard disks are reset to the READY state.
arcconf setconfig controller-number default [noprompt]
Restores the controller’s default configuration
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
arcconf setname controller-number logicaldrive logical-drive-number new-name
The number of the logical drive to be renamed
The new name of the logical drive
Changes the state of a physical device from its current state to the designated state (hot-spare).
arcconf setstate controller-number device channel-number ID-number device-number hsp | rdy | ddd logicaldrive logical-drive-number [logical-drive-number]
The channel and ID number for the device
The device number for the device
Create a hot-spare from a ready drive
Remove a hot-spare designation
Logical drive number(s) used to create an assigned hot-spare
arcconf setstate 1 device 0 0 hsp logicaldrive 1 2 3 arcconf setstate 1 device 0 0 rdy logicaldrive 2 |
Performs a task on a logical drive.
arcconf task start | stop controller-number logicaldrive logical-drive-number [verify_fix | verify | clear] [noprompt]
arcconf task start | stop controller-number device channel-number ID-number[verify_fix | verify | clear | initialize | secureerase] [noprompt]
The number of the logical drive on which the task is to be performed
The channel and ID number on which the task is to be performed
Verifies the disk media and repairs the disk if bad data is found
Removes all data from the drive
Returns a drive to the READY state (erases the metadata)
Removes all data from the drive in a secure fashion to prevent possible recovery of the erased data
Used mostly for the purpose of scripting setup, this parameter overrides all user confirmations.
Copyright © 2009 Sun Microsystems, Inc. All rights reserved.