Using the CLI

This chapter provides detailed instructions for using the Command Line Interface (CLI).

Important: Be extremely careful when using the Command Line Interface. Some commands can destroy arrays and logical drives as well as change the network settings. This could prevent you from communicating with the enclosure.

Note:  The CLI prompt displays as DS400[x] or DS300[x] depending on the machine type. The [x] defines the controller (either A or B).

 

This chapter provides information about the following areas:

·         Overview of CLI

·         CLI Parameter Glossary

·         Setup Wizard

·         Administrator Command

·         Array Commands

·         Authentication Commands (iSCSI Only)

·         Cache Commands

·         Controller Commands

·         Device Commands

·         Diag Commands

·         End Command

·         Events Commands

·         FRU Commands

·         Help | ? [all] | [global] | [help | ?] | [keys]

·         Image Commands

·         Initiator Commands (iSCSI)

·         Initiator Commands (FC)

·         Interface Commands

·         iSNS Commands (iSCSI Only)

·         License Commands

·         Logical Commands (iSCSI)

·         Logical Commands (FC)

·         Network Commands

·         Operator Command

·         Password operator | administrator Command

·         Port Commands (FC Only)

·         Quit Command

·         Route Commands

·         Save Command

·         Scope Commands

·         Service Commands

·         Show option Command

·         Snapshot Commands (iSCSI)

·         SNMP Commands

·         System Commands

·         UPS Commands

Overview of CLI

The CLI software is a terminal-based command line interface that allows you to monitor and manage the IBM TotalStorage external storage subsystem. iSCSI targets and FC volumes that will appear as local disk storage on your server can be created and managed. Comprehensive event logging features allow you to monitor the entire.

Accessing CLI

You can access CLI two ways. Each method presents CLI automatically:

Use these terminal emulation program settings to access the CLI:

o        Null Modem Cable

o        Baud Rate:115,200

o        Data Bits: 8

o        Parity: None

o        Stop Bits: 1

o        Flow Control: Off

·        Connect to the storage subsystem through a Telnet session (once the initial network values have been set.)

Telnet to the IP address that is assigned to the Management port on the storage subsystem.

Note: The factory default IP address for the management port for Controller A is 192.168.70.123 (ETH0[A]). The management port for Controller B defaults to 192.168.70.124 (ETH0[B]). 

Access Levels and Passwords

The CLI has two levels of access: Operator or Administrator. From the Operator level you can monitor the current status of the system, but you cannot make any configuration changes. To set the Operator password type:

password operator <Enter>
new password ***** <Enter>
confirm new password ***** <Enter>

Note: You must be in Administrator level to set passwords.

From the Administrator level, you have full access to all the features of the software and can make changes to the configuration of the system.

Note:  The default administrator password is “passw0rd” . (Note the zero instead of a letter O.)

To set the Administrator password type:

Password administrator <Enter>
new password ***** <Enter>
confirm new password ***** <Enter>

To switch from operator to administrator level, type administrator and enter the password. To switch from administrator to operator level, type operator.

Note:  If you forget your password(s) you can log into the system by physically attaching a serial cable to the IBM TotalStorage external storage subsystem and using a VT100 terminal emulation program, such as hyperterminal. (For terminal emulation program settings, see Use these terminal emulation program settings to access the CLI:.) In this situation, you are not required to enter a password, thus allowing you to set up a new password(s).

CLI Commands

This section provides an overview of what CLI commands are and how they are used.

A command is like an area of functionality (for example, array ) followed by an action (for example, create ), and possibly also followed by a list of parameters (for example, disk names ).

Parameters may be in a fixed or variable order. When parameters are in a fixed order, the CLI uses their position on the line to determine what they signify. When parameters are in a variable order, they are preceded by a keyword that the CLI uses to determine what they signify.

The manage commands are distinctive, because they take as a parameter an item to be acted upon (for instance, a logical drive or a disk) and apply to it other commands with their own sets of parameters. For example:

port manage port topology topology

where topology may be considered a separate command within the manage command.

The commands available to you depend on the level at which you are working (operator or administrator ) and in which context the CLI is running.

When you are in a context other than the global context, you don't have to enter the part of the command that defines the context (or, in some cases, the object being worked on).

Many commands take lists, which are terminated by the end of the line or by another keyword.

Character Case and White Space

The CLI is not case-sensitive. Commands and parameters can be typed using any combination of upper and lower case letters 1. All IQNs, iSCSI Aliases, and initiator names must be entered in lower-case letters.

Commands and parameters are separated with one or more spaces and/or tab characters (white space). White space at the start and end of a command line is ignored.

If a white space character has to be entered as part of a parameter, enclose the parameter in a pair of quotes (" "). Everything between the quotes, including any enclosed white space, is used as the parameter (the quotes are not used as part of the parameter).

Command Completion and Abbreviation

You can request a command completion at any time by pressing the Tab key.

If, after considering what has been typed on the line up to the tab, there is only one word that can legally be entered, that word is added to the end of the line. In cases where several words can be entered, these are listed and the line redisplayed. If these words have a common root, it is added to the line. If there are no words that can be legally added, the line does not change.

Sometimes, the complete list of options cannot be printed, such as with a range of numbers, or a class of objects. In this case, a description enclosed in < > is shown (e.g. <name> ).

Sometimes, when a list of numbers is given, a description will be added in angle brackets to make clear what is being asked for (eg. <stripedepth>, as shown in the example below):

dual-ip3[B]# array create a2 raid5 <TAB>

1024  16    32    64

128   256   512   <stripedepth>

Most commands and parameters can be abbreviated to their shortest unique abbreviation. For example, if you are in the Operator level and wish to change to the Administrator level, all you have to type is ad as there are no other commands starting with "ad".

Command Format in This Guide

In this Guide, a value shown in italics describes the type of the value. Otherwise, the string itself is the value. For example, int means any integer, whereas int means the string int.

If a parameter is in [ ], it is optional. If a command's parameters are all optional, at least one must be supplied unless the complete parameters list is also enclosed in [ ].

A set of values joined with a | means that only one of those values may be given.

Command Line Editing

Commands and parameters can be edited as you type by using common keystrokes. The next Table lists the editing keystrokes that can be used.

Keystroke

Function

Ctrl-A

Jump to the start of the line

Ctrl-B

Move cursor back one character (left)

Ctrl-C

Escapes and terminates lengthy tasks

Ctrl-D

Delete the character at, or in front of, the cursor

Ctrl-E

Jump to the end of the current line

Ctrl-F

Moves cursor forward one character

Ctrl-H; Backspace

Erases a mistake when entering a command

Ctrl-K

Delete from the cursor forward to the end of the line

Ctrl-N; down-arrow

Display the next command in the command history

Ctrl-P; up-arrow

Display the previous command in the command history

Ctrl-S

Search for a command in the command history

Ctrl-U

Delete complete line

Esc B

Move cursor back one word

Esc D

Deletes from cursor to end of the word

Esc F

Moves cursor forward one word

Tab

Complete the command or display alternatives if there is more than one possible command

Help

Command completion can be requested at any time by pressing the Tab key. This gives a list of the words that may be added to the command line, taking into account what has already been typed.

You can request help at any time by typing help or ? anywhere in a line. The depth of help information provided (eg. valid commands or parameters, or all available commands) depends on where you are in the CLI.

Viewing Long Reports

When a command generates a report (including help messages) that is more than one page long, the first page is displayed. Other parts of the report may be viewed by using the keystrokes shown in the next Table.

Keystroke

Function

B

Previous page

D or J

Down to next line

E or >

Advance to end of report

H or ?

Display this list

N or F or <Enter> or <Space>

Next page

P or <

Back to first page

Q

Quit report

R or <F5>

Redraw current page

U or K

Up to previous line


CLI Parameter Glossary

This section provides definitions for parameters used in the rest of this appendix to describe the commands and options of the CLI.

 

absolute_date

This defines an absolute time and date in the range 1970 to 2036. Unless it is explicitly mentioned, the time is relative to the current time zone.

The absolute_date parameter can include date and time, date only, or time only. When no time is entered, the system assumes a time of 00:00:00. When no date is entered, the system assumes the current date.

The date has three fields, day, month, year, which can be expressed in any of the common formats, with a `/' character separating each field:

·         Month may be a number, an abbreviated name of 3 characters, or the full name.

·         Year must consist of 2 characters.

If you use numbers for both the day and the month, a day number greater than 12 is an error. If you use a format that is unambiguous (that is, uses the name of the month rather than a number representing that month), you can express the date in any order (day/month/year, month/day/year).

Time is expressed as 00:00:00 (hours:minutes:seconds). The seconds field is optional.

Note:  If a time is given with no seconds then 0 seconds is assumed.

Time may be supplied either before or after the date, separated from it by a single '@ ' character, as shown in this example:

·         06:00:00@25/07/04

Note:  If a date is given without a time, the time is assumed to be 00:00:00. If a time is given without a date then the current date is assumed. If a time is given with no seconds then 0 seconds is assumed.

bytes

The number of bytes may be an integer or a real number followed by a multiplier letter (case is ignored) to multiply the given number by powers of 1024. The multipliers are:

k

1024

M

10242

G

10243

T

10244

ip_host

A network node that can be defined using either its IP address or  host name. If a host name is used, it is resolved to its IP address to ensure that the name is valid.

ip_mask

An IP number and a netmask. This parameter can take two forms:

·         ip_numb/mask

where /mask is a netmask size (see netmask)

·         ip_numb netmask

where ip_numb defines the IP address and netmask defines the netmask (see netmask)

ip_numb

An IP number in the conventional dotted quad format, as shown in this example:

192.193.194.195

level

Some commands take an event log level (also known as a severity). These levels are listed here from most severe (highest) to least severe (lowest).

·         Fatal

·         Serious

·         Error

·         Warning

·         Information

·         Audit

*_lists

Some parameters are described as lists, which are supplied by entering the list of elements separated by spaces. Normally, the list is the last thing on a line; when it's not, the next parameter must be introduced by a fixed label to distinguish it from being part of the list.

netmask

A netmask splits an IP number into a network part and a host part. A netmask consists of a bit mask that starts with a set of bits at 1 followed by a set of bits at 0. It may not have 1s and 0s mixed up.

A netmask can be represented two ways. The examples shown here refer to the same netmask:

/23

The number of bits set in the network part.

255.255.254.0

The set bits displayed in the same way as an IP number

percentage

This is a number followed by a '% ' sign. Percentages allow both integers and numbers with decimal points.

relative_period

This defines a period of time that is usually added to or subtracted from a time or date.

Note: Application of the relative_period parameter is described in the relevant command section of this appendix.

The relative_period is expressed as a number followed by an upper or lower case letter which indicates the units to which the number refers. The letters are:

S

Seconds

M

Minutes

H

Hours

D

Days

W

Weeks

For example:

90m (or 90M) expresses 1 hour 30 minutes.

3h (or 3H) expresses 3 hours

Only a single value can be entered.

When the relative period is to be subtracted, the sign of the relative_period parameter is ignored. When the relative period is to be added, the sign of the relative_period parameter is used; however, an error is generated if it is illegal to have a negative relative period for that command.


Setup Wizard

The Setup Wizard runs if the system is in factory default state when the CLI is started. You can also run it with the setup command. The Setup Wizard helps you enter the information required to connect the system to a local network.

The Setup Wizard steps you through a set of questions. In addition to typing in the answers to the questions, you can also use three commands, as shown in this Table:

Command

Function

Abort

Quit the Setup Wizard without changing anything

Back

Go to previous question

Help

Describe the current options

If a question has a predefined or default answer, the answer appears in square brackets
[ ]. Some options take an arbitrary string, in which case the commands back and abort cannot be used. In those circumstances, enclose the answer in double-quotes " " so that the answer will be accepted even if it is the same as a command. 

hostname

Supply the name by which the system is to be known.

The special BACK command here repeats this prompt.

domain name

Supply the domain in which the system belongs.

SAN name

Supply the Storage Area Network in which the system belongs.

timezone

Supply the system time zone.

system Date

Supply the system date. The format is as for the absolute_date (see absolute date).

define administrator password

Define whether an administrator password is required. If a password is required, you are prompted for that password, which must be supplied twice.

Press Ctrl to leave the password unchanged.

Press Return (or Enter ) twice to require no administrator password.

define operator password

Define whether an operator password is required. (See define administrator password for instructions on entering this information.)

dhcp

Reply yes or no to determine whether DHCP should be used to discover the system's network values.

If you enter yes, the wizard takes you to the Save new configuration question (see save new configuration). If you enter no, the wizard continues with questions about the system's main ethernet interface.

IP address

Enter the IP number to use in the format described in ip_numb.

Alternatively, the netmask (see netmask) may be defined by entering its width after the IP number. (See the interface manage commands for more information.)

netmask

Define the size of the netmask. Any of the common formats are accepted, as described in netmask.

Note:  If you entered the netmask as part of the previous IP address, this question is skipped.

broadcast address

Enter the address to be used for broadcasts. You can use any of the forms described for the interface manage interface broadcast command.

default gateway

Enter the name or IP number of a router to which packets for destinations that do not have routes defined for them in the system should be sent. Enter None to clear the default gateway.

DNS servers

Enter the IP numbers of up to 3 systems that will act as DNS servers. Enter None to clear the list of DNS servers.

save new configuration

When the Setup Wizard has finished, the system is configured but the new configuration is not saved immediately in non-volatile memory. Enter yes to save the configuration immediately, or no to defer saving the configuration.

The save command saves the configuration.

Finish?

Enter yes to apply the values you have entered, or no to return to the first question and change the values you have entered.


Administrator Command

Use this command to enter administrator level. If a password has been defined, you are prompted for that password.

This command is a global command and is always available.

Note: The factory default password is passw0rd (note the number zero not the letter O). For security reason you should change the PW.


Array Commands

These commands control device arrays. They are available after the global array command, or as global commands by preceding them by array.

Command

Parameters

Levels

create

name [remote] raid_level [options] device_list

administrator

migrate

[array] raid_level [stripe_depth]  device_list

 

Destroy

unused_or_alien_array_list (requires confirmation)

administrator

export

name_list (requires confirmation)

administrator

failback

 

administrator

Identify

[start | stop] name_list

all

import

foreign_array_list

administrator

info

[name_list]

all

list

[local | foreign | virtualized | alien | remote]

all

manage

name (See Array manage array commands)

all

move

local | remote name_list

administrator

Rebuild

RAID_array device_list

administrator

Unused

 

all

Verify

start | stop

administrator

Verify

status

administrator

Verify

rate high | low | medium

Administrator

create name [remote] raid_level [options] device_list

Create a new array called name with no RAID and enter a list of devices to add to the new array. The name must not be the name of any other array.

create name raid0 stripe-depth device_list

Create a RAID 0 array with the specified stripe depth and devices. You must specify at least two devices.

create name raid1 device_list

Create a RAID 1 array with the two specified devices. You must specify exactly two devices.

create name raid5 stripe-depth device_list

Create a RAID 5 array with the specified stripe depth and devices. You must specify at least three devices.

create name raid10 stripe-depth device_list

Create a RAID 10 array with the specified stripe depth and devices. Devices are automatically grouped into pairs, and therefore must always be an even number.

create name  raid50 stripe-depth device_list group num_group

Create a RAID 50 array with the specified stripe depth and devices. You must specify at least six devices and arrange them into groups. The number of groups is specified by the group parameter.

migrate name raid0 stripe-depth device_list

Migrate a RAID 0 array with the specified stripe depth and devices. You must specify at least two devices.

Migrate name raid5 stripe-depth device_list

Migrate a RAID 5 array with the specified stripe depth and devices. You must specify at least three devices.

migrate name raid10 stripe-depth device_list

Migrate a RAID 10 array with the specified stripe depth and devices. Devices are automatically grouped into pairs, and therefore must always be an even number.

destroy unused_or_alien_array_list

Destroy the listed arrays. When the arrays are destroyed, the disks and RAID groups associated with them become available for use.

Note:  Arrays assigned to logical drives cannot be destroyed. Foreign arrays must be imported before they can be destroyed.

An alien array is an array with an incomplete or corrupted signature that cannot be used.

export name_list

Export the arrays in name_list. When these arrays are exported, the disks in those arrays are no longer available.

If all of the disks in a array are transferred to another system, they can be used in that system after you complete an array import. (See import name_list.)

array failback

Return all storage to its original controller, if it has been moved (failed over). The original controller, from which the array was removed, must be functional again before you use this command.

identify [start | stop] name_list

Identify the devices that make up the arrays in name_list, or all of the disks that are assigned to any array if name_list is not supplied.

Disks are identified by flashing LEDs; flashing continues for 30 seconds or until an array identify stop or device identify stop command is given for that disk.

import foreign_array

Import a set of disks that have been assigned to an array in this or another unit and subsequently exported using the array export command.

Note:  All of the disks that make up the array must be present for this command to be successful.

info [name_list]

Show information about arrays. If a name_list list is not supplied, all of the arrays are included. Specify arrays by providing a name_list list.

For a single array, this command is the same as the array manage name info command.

list [local | foreign | virtualized | alien | remote]

List all of the known arrays. (Minimal information about each is also included.) If no parameters are entered, all arrays are listed. You can also limit the list to only foreign, or alien, or only local arrays.

move local | remote array_list

Change the ownership of an array to either the remote or local controller. If the remote keyword is specified, only arrays on the local controller may be specified. If the local keyword is specified, only arrays on the remote controller may be specified.

rebuild name device_list

Rebuild an array that has had devices replaced. The new set of devices must be specified in its entirety.

unused

List all of arrays that are not associated with a logical volume.

Array verify commands

These commands control array verifications.

Command

Parameters

Levels

verify

start | stop

administrator

status

 

administrator

rate

high | low | medium

administrator

array verify start | stop

Begins a parity check and corrects parity information where deficient. All arrays are checked.

array verify status

Indicates whether a verification check is in progress, and reports the speed at which it is running.

array verify rate high | low | medium

Sets the speed of a running verification check.

Array manage array commands

These commands control a specific array. They are available after the global array manage array command, or as global commands by preceding them with array manage array, or from the array context by preceding them by manage array.

Command

Parameters

Levels

cache

read enable | disable

administrator

identify

[start | stop]

administrator

info

 

all

spare

add unused_device_list | list | remove device_list

all

task abort

 

administrator

task rate

 high | medium | low

administrator

verify

 

administrator

identify [start | stop]

Blink the LEDs of the disks which make up this array.

cache read enable | disable

Either enable or disable the hardware cache for this array.  The global Cache command settings take precedence over that of the arrays’.

info

List details about the array, such as its type and which devices it includes.

spare add unused_device_list | list | remove device_list

Add one or more spare devices, list all spares, or remove the specified spares.

task abort

Aborts whatever task is running on the array.

task rate

Sets the speed of whatever task is running on the specified array (building, rebuilding, resynchronizing, or verifying).

verify

Verifies the specified array.

Array spare commands

These commands control the management of global hotfix devices.

Note:  Use the array manage array spare commands to manage hotfix devices for individual arrays. (See cache boolean.)

Command

Parameters

Levels

add

device_list

administrator

list

 

all

remove

device_list

administrator

add device_list

Add the specified devices to be used as global hotfix devices.

list

List the global hotfix devices.

remove device_list

Remove the list of devices from the global hotfix devices.


Authentication Commands (iSCSI Only)

Use the authentication commands to manage user access to the system's targets.

You can use these commands after the authentication command with no parameters, or as global commands by preceding them with authentication .

Command

Parameters

Levels

add

name

administrator

info

 

all

list

 

all

password

name

administrator

remove

name_list

administrator

add name

Add a new user called name. Enter the password when prompted.

info

List information about authentication options.

list

List the known users.

password name

Change the password for the specified user name. Enter the password when prompted.

remove name_list

Remove the listed users.

 

Cache Commands

These commands manage the caching policy of arrays.

Command

Parameters

Levels

info

 

all

policy

array | logical boolean

administrator

info

Output information about caching policies.

policy array [enable | disable]

Set the caching policy for arrays. This setting overrides the cache settings of the arrays.


Controller Commands

These commands output device, array, and interface information, and manage the settings of the current controller on a dual-controller machine.

Command

Parameters

Levels

info

 

All

set

controller

Administrator

Ipfailover   *iSCSI only

local | remote | both | none

Administrator

peer

enable | disable

Administrator

info

Display information about the current controller, as shown in this example:

----[ Controller ]---------------------

Logged into controller:  B

Working on controller:  B

Peer controller is:  Present (not held in reset)

Peer controller status:  Ready

iSCSI IP failover policy:  remote

‘Logged into controller’ means the controller that the Telnet or serial session was started on.

The ‘Working on’ controller can be changed with the controller set command.

controller set controller

Set the current controller. The controller value can be A or B. The current Telnet or serial session will remain logged into the controller it started with.

ipfailover local | remote | both | none

 (iSCSI only) Set the policy for the failover of iSCSI interfaces, using these options:

local—if an interface fails, an interface on the same controller will be chosen if possible (ETH2ŕETH3 or ETH3ŕETH2).

remote—if an interface fails, an interface on the other controller will be used (ETH2ŕETH2 and ETH3ŕETH3)

both—if an interface fails, attempt to failover to an interface on the same controller (ETH2ŕETH3 or ETH3ŕETH2). If an interface on the same controller cannot be used, an interface on the other controller will be used (ETH2ŕETH2 and ETH3ŕETH3).

none—no failover of iSCSI interfaces will be attempted.

Note: The default setting is Remote failover option.

peer enable | disable

Specify enable to bring up the other controller.

Specifiy disable to take down (halt) the other controller. This takes a while, so you must keep looking at 'controller info' to  check on the status of the other controller.


Device Commands

These commands control device discovery. You can use these commands after a device command with no parameters, or as global commands by preceding them by device.

Command

Parameters

Levels

identify

[device_list] [start | stop]

all

info

[device_list]

all

initialise

[local_device_list]

all

list

 [foreign] [spare]

all

manage

device (See Device manage device commands)

 

unused

 

all

identify [device_list] [start | stop]

Identify one or more devices by blinking their LED.

The default action is to start the LED blinking and return to the prompt. The LED will stop blinking after about 30 seconds or when a device identify stop or array identify stop command is given for that device.

To identify all of the disks in an array, use the array identify command.

info [device_list]

Output information about some or all devices. (You can specify which devices by entering a parameter for device_list.

This command is identical to the device manage device info command (see Device manage device commands) when only one device is specified.

initialise [local_device_list]

Remove all array membership information for the local devices in local_device_list.

list [foreign] [spare]

List the known physical and/or spare devices. All devices are listed if no parameters are specified.

unused

List any devices which have not been allocated to an array volume.

Device manage device commands

These commands control devices that are found using device discovery. You can use these commands after a device manages device command with no parameters, or as global commands by preceding them with device manage device.

Command

Parameters

Levels

info

 

all

identify

[start | stop]

all

info

List details about this device.

identify [start | stop]

Identify the specified device. (See identify [device_list] [start | stop] for a description of options.)

 

Diagnostics Commands

These commands run diagnostics tests. They are available after a diagnostics command with no parameters, or as global commands by preceding them with diagnostics.

Command

Parameters

Levels

loopback   *FC only

port  continual | iterations   [stop]

administrator

dump

xmodem | 1kxmodem

administrator

ping

host [timeout time] [count number] [interface interface]

administrator

tracert

host

administrator

loopback FC port iterations | [continual] [stop]

Perform a loopback test on the specified FC port.

The iterations parameter specifies the number of times this test is performed.

Use the continual option to have the test performed continuously.

The stop option will cause the test to be halted immediately an error is detected.

Press Esc to abort the test. Press Return (or Enter) while the test is running to output ongoing results.

dump [1kxmodem] [xmodem]

Send a diagnostics dump.  The diagnostic.bin file is created and sent to the host.

This file is the same file that is generated from the ServeRAID manager when “Save Support Archive” is selected from the controller pop-up menu.

To save the file, do the following from a CLI prompt using the left most Serial Port:

DS300[A] (diagnostics)# dump 1kxmodem

Creating the dump file: 145.10kB

Issue the 1kxmodem command to start the transfer ŕ at this time select “receive” from the Terminal application menu (Hyperterminal).

Diagnostics dump was successfully sent

From a Telnet session:

DS400 (diag)# dump xmodem ŕ press enter

Creating the dump file:  0kB    ŕ at this time select “receive” from the Telnet File menu

Creating the dump file:      0 B  Diagnostics dump was successfully sent

ping [timeout time] [count number] host [interface]

Check the connectivity from a port to the specified network node. Each ping attempt result is reported immediately. A line is output for each ping attempt.

The optional timeout option defines the number of seconds to try each ping attempt (default 1 second). The time parameter is the number of seconds.

The optional count parameter defines the number of times to attempt the ping if an attempt fails (default 1)

The command returns immediately if a ping attempt succeeds; otherwise, the delay is approximately the product of time and number.

tracert  host

Trace the route to a host on the network. You can terminate this command with Ctrl-C.


End Command

If you are in a context, use this command to leave that context and return to the previously active context.

Note:  This command is not valid from the global context.


Events Commands

These commands control reporting events. You can use these commands after the events global command with no parameters, or as global commands by preceding them with events.

Command

Parameters

Levels

clear

 

administrator

inactive

all | parameters (See Events inactive Commands.)

administrator

info

 

all

report

all | parameters (See Events report commands.)

 

clear

Clear the event log.

info

Display these values associated with the event log:

·         Size of the event log

·         List of actions for each level.

·         Current status which means the highest active severity level

Events inactive commands

These commands are used to remove the active state from the selected log entries. The commands can be executed as global commands by preceding them by events inactive or after the events global commands by preceding them by inactive.

Except for the all command, any number of these commands can be combined on a line to define the set of events that will be selected. Each command restricts the number of events that are selected.

The selected events will be listed and you will be asked for confirmation before they are set inactive. At least one command must be supplied for a report to be generated.

Command

Parameters

Levels

all

Cannot be combined with other parameters

administrator

from

absolute_date | relative_period

administrator

level

See list of valid levels.

administrator

originator

name

administrator

to

absolute_date | relative_period

administrator

all

Select every event. It must be the only command on the line.

from absolute_date | relative_period

Only report events which were generated at or after the time and date specified by the supplied value. All the reports from the specified time and date to the present will be reported unless the for or to commands further restrict the reported events to a range of dates and times.

The relative_period is the period before the current time and date.

level

See list of valid levels.

originator name

Only select events that were originated by name.

to absolute_date | relative_period

Restrict the events that are selected to those which occurred before the date and time given by the value. All reports from the oldest stored event up to the supplied time and date will be reported unless the from command is also supplied to define the earliest event to report.

The relative_period is back from the current time and date.

Events report commands

These commands are used to generate event log reports. These commands can be executed as global commands by preceding them by events report, or when in the events context by preceding them by report.

Command

Parameters

Levels

active

boolean

all

all

 

all

for

relative_period

all

from

absolute_date | relative_period

all

level

level | [ level ]-[ level ]

all

long

 

all

originator

name

all

to

absolute_date | relative_period

all

These commands take exactly the same options as the Events Inactive commands. (See Events inactive commands.) In addition, these commands are permitted:

·         active boolean

Only include active events in the report if the boolean value is enable ; or only include events that are not active if the boolean value is disable .

·         long

Display the long text associated with each event. The associated short text is always reported.


FRU Commands

These commands manage Field Replaceable Units (FRUs).

Command

Parameters

Levels

info

 

all

info

Output information about Field Replaceable Units.


Help | ? [all] | [global] | [help | ?] | [keys]

Without parameters, this command prints all commands that are available in the current context. Global commands are not included unless you are in the global context.

Use the global parameter to print all of the current context and global commands.

Use the keys parameter to list all of the key sequences which can be used when typing in commands.

Use the help or ? parameter to display help about the help command.

Use the all parameter to list all the information described in this section.


Image Commands

Image commands manage the images used to boot the system. These commands are available after the image global command, or can be run as global commands by preceding them by image.

Command

Parameters

Levels

boot

image number

administrator

info

 

all

list

 

all

upload

1kxmodem | url

administrator

boot image_number

Set the numbered image as the image to use the next time the unit is rebooted.

Note:  If the image_name of the available images is not unique, the image_number must be used.

info

Display information about the current images. This is the same as the show images command.

----[ System firmware images ]------------------------------

 
 

Image 1 name:

SWR-00031-01{Z.AA}

Build date:

11/11/02

Image 2 name:

SWR-00031-01{2.01}

Build date:

29/10/02

Current image:

[1] SWR-00031-01{Z.AA}

Image to use at the next boot:

[1] SWR-00031-01{Z.AA}

list

List the names and numbers of the available images. The list consists of lines in this format:

[1]

SWR-00031--1{Z.AA}

where the number in the square brackets [ ] is the image number (in this example, 1 ), and the text is the image's name (in this example, SWR-00031{Z.A} ).

 

upload 1kxmodem

Upload a new image to be used the next time the unit is rebooted. If the upload is successful the new image will be used the next time the unit is booted and the current image is set as the alternative.

Issue the 1kxmodem command to start the transfer ŕ select “send” from the terminal application menu (Hyperterminal).

upload url

Upload a new image to be used the next time the unit is rebooted. If the upload is successful the new image will be used the next time the unit is booted and the current image is set as the alternative.

The url option gives the URL which the unit will access to download the new image. The url can take any of the common formats:

·                   http:// host:port/pathname

·                   http:// host/pathname

·                   ftp:// host/pathname

Initiator Commands (iSCSI)

Note:  For information on initiator commands for FC, see Initiator Commands (FC).

These commands are used to manage remote iSCSI initiators. They are available after the initiator global command, or as global commands by preceding them by initiator.

Note:  Remote iSCSI initiators are also implicitly created by other commands.

Command

Parameters

Levels

create

Name   iqn  [ options ]

administrator

destroy

initiator_list

administrator

info

[ initiator_list ]

all

list

 

all

local

 

all

manage

initiator (See initiator manage initiator commands )

 

 

 

create name iqn [align boolean] [piggyback boolean ]
[ping boolean]

Create a new remote iscsi initiator with the local name where iqn is the IQN of that initiator.

The align, piggyback and ping parameters set up initial values for the initiator's attributes. By default, the align parameter is enabled, the piggyback and ping parameters are disabled. For more information, (see initiator manage initiator commands ).

destroy initiator_list

Destroy the remote iscsi initiators in the initiator_list list. This removes all references to these initiators from any targets or other entities which refer to them.

info [name_list]

Output information about all specified remote iSCSI initiators

Including only one initiator in the name_list list produces the same results as using the iscsi initiators manage initiator info command.

list

List all of the known remote iSCSI initiators.

local

Display IQN of local system's initiator.

initiator manage initiator commands

These commands manage remote iSCSI initiators. These commands are available after the global initiator manage initiator command, from the global context by preceding them by initiator initiator, or from the iSCSI initiators context by preceding them with manage initiator.

Command

Parameters

Levels

noalign

enable | disable

Administrator

info

 

All

piggyback

enable | disable

Administrator

ping

enable | disable

Administrator

align enable | disable

Change whether Protocol Data Units (PDUs) should be aligned on Ethernet frames

info

Output information about this remote iSCSI initiator, including which other entities (such as targets) refer to it.

piggyback enable | disable

Change the piggyback SCSI status of this remote iSCSI initiator.

ping enable | disable

Change whether to ping periodically to test the connection.


initiator commands (FC)

These commands are available after the initiator global command and are used to manage remote FC initiators. They can also be run as global commands by preceding them by initiator .

Note:  Remote FC initiators are also implicitly created by other commands.

Command

Parameters

Levels

create

name WWN

administrator

destroy

initiator_list

administrator

info

[ initiator_list ]

all

list

 

all

manage

initiator (See initiator manage initiator commands )

 

mode

lunmapped | auto

administrator

create name WWN

Create a new remote FC initiator with the local name where WWN is the port WWN of that initiator.

destroy initiator_list

Destroy the remote FC initiators in the initiator_list list. This removes all references to these initiators from any volumes or other entities which refer to them.

info [name_list]

Output information about all specified remote iSCSI initiators

Including only one initiator in the name_list list produces the same results as using the iscsi initiators manage initiator info command (see initiator manage initiator commands).

list

List all of the known remote FC initiators.

initiator manage initiator commands

These commands manage remote FC initiators. These commands are available after the global initiator manage initiator command, from the global context by preceding them by initiator initiator, or from the iSCSI initiators context by preceding them with manage initiator .

Command

Parameters

Levels

add

logical LUN

administrator

allow

FC_Port | all

administrator

deny

FC_port | all

administrator

info

 

all

move

old_LUN  new_LUN

administrator

remove

LUN

administrator

rename

new_name

administrator

The maximum number of supported LUN mappings per FC initiator is 256. LUNs are numbered 0-255.

add logical LUN

Map a volume to appear as LUN LUN to the specified initiator.

allow FC_port | all

Allow access to the specified initiator on the FC port FC_port , or on all ports

deny FC_port | all

Deny access to the specified initiator on the FC port FC_port , or on all ports

info

Output information about the specified remote FC initiator.

move old_LUN new_LUN

Change the mapping of a volume to a new LUN.

remove LUN

Remove the mapping that contains LUN LUN .

rename old_name new_name

Give a FC initiator a new user label.


Interface Commands

These commands are available after the interface global command has been executed and deal with interface options in general. They can also be run as global commands by preceding them by interface .

Command

Parameters

Levels

failback

[failed-over_interface_list]

all

info

[ interface_list ]

all

list

 

all

manage

interface (See interface manage commands)

 

statistics

[ interface_list ]

all

Interfaces are specified by their hardware names (such as eth0 ), unless you have renamed them using the interface rename command (see rename name).

failback [failed-over_interface_list]

If the IP addresses of any iSCSI interfaces have been transferred (failed over) to another interface because of problems, this command will restore them to their original interface (assuming the problems have been fixed).

info [interface_list]

Output details about the specified interfaces including statistics. If no interface_list parameter is supplied, the details about all of the interfaces are output.

See the interface manage commands for more information.

list

Output a list of the known interfaces and their state

statistics [interface_list]

Output statistics about the specified interfaces. If no interface_list parameter is supplied the statistics for all of the interfaces are output.

See statistics for more information about what is displayed by this command. 

interface manage commands

Use commands to manage network interfaces. These commands are available after the interface manage interface global command, and can also be run as global commands by preceding them by interface manage interface, or from the interface context by preceding them with manage interface.

Note:  If DHCP is enabled for the interface, these commands may store values that will be used when DHCP is disabled. They do not override the values supplied by DHCP.

Command

Parameters

Levels

broadcast 2

broadcast

administrator

dhcp

enable | disable

administrator

down

 

administrator

failback

 

administrator

info

 

all

ip 1

ip_address [ip_mask ]

administrator

mtu

mtu

administrator

netmask 1

netmask

administrator

rename

name

administrator

speed

10 | 100 | auto

administrator

statistics

 

all

Up

 

administrator

 

1. There may be a few exceptions, such as file names, where case is significant.

2. May be combined. Resets interface.

broadcast broadcast

Set the broadcast address. An explicit value may be given in the conventional way, for example 192.112.28.255 . Alternatively, the special values listed in the Table above may be entered. These will look at the current address and netmask and deduce the value to use. The value high sets all of the bits in the host part and the value low clears them.

This command may be combined with the ip and netmask commands on a single line. The ip command describes the default value for this option if just the IP number is changed

If DHCP is enabled this command changes the stored value which will be used if DHCP is disabled. It does not change the actual value of the interface if DHCP is enabled otherwise it resets the interface.

info

Show the details about the interface. This includes:

·         IP number

·         Netmask

·         Broadcast address

·         MAC address

·         Whether DHCP is enabled

·         Whether it is configured (up)

·         The interface's speed.

If DHCP is enabled the output will show the active values for the interface plus the values which will be applied if DHCP is disabled.

dhcp enable | disable

Either enable or disable DHCP depending on the value of the boolean parameter.

ip ip_address [ip_mask]

Specify the IP number for the interface.

Optionally, the netmask may be set at the same time by adding the ip_mask value, which defines the number of bits that make up the network. Alternatively, the netmask can be defined by adding the netmask command to the same line.

This command may be combined with the broadcast and netmask commands on a single line. If they are not given, default values will be deduced from the address supplied.

If DHCP is enabled, this command changes the stored value which will be used if DHCP is disabled, but otherwise does not change the actual value of the interface. If DHCP is disabled, this command resets the interface.

mtu mtu

Specify the size of the Maximum Transmission Unit (MTU) for the interface. Press Tab to see a list of acceptable size values.

netmask netmask

Set the interface's netmask to be the value supplied.

This command may be combined with the ip and netmask commands on a single line. The ip command describes the default value for this option if just the IP number is changed.

If DHCP is enabled, this command changes the stored value which will be used if DHCP is disabled, but otherwise does not change the actual value of the interface. If DHCP is disabled, this command resets the interface.

rename name

Specify a new name for the interface.

speed 10 | 100 | auto

For devices that can auto-negotiate their speed, clamp their speed to a specified value.

A value of auto will re-establish auto-negotiation if the device is capable of doing that. The full option is not valid with auto.

statistics

Display these statistics for the open interface:

·         Number of collisions

·         Number of transmitted packets with breakdown of failures

·         Number of received packets with breakdown of failures.


iSNS Commands (iSCSI Only)

These commands manage iSNS configuration.

Command

Parameters

Levels

info

 

all

server

clear | isns_server

administrator

info

Output information about the iSNS server.

server hostname | IP_address | clear

Set or clear the iSNS server.


License Commands

These commands manage setting and displaying the license key.

Command

Parameters

Levels

info

 

all

set

 [xxxx- xxxx- xxxx- xxxx- xxxx- xxxx]

administrator

info

Output the license key, detailing enabled and disabled features.

set

Set a new license key.

Logical Commands (iSCSI)

 

These commands control the iSCSI logical drives. They are available after the global logical command. They may also be used as global commands by preceding them by logical.

If the logical drive is a mirror set or snapshot, you can use these commands after the global mirror and snapshot commands, or by preceding them by mirror or snapshot.

Command

Parameters

Levels

chap user

[clear | chap user] | info | password

administrator

create

logical_drive_name  available_array available |  size restricted | unrestricted

administrator

destroy

logical_list

administrator

down

logical_drive_up

administrator

info

[logical_list]

all

list

 

all

manage

logical (see logical manage logical commands )

 

up

logical_drive_down

administrator

chap user [clear | chap user] | info | password

Manage Challenge Handshake Authentication Protocol (CHAP) details for logical drives. Enter chap user to display the current username for CHAP authentication. Enter chap user username to set a new username. Enter chap password to prompt for a new password.

create logical_drive_name available_array available |  size restricted | unrestricted

Create a new logical drive with a user name of logical. The IQN name that the initiator uses to access this logical drive is automatically generated. The character set used for a logical drive must be the character set which is valid for an IQN.

The logical drive takes its space from the named array. Size is entered in bytes, as a percentage of the total size of the pool. If the size is not specified, all of the available space in that pool is used.

The Access Control must be explicitly defined using the restricted or unrestricted option. If you enter restricted, you must also enter a list of initiators which will be used to define the initial ACL.

destroy logical_list

Destroy the named logical drives.

down logical_drive_up

Take down the named logical drives.

info [logical_list]

Show information about all of the logical drives if a logical_list list is not supplied, or just the named logical drives if it is supplied. For single logical drives, this command is the same as the logical logical info command.

up logical_list_down

Bring up the named logical drives

list

List the logical drives known to the system.

logical manage logical commands

These commands manipulate the attributes of the specified logical drive. They are available after the logical manage logical command, or can also be run as global commands by preceding them by logical manage logical or by manage logical from the logical context.

Command

Parameters

Levels

allow

[ro] initiator_list

administrator

authentication

SRP | CHAP| none

administrator

deny

initiator_in_ACL

administrator

down

 

administrator

growby

size

administrator

growto

size

administrator

info

 

All

interface

all | interface_list

administrator

rename

name

administrator

restricted

 

administrator

scope

scope_list

administrator

sessions

parameters

administrator

size

bytes

administrator

unrestricted

 

administrator

allow [ro] initiator_list

Enter initiators to be added to the list of initiators that can access this logical drive

authentication SRP | CHAP | none

Specify the authentication to use for this logical drive.

deny initiator_in_ACL

Enter initiators to be removed from the list of initiators that can access this logical drive.

down

Take down this logical drive.

growby size

Grow the logical drive by the amount specified.

growto size

Grow the logical drive to the amount specified.

info

Output information about this logical drive.

interface all | interface_list

Redefine the list of interfaces that can be used to access this logical drive. The keyword all selects all of the interfaces.

Note:  Not all interfaces can be used for logical drives. If you select an interface that is unavailable for use, access is denied although no error is generated.

rename name

Enter a new name (iSCSI alias) for the specified logical drive.

restricted

Activate the logical drive's ACL.

Activating the ACL restricts access to the logical drive to only those initiators defined by the logical manage logical allow command.

scope scope_list

Redefine a new list of scopes to which the logical drive should belong. A logical drive is always in the DEFAULT scope.

sessions info | list | reset session_ids

Manage active iSCSI sessions. The info parameter shows detail information for iSCSI sessions; list displays a list of sessions; reset shuts down the specified sessions, or all sessions if none are specified.

unrestricted

Disable the logical drive's ACL. Disabling the ACL allows unrestricted access to this logical drive.


Logical Commands (FC) 

These commands control the FC logical drives. They are available after the global logical command, or as global commands by preceding them by logical.

Command

Parameters

Levels

clear

logical_drive

administrator

create

logical_drive available_array available |  size

administrator

destroy

Logical

administrator

info

[logical_list]

all

list

 

all

manage

logical (see logical manage logical commands)

 

clear logical_drives

Clear the ACL on a list of logical drives.

logical_drive available_array available |  size

Create a new logical drive with a user name of name. The logical drive takes its space from the named array. If the available option is entered, all of the available space in that array is used. If the size option is used, the size parameter is the size in bytes.

destroy logical_list

Destroy the named logical drives.

info [logical_list]

Show information about all of the logical drives if the logical_list list is not supplied, or just the named logical drives if it is supplied. For a single logical drive, this is the same as the logical target info command.

list

List the logical drives known to the system.

logical manage logical commands

These commands manipulate the attributes of the specified logical drive. They are available after the logical manage logical command, or can also be run as global commands by preceding them by logical manage logical or by just manage logical from the logical context.

Command

Parameters

Levels

growby


size

administrator

growto


size

administrator

info

 

all

rename

new_name

administrator

growby size

Grow the logical drive by the amount specified by size.

growto size

Grow the logical drive to the amount specified by size.

info

Output information about this logical drive.

rename logical

Enter a new name for this logical drive.


Network Commands

These commands control aspects of the unit's identity on the network. They are available after the network command has been typed. They can also be run as global commands by preceding them with network.

Command

Parameters

Levels

dns

ip_list | clear

administrator

domain

name

administrator

gateway

ip_host | clear

administrator

hostname

name

administrator

info

 

all

ntp

ip_host | clear

administrator

sanname

name

administrator

smtp

host host  port port | clear

administrator

 

dns ip_list | clear

Define a new list of DNS servers where ip_list is a list of up to three IP numbers of name servers to use. It replaces the previous list. If a disable value is given instead of IP numbers, the list of DNS servers is cleared.

domain name

Set the DNS domain name to be name.

This command may be combined with the hostname command on the same line to configure the network details in one command. The order of the commands does not matter.

gateway ip_host | clear

Set the gateway network node (or default route) for the unit.

The parameter may be the name or IP number of a router to use as the default gateway or a disable value if there is no default gateway.

hostname name

Set the host name of this unit. When added to the domain it gives the fully qualified network name.

This command may be combined with the domain command on the same line to configure the network details in one command. The order of the commands does not matter.

info 

Do a dump of all network information.

ntp ip_host | clear

Set the NTP server to be ip_host . For no NTP server a valid disable value should be given. If the ip_host name is a valid string for a disable value enclose the ip_host string in "" characters.

sanname name

Set the name of the Storage Area Network.

This command may be combined with the domain command on the same line to configure the network details in one command. The order of the commands does not matter.

host host  port port | clear

Set the SMTP server to use. Optionally, the port can be specified. If the port is not specified, the value is not changed; if the port is given as 0 , the default port number of 25 is used.

If a disable value is supplied instead of a host, the SMTP server name will be cleared.


Operator Command

Use this command to go from the current level to operator level. If a password has been defined for operator level, enter it when prompted.


Password operator | administrator Command

Use this command to define a new password to enter the operator or administrator level, or remove the password requirement.

This command prompts for the password twice. If you enter no password and press Return (or Enter ) twice, the password requirement is removed for that level.

To leave the existing password unchanged, type CTRL-C at either one of the password prompts.

The old password is not displayed after this command but does indicate whether the password has been changed or not.


Port Commands (FC Only)

These commands control FC ports. They are available after the global port command, or as global commands by preceding them with port.

Command

Parameters

Levels

identify

Port  iterations continual | iterations

administrator

info

[ports]

all

list

 

all

manage

(See Port manage port commands)

 

 

Note:  FC ports are numbered A0, A1, B0, B1, where A and B refer to the controller they are on.

identify port iterations continual | iterations

Flash the LEDs of the specified port. If continual is entered, the LEDs remain flashing until you press Esc. If continual is not entered, the iterations value specifies the number of flashes.

info [port_list]

Show port information. Include all ports by not entering a port_list list. Include only the named ports by entering a port_list list.

For a single port, this command is the same as the port manage port info command.

list

List the FC ports known to the system.

Port manage port commands

These commands manipulate the attributes of the specified port. They are available after the port manage port command, or as global commands by preceding them with port manage port or manage port from the port context.

Command

Parameters

Levels

alpa

AL_PA enable | disable

administrator

info

 

all

speed

1g | 2g | auto

administrator

topology

topology

administrator

alpa AL_PA | enable | disable

Configure the hard AL_PA (Arbitrated Loop Port Address) of the specified port, or enable or disable its use. The change will take effect after a system reboot.

info

Get information about the managed port.

topology topology

Configure the topology of the specified port.

The permissible values are auto , f_port , fl_port , and loop .

The change will take effect after a system reboot.


Quit Command

Exit the CLI.


Route Commands

These commands control static routes. They are available after the global route command. They may also be used as global commands by preceding them by route.

Command

Parameters

Levels

add

parameters

administrator

delete

parameters

administrator

info

 

All

add ip/mask gateway

Add a static route that goes to the network defined by the combination of destination and netmask via the given gateway. gateway may be an IP number or a resolvable machine name (as described for the ip_host parameter type). The netmask must be specified 192.193.194.0/24  format and the destination must be an IP number (as described for ip_numb ). If netmask is a seperate parameter, destination may be a resolvable machine name (as described for ip_host ).

An interface that is up and that does not use DHCP to get its IP number may be used instead of gateway. If you use such an interface, its IP number is used as the gateway address. Because the route is not associated with the interface, changing the interface's IP number doesn't change the route.

delete ip/mask

Remove the existing static route defined by destination and netmask . If there is only one existing route that matches destination and netmask , gateway is not required; but if it is supplied it must match the static route. If there are several static routes that match destination and netmask, gateway must be supplied to distinguish which static route to remove.

info

Display the current set of static routes plus the default gateway (if there is one). The default gateway is defined by a network command.


Save Command

Use this command to ensure that changes have been written to flash. Changes are normally written at a time chosen by the underlying libraries.


Scope Commands  (iSCSI only)

These commands manage scopes. They are available after the global scope command. They may also be used as global commands by preceding them by scope.

Command

Parameters

Levels

create

name [logical_drive_list ]

administrator

destroy

name_list

administrator

info

[ name_list ]

all

list

 

all

manage

name (See Scope Manage Scope commands)

all

create name [logical_drive_list]

Create a new scope called name which must not be the same as any other scopes. Optionally, add one or more targets to it immediately with the logical_drive_list list.

destroy name_list

Destroy the named scopes in the name_list list.

info [name_list]

Show information about all of the scopes if name_list is not supplied, or the scopes named in the name_list list if it is supplied. This is the same as the scope manage name info command if name_list consists of a single scope.

list

List all of the known scopes.

Scope Manage Scope commands

These commands control the logical drives in a specific scope. They are available after the global scope manage scope command. They may also be used as global commands by preceding them by scope manage scope or from the scope context by preceding them by manage scope.

Command

Parameters

Levels

add

logical_drive_list

administrator

info

 

All

remove

logical_drive_list

administrator

add logical_drive _list

Add the list of logical drives to the current scope.

info

Output information about the scope and its logical drives.

remove logical_drive _list

Remove the logical drives in the logical_drive_list list from the scope.


Service Commands

This command produces details about the services running on the system. It is available after the global service command or may be used as a global command by preceding it with service.

Command

Parameters

Levels

info

 

All

info

Output details about the services. The information output will include:

·         Name

·         Status


Show option Command

Use this command to display information about various parts of the system. These are the valid values for this option:

all

Use this value to ask for all the other options in this list

arrays

The same as array_info

authentication (iSCSI only)

The same as authentication list

cache

The same as cache info

devices

The same as device list

events

The same as events info

fru

The same as fru info

images

The same as image info

initiatiors

The same as initiators list

interfaces

The same as interface info

isns

The same as isns info

license

The same as license info

logicals

The same as logical info

networks

The same as network info

ports (FC only)

The same as port info

routes

The same as route info

scopes (iSCSI only)

The same as scope info

service

The same as service info

snapshot

The same as snapshot info

snmp

The same as snmp info

system

The same as system info

 


Snapshot Commands (iSCSI)

These commands manage snapshot logical drives. They are available after the global snapshot command, or as global commands by preceding them with snapshot.

A snapshot is a special logical drive, so many of these commands are identical to the same logical command. See Logical Commands (iSCSI) for more information.

Command

Parameters

Levels

create

parameters

administrator

destroy

snapshot_child

administrator

down

snapshot_child

administrator

info

[snapshot_child]

all

list

[ parent ]

all

manage

snapshot_child (See snapshot manage snapshot_child commands )

 

rollback

snapshot_child

administrator

up

snapshot_child

administrator

Note:  Only logical drives which have been created by the snapshot create command can be managed by these commands.

create name snapshot_parent [readonly] unrestricted | restricted [initiator_list]

Create a new snapshot of snapshot_parent to be called name using array.

The snapshot may be specified as restricted to a limited number of initiators (which you can specify in this command or specify later using the snapshot manage allow command) or it can be created as unrestricted. You can also specify access to be read-only.

The create command creates the logical drive, so logical must be a name not used by any other logical drive (of any type) before.

destroy snapshot_child

Destroys the snapshot of logical drives given in the snapshot_child list and frees the space from each facet's array.

info [snapshot_child]

Show information about all of the snapshot logical drives or the snapshot logical drives in the snapshot_child list.

Each snapshot logical drive will output the information shown by the logical info command.

list [ parent ]

List all snapshot logical drives. If the parent filter is supplied, only snapshot's parents will be listed.

rollback snapshot_child

Rolls back the snapshots in the snapshot_child list.

snapshot manage snapshot_child commands

These commands manipulate the attributes of the specified snapshot logical drive. They are available after the snapshot manage snapshot_child command. They can also be run as global commands by preceding them with snapshot manage snapshot_child or by just manage snapshot_child from the snapshot context.

Many of these commands are actually logical manage logical commands that can be applied to snapshot logical drives as well as to non-snapshot logical drives. See logical manage logical commands for detailed information.

Command

Parameters

Levels

allow

[ro] initiator_list

administrator

authentication

srp | chap | none

administrator

deny

initiator_in_ACL

administrator

growby

size

administrator

growto

size

administrator

info

 

all

interface

all | interface_list

administrator

rename

new_name

administrator

restricted

 

administrator

scope

scope_list

administrator

sessions

info | list | reset initiator

administrator


Snapshot Commands (FC)

These commands manage snapshot logical drives. They are available after the global snapshot command, or as global commands by preceding them with snapshot.

A snapshot is a special logical drive, so many of these commands are identical to the same logical command. See Logical Commands (FC) for more information.

Command

Parameters

Levels

create

parameters

administrator

destroy

snapshot

administrator

info

[snapshot]

all

list

[ parent ]

all

manage

logical (See snapshot manage logical commands)

 

rollback

snapshot_child

administrator

Note:  Only logical drives which have been created by the snapshot create command can be managed by these commands.

create name logical [readonly]

Create a new snapshot of logical to be called name using pool. The create command creates the logical drive so logical must be a name not used by any other logical drive (of any type) before.

The snapshot will be created using the same pool as logical, so enough space must be remaining in that pool.

destroy snapshot

Destroys the snapshot of logical drives given in the snapshot list and frees the space from each facet's array.

info [snapshot]

Show information about all of the snapshot logical drives or the snapshot logical drives in the snapshot list.

Each snapshot logical drive will output the information shown by the logical info command.

list [ parent ]

List all snapshots. If the parent filter is supplied, only snapshots' parents will be listed.

rollback snapshot_child

Rolls back the snapshots given in the snapshot_child list.

snapshot manage logical commands

These commands manipulate the attributes of the specified snapshot logical drive. They are available after the snapshot manage logical command. They can also be run as global commands by preceding them with snapshot manage logical or by just manage logical from the snapshot context.

Many of these commands are actually logical manage logical commands that can be applied to snapshot logical drives as well as to non-snapshot logical drives. See logical manage logical commands for detailed information.

Command

Parameters

Levels

growby

size

administrator

growto

size

administrator

info

 

all

rename

new_name

administrator


SNMP Commands

The SNMP command should not be used. SNMP should be configured using ServeRAID Manger on the Management Station.


System Commands

These commands set various aspects of the system. They are available after the system command has been typed. They can also be run as global commands by preceding them with system.

Command

Parameters

Levels

date

absolute_date | relative_period

administrator

defaults

 

administrator

halt

 

administrator

info

 

All

keyboard

layout

administrator

reboot

 

administrator

status

 

All

timezone

TZ

administrator

date absolute_date | relative_period

Redefine the time and/or date. The relative_period is relative to current time and date and is used to adjust the date and time.

This command can be called with no parameters in Operator mode.

defaults

Reset the system to its factory default state.

halt

Halt the system.

info

Display this information about the operating system:

·         BIOS version and date

·         Spitfire software version and date

·         Hardware serial number

·         Active boot image

·         Uptime since last boot

·         Current date, time and time zone

reboot

Halt the system and boot it again.

status

Display the current status of the unit. This indicates the highest active severity level.

timezone TZ

Change the timezone. A parameter starting with a ' + ' or ' - ' sign is the number of hours in front or behind Greenwich Mean Time (GMT); a parameter starting with a letter is the standard abbreviation for the requested time zone.

This command can be called with no parameters in Operator mode.