A P P E N D I X A |
CLI Command Reference |
The CLI allows you to see system status, configure system properties, and administer the hardware. It is also scriptable using the ssh keys as explained in Configuring a Public Key.
The following pages provide 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 must select between multiple parameters, options are separated by a bar ( | ).
This appendix contains the following commands:
Adds or removes email addresses to which alerts will be sent.
Entering alertcfg with no parameters displays the current values of each.
alertcfg [add [to | cc] | del [to | cc]]
Adds or carbon copies (cc) an email address to the specified list type.
Removes an email address from the specified list type.
Reports estimated disk space usage on the system.
df [-h | --human-readable | -p | --physical]
Print the results in easily-readable summary format. Note that rounding of numbers means totals are approximate.
Prints the physical space available on the disk.
Displays a list of available CLI commands.
Specifies the command for which you wish to receive detailed help.
hc $ help |
|
|
|
|
alertcfg |
df |
help |
hwcfg |
hwstat |
ifconfig |
license |
logout |
mdconfig |
netcfg |
passwd |
reboot |
shutdown |
sysstat |
upgrade |
version |
wipe |
|
|
|
hc $ |
|
|
|
|
Administers system hardware (nodes and disks).
Enables a disk identified by FRU ID (field-replaceable unit ID).
Disables a disk identified by FRU ID.
Disk status in hwstat -v output changes from ONLINE to OFFLINE.
Disk status in hwstat -v output changes from OFFLINE to ONLINE.
Note - If you reboot with the disk disabled, to enable the disk you must enable it and then reboot again. |
Displays information about disk and server node field-replaceable units (FRUs) in the Sun StorageTek 5800 system or displays information about a particular FRU.
Shows a list of all components (FRUs and others) and their statistics.
Configures or displays the admin and data virtual IP addresses.
Note - Release 1.0 supports changing only the IP address and netmask of the data and admin VIPs. A VIP is either data0 or admin0. |
Specifies the device (data0 or admin0).
Displays or sets the current software license.
Entering license with no parameters displays the current license.
Sets the current license to the specified value.
hc $ license License Not Yet Entered hc $ license STK5800-SEARCH-10001 hc $ license STK5800-SEARCH-10001 hc $ |
Ends the administrative session.
client $ logout hc $ logout Connection to hc1-admin closed. client $ hc $ exit Connection to hc1-admin closed. client $ |
Enables updates to the existing metadata schema.
Entering mdconfig with no parameters performs a validation on the current schema overlay file.
mdconfig [-d | --dump | -t | --template | -c | --commit]
Prints the current schema configuration as standard output.
Returns an empty overlay file that you can use as a starting point to extend the schema configuration.
Commits the configuration change described in the overlay file to be read in as standard input.
Enables you to set and display various network configuration parameters, including:
netcfg [ smtp] [ gw ] [ ntp] [ loghost] [ clients]
Sets the location of the SMTP server that the Sun StorageTek 5800 system uses.
Sets the default gateway (router) that the Sun StorageTek 5800 system uses.
Sets the external NTP servers that the Sun StorageTek 5800 system uses.
Sets the external log host that the Sun StorageTek 5800 system uses.
Specifies the authorized clients for the Sun StorageTek 5800 system.
Allows the system administrator to change the admin password, as well as set and change an ssh pubkey for accessing the CLI.
Use this option if you are going to provide a public key to be used for login authorization.
hc $ passwd password: password (again): authentication tokens successfully updated hc $ client_$ ssh admin@cluster-admin passwd --pubkey < file.pub authentication tokens successfully updated |
where file.pub is the file containing the public key.
To return to interactive prompting, remove your private key or create a new public key with a pass phrase.
Note - If you have already supplied a public key and then supply a new public key, the new key replaces the old key. Only one public key is allowed on the Sun StorageTek 5800 system. |
Reboots the cluster. Rebooting causes an alert to be sent.
reboot [-F | --force ] [-A | --all ]
Prompts for confirmation before forcing a reboot.
Reboots the switches along with the nodes.
Note - In non-interactive mode, reboot does not
prompt for confirmation (no -F or |
hc $ reboot Reboot? [y/N]: y Connection to hc1-admin closed. hc $ reboot --force Connection to hc1-admin closed. client_$ ssh admin@hc1-admin reboot client_$ |
Shuts down (powers off) the cluster. System shutdown causes an alert to be sent.
Caution - Use the shutdowncommand only in consultation with Sun StorageTek 5800 system support personnel. |
Forces a system shutdown without prompting for confirmation.
Note - In non-interactive mode, shutdown does not
prompt for confirmation (no |
Displays overall and performance statistics about the system.
sysstat [ -i seconds | --interval=seconds] [ -v | --verbose]
Specifies a number of seconds at which to repeat the statistics listing. (The default here is 5.)
Displays voluminous information about the system.
The output that the sysstat command produces is as follows:
Verbose output includes the online/offline status of each node and disk in the cluster. The online/offline status reported by the command refers to the logical system status. To see the state of hardware components, refer to hwstat.
Upgrades the cluster to a newer version of the Sun StorageTek 5800 system software. You perform an upgrade from a DVD, or from an ISO image located on a web server. For a detailed description, see Upgrading the System.
upgrade [dvd |< image-name> | downloaded]
Performs an upgrade from a DVD.
Downloads the image from an IP address and upgrades in one step.
Downloads the image from an IP address and upgrades at a later time.
hc $ upgrade dvd hc $ upgrade http://123.45.67.89/honeycombdvd.iso hc $ upgrade download http://123.45.67.89/honeycombdvd.iso hc $ upgrade downloaded |
Displays the version of the system software.
Deletes all data and metadata on the cell. It does not delete the system software, however. After issuing the wipe command, you use the reboot command to complete the process.
Caution - All data and metadata in the Sun StorageTek 5800 system is lost when you run the wipecommand. Consult Sun StorageTek 5800 system technical support prior to using this command. |
Forces a system wipe without prompting for confirmation.
Copyright © 2006, Sun Microsystems, Inc. All Rights Reserved.