Usage Notes; Cli Commands; Command Name Syntax Conventions - IBM System Storage DS3000 Programming Manual

Usage Notes

If you enter SMcli and a storage subsystem name but do not specify CLI parameters, script commands, or
a script file, the command line interface runs in interactive mode. Interactive mode lets you run
individual commands without prefixing the commands with SMcli. In interactive mode, you can enter a
single command, view the results, and enter the next command without typing the complete SMcli string.
Interactive mode is useful for determining configuration errors and quickly testing configuration changes.
To end an interactive mode session, type the operating system-specific command for terminating a
program (such as Control-C on the UNIX operating system or the Windows operating system). Typing
the termination command (Control-C) while in interactive mode turns off interactive mode and returns
operation of the command prompt to an input mode that requires you to type the complete SMcli string.
If you enter an incomplete or inaccurate SMcli string that does not have the correct syntax, parameter
names, options, or terminals, the script engine returns usage information.

CLI commands

Conventions used in the command statement syntax to manage the storage subsystem are listed in the
following table:
Table 1-1. Command Name Syntax Conventions
Convention
(a | b | c)
italicized-words
[ ... ] (square brackets)
{ ... } (curly braces)
bold
General forms of the CLI commands follow, which show the terminals and the parameters that are used
in each command.
SMcli DNS-network-name-or-IP-address [DNS-network-name-or-IP-address]
[-c "command; {command2};"]
[-n storage-system-name | -w wwID]
[-o outputfile] [-p password] [-e] [-S] [-quick]
SMcli DNS-network-name-or-IP-address[DNS-network-name-or-IP-address]
[-f scriptfile]
[-n storage-system-name | -w wwID]
[-o outputfile] [-p password] [-e] [-S] [-quick]
SMcli (-n storage-system-name | -w wwID)
[-c "command; {command2};"]
[-o outputfile] [-p password] [-e] [-S] [-quick]
SMcli (-n storage-system-name
[-f scriptfile]
[-o outputfile] [-p password] [-e] [-S] [-quick]
SMcli -a email: email-address [host-name-or-IP-address1
[host-name-or-IP-address2]]
[-n storage-system-name | -w wwID | -h host-name | -r (host_sa | direct_sa)]
[-I information-to-include] [-q frequency] [-S]
SMcli -x email: email-address [host-name-or-IP-address1
[host-name-or-IP-address2]]
[-n storage-system-name | -w wwID | -h host-name | -r (host_sa | direct_sa)] [-S]
1-2
IBM System Storage DS3000, DS4000, and DS5000: Command Line Interface and Script Commands Programming Guide
Definition
Alternative ("a" or "b" or "c")
A terminal that needs user input to fulfill a
parameter (a response to a variable)
Zero or one occurrence (square brackets are also
used as a delimiter for some command parameters)
Zero or more occurrences
A terminal that needs a command parameter entered
to start an action
-w wwID)