A P P E N D I X  A

Reference: CLI Commands

The CLI allows you to see system status, configure system properties, and administer the hardware. It is also scriptable, as explained in To Create and Execute a Script for CLI Commands.

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 can select between multiple parameters, options are separated by a bar ( | ).

This appendix contains the following commands:


alertcfg

Description

Adds or removes email addresses to which alerts will be sent.

Syntax

alertcfg [options]

Entering alertcfg with no parameters displays the current values of each option.

Options

Adds or carbon copies (cc) an email address to the specified list type.

Removes an email address from the specified list type.

Examples


ST5800 $ alertcfg add to fred@samplecompany.com
ST5800 $ alertcfg del cc admin@samplecompany.com


cellcfg

Description

Sets and displays the following network configuration parameters per cell or for all cells in the hive:

Syntax

cellcfg [options]

Entering cellcfg with no parameters displays the current values of each option.

Options

Specifies ID of the cell you want to configure. In a multicell configuration, you must enter a cell ID.



Note - If you change the cell ID, you must use the wipe command to delete all data from the system. See wipe for information about deleting data from the system.


Allows you to change values in interactive mode.

Sets the administrative IP address.

Sets the data IP address.

Sets the IP address of the gateway.

Sets the IP address of the service node.

Sets the subnet mask of the gateway.

Examples

 


ST5800 $ cellcfg --set
Enter new value, or hit <enter> to leave the value unchanged:
 
Admin IP Address [10.7.225.161]:
Data IP Address [10.7.225.162]:
Service Node IP Address [10.7.225.160]:
Subnet [255.255.252.0]:
Gateway [10.7.227.254]:
 
No values changed.
ST5800 $
 


copyright

Description

Displays copyright information for the 5800 system

Syntax

copyright

Options

None.

Examples

 


ST5800 $ copyright
Copyright (C) 2007 Sun Microsystems, Inc. All rights reserved.
 
Sun Microsystems, Inc. has intellectual property rights relating to technology
embodied in the product that is described in this document. In particular, and
without limitation, these intellectual property rights may include one or more
of the U.S. patents listed at http://www.sun.com/patents and one or more
additional patents or pending patent applications in the U.S. and in other
countries.
 
U.S. Government Rights - Commercial software.
Government users are subject to the Sun Microsystems, Inc. standard license
agreement and applicable provisions of the FAR and its supplements. Use is
subject to license terms. This distribution may include materials developed by
third parties. Portions may be derived from Berkeley BSD systems, licensed from
U. of CA. Sun, Sun Microsystems, the Sun logo, Java and Solaris are trademarks
or registered trademarks of Sun Microsystems, Inc. in the U.S. and other
countries.
 
ST5800 $


date

Description

Returns master node date and time.

Syntax

date [options]

Option

Specifies ID of the cell for which you want to display system time. In a multicell configuration, you must enter a cell ID.

Example

 


ST5800 $ date
Thu Jun 28 12:43:17 UTC 2007

 


df

Description

Reports estimated disk space usage on the system. Note the following information about the utilization numbers displayed:

Syntax

df [options]

Options

Specifies ID of the cell for which you want to display statistics. In a multicell configuration, you must enter a cell ID.

Print the results in easily readable summary format. Rounding of numbers means totals are approximate.

Prints the physical space available on the disk.

Examples


ST5800 $ df
All sizes expressed in 1K blocks
Total: 14372110336; Avail: 14141931520; Used: 230178816; Usage: 1.6%
ST5800 $ df -p
All sizes expressed in 1K blocks
DISK-101:0: Total: 449128448; Avail: 434057216; Used:  15071232; Usage: 3.4%
DISK-101:1: Total: 449128448; Avail: 444561408; Used:   4567040; Usage: 1.0%
DISK-101:2: Total: 449128448; Avail: 444561408; Used:   4567040; Usage: 1.0%
DISK-101:3: Total: 449128448; Avail: 444561408; Used:   4567040; Usage: 1.0%
DISK-102:0: Total: 449128448; Avail: 444561408; Used:   4567040; Usage: 1.0%
DISK-102:1: Total: 449128448; Avail: 434057216; Used:  15071232; Usage: 3.4%.
.
.
.
 
 
ST5800 $


help

Description

Displays a list of available CLI commands.

Syntax

help [options]

Entering help with no parameters displays a list of available commands.

Option

Specifies the command for which you wish to receive detailed help.

Examples


ST5800 $ help 
 
 
Type “help <command>” or “<command> --help” for one of the commands below
alertcfg
cellcfg
copyright
date
df
help
hiveadm
hivecfg
hwstat
logout
mdconfig
passwd
perfstats
reboot
sensors
shutdown
sysstat
version
wipe
 
ST5800 $
 
 
 

 


ST5800 $ help hwstat
Usage: hwstat [options]
Displays information about the various FRUs in the system. The component name or FRU ID may be used when specifying the component to view.
 
Options:
  -c, --cellid <cellid> Specifies the ID of the cell where the command should run.
  -f, --FRUID <component> Shows information about component
 
ST5800 $ 


hiveadm -s|--status

Description

Displays number of cells in the configuration, as well as the cell ID and administrative and data IP address of each cell.

Syntax

hiveadm -s|--status

Options

None.

Example


ST5800 $ hiveadm -s
There is/are 2 cell(s) in the hive:
- Cell 1: adminVIP = 10.7.224.21, dataVIP = 10.7.224.22
- Cell 5: adminVIP = 10.7.224.101, dataVIP = 10.7.224.102
ST5800 $

 


hivecfg

Description

Sets and displays the following network configuration parameters for the hive:

Syntax

hivecfg [options]

Entering hivecfg with no parameters displays the current values of each option.

Options

Allows you to change values in interactive mode.

Sets the list of clients authorized to access the system. The default is all, which specifies that any client can access the system.

Specifies whether DNS is enabled or disabled.

Specifies other domains that the system should search if the specified domain name does not result in a valid IP address.

Specifies the domain name the system should use.

Sets the NTP server address.

Sets the port of the SMTP server.

Sets the address of the SMTP server.

Sets the address of the external logging system to which you want alerts sent.

Specifies the IP address of the first server the system should use to translate domain names.

Specifies the IP address of the server the system should use to translate domain names if the primary server is unavailable.



Note - You can enter multiple values for NTP servers, authorized clients, and DNS search domains. Each value must be separated by a comma.


Examples


ST5800 $ hivecfg --primary_dns_server 10.8.11.110
You must reboot the hive with ‘reboot -all’ for all changes to take effect.
ST5800 $ hivecfg --authorized_clients all
You must reboot the hive with ‘reboot -all’ for all changes to take effect.
ST5800 $ hivecfg --dns n
Converting authorized client hc-dev.sfbay to 10.7.228.10.
Converting authorized client cl92.sfbay to 10.7.227.92.
Converting external logger hclog301.sfbay to 10.7.224.10.
Converting NTP server hclog301.sfbay.sun.com to 10.7.224.10.
Converting SMTP server centralmail4brm.Central.Sun.COM to 129.147.62.198.
Updating hive configuration settings...
You must reboot the hive with ’reboot --all’ for all changes to take effect.
ST5800 $ hivecfg --set
Enter new value, or hit <enter> to leave the value unchanged:
[multiple values need to be comma separated]
 
NTP Server [10.7.224.10]: hclog301.sfbay.sun.com
SMTP Server [129.147.62.198]: centralmail4brm.Central.Sun.COM
SMTP Port [25]:
Authorized Clients [10.7.228.10,10.7.227.92]: all
External Logger [10.7.224.10]: hclog301.sfbay
DNS [y or n] [n]: y
Domain Name [sfbay.sun.com]:
DNS Search [sun.com]:
Primary DNS Server [10.7.224.10]:
Secondary DNS Server [129.146.11.21]:
 
Old NTP Server [10.7.224.10] new: hclog301.sfbay.sun.com
Old SMTP Server [129.147.62.198] new: centralmail4brm.Central.Sun.COM
Old Authorized Clients [10.7.228.10,10.7.227.92] new: all
Old External Logger [10.7.224.10] new: hclog301.sfbay
Old DNS [n] new: y
Validating NTP server hclog301.sfbay.sun.com...
Updating hive configuration settings...
You must reboot the hive with ’reboot --all’ for all changes to take effect.
ST5800 $ 

 


hwstat

Description

Displays information about disk and server node field-replaceable units (FRUs) in the 5800 system or displays information about a particular FRU.

Syntax

hwstat [options]

Options

Specifies the cell for which you want to see information. This option is required in a multicell configuration.

Specifies the identification of the FRU for which you want to see information.

Examples

 

ST5800 $ hwstat -c 8
Component     Type    FRU ID                                          Status
------------  ------  ----------------------------------------------  --------
NODE-101      NODE    91230b2c-6ac5-d311-0180-c96e5981e000            ONLINE
DISK-101:0    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHYS3D    ENABLED
DISK-101:1    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHLS7D    ENABLED
DISK-101:2    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHJY1D    ENABLED
DISK-101:3    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHW6ED    ENABLED
NODE-102      NODE    96230b2c-6ac5-d311-0180-c1645981e000            ONLINE
DISK-102:0    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHW8VD    ENABLED
DISK-102:1    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGE8G9D    ENABLED
DISK-102:2    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHVX2D    ENABLED
DISK-102:3    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHW0ND    ENABLED
NODE-103      NODE    92230b2c-6ac5-d311-0180-7e6d5981e000            ONLINE
DISK-103:0    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHVZLD    ENABLED
DISK-103:1    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHN3RD    ENABLED
DISK-103:2    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHVR4D    ENABLED
DISK-103:3    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHVXSD    ENABLED
NODE-104      NODE    93230b2c-6ac5-d311-0180-e65a5981e000            ONLINE
DISK-104:0    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHYTYD    ENABLED
DISK-104:1    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGGM4WD    ENABLED
DISK-104:2    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGEJ9HD    ENABLED
DISK-104:3    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGHEXED    ENABLED
.
.
.
ST5800 $ hwstat -f NODE-107
Component     Type    FRU ID 																		Status
------------  ------  -------------------------------------------- --------
NODE-107 		 	 NODE    72cda8b6-aec3-d311-0080-2a835981e000 											 				 ONLINE
DISK-107:0    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGLX7GD ENABLED
DISK-107:1    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGLY5PD ENABLED
DISK-107:2    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGGY8VD ENABLED
DISK-107:3    DISK    ATA_____HITACHI_HDS7250S______KRVN63ZAGLXA7D ENABLED
 
ST5800 $
 

 


logout

Description

Ends the administrative session.

Syntax

logout

Options

None

Example


ST5800 $ logout
Connection to hc1-admin closed. 
client $


mdconfig

Description

Enables updates to the existing metadata schema.

Syntax

mdconfig [options]

Options

Applies changes into the schema file. The system reads in changes as standard input.

Displays the current schema configuration as standard output.

Finishes creating tables that might not have been fully created if you issued the mdconfig -a or mdconfig --apply option while the system was under heavy load.

Parses and validates a schema before applying the changes. The system reads input from this option as standard input.

Returns a template that you can use as a starting point to modify the schema configuration.

 

 

Example


ST5800 $ mdconfig -t
<?xml version="1.0" encoding="UTF-8"?>
 
<!--
  $Id: metadata_config_template.xml 9373 2006-09-30 01:07:35Z pc198268 $
 
  Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
  Use is subject to license terms.
-->
 
 
<!--
  This template file provides a schema config overlay skeleton.
  Note that the fsView refers to the namespace of the schema.
  Refer to the administration guide (chapter 4) for more details
-->
 
<metadataConfig>
 
  <schema>
 
    <namespace name="NAMESPACE_NAME">
      <field name="FIELD1" type="string" length="512"/>
      <field name="FIELD2" type="long"/>
      <field name="FIELD3" type="double"/>
      <field name="FIELD4" type="binary" length="128"/>
      <field name="FIELD5" type="char" length="128"/>
      <field name="FIELD6" type="date"/>
      <field name="FIELD7" type="time"/>
      <field name="FIELD8" type="timestamp"/>
    </namespace>
 
  </schema>
 
  <fsViews>
 
    <fsView name="FSVIEW_NAME" filename="${FIELD3}.num" namespace="NAMESPACE_NAME">
      <attribute name="FIELD1"/>
      <attribute name="FIELD2"/>
    </fsView>
 
  </fsViews>
 
(continued)


 <tables>
    <table name="TABLE1">
      <column name="NAMESPACE_NAME.FIELD1"/>
      <column name="NAMESPACE_NAME.FIELD2"/>
      <column name="NAMESPACE_NAME.FIELD3"/>
      <column name="NAMESPACE_NAME.FIELD4"/>
      <column name="NAMESPACE_NAME.FIELD5"/>
      <column name="NAMESPACE_NAME.FIELD6"/>
      <column name="NAMESPACE_NAME.FIELD7"/>
      <column name="NAMESPACE_NAME.FIELD8"/>
    </table>
  </tables>
 
</metadataConfig>
 
 

 

 

 


passwd

Description

Allows the system administrator to change the admin password, as well as set and change an ssh pubkey for accessing the CLI.

Syntax

passwd [-K | --pubkey < pubkeyfile]

Option

Configures the system so that you can log in from a client without entering a password. pubkeyfile is the file containing the public key.

Consult your ssh application documentation for instructions on creating key files. Create the public key without a passphrase. You might be prompted to enter the CLI password (default is admin) during key generation.

Once you have configured the public key file on the 5800 system, you can log in from any client with the private version of that key without being prompted for a password. If you wish to return to interactive logins, remove the private key from the client, or configure a new public key on the 5800 system.



Note - Only one public key is allowed on the 5800 system. If you have already configured a public key and then configure a new one, the new key replaces the old one.




Note - The --pubkey option is available only in non-interactive mode (that is, you must enter it at the same time that you enter the ssh command, as in ssh admin@10.7.227.101 passwd --pubkey < key.pub).


Examples


ST5800 $ passwd
Enter current password:
Enter new password: 
Re-enter new password: 
CLI admin: The admin password has been changed successfully.
ST5800:
 
client $ ssh admin@10.8.163.10 passwd --pubkey < id_dsa.pub
Password:XXXXX
CLI admin: The public key has been changed successfully
client $
 
client $ cat id_dsa.pub | ssh admin@10.8.163.10 passwd --pubkey
Password:XXXXX
CLI admin: The public key has been changed successfully
client $
 

 


perfstats

Description

Displays real-time performance statistics about throughput and operations.

Syntax

perfstats [options]

Options

Specifies the cell for which you want to view statistics. In a multicell configuration, you must enter a cell ID.

Specifies the time, in minutes during which you want to monitor performance statistics. By default, the statistics display indefinitely.

Specifies the interval, in seconds, at which you want to display statistics. By default, the interval is 15 seconds.

Specifies a node for which you want to display statistics. By default, statistics for all nodes are displayed.

Examples


ST5800 $ perfstats
 
Cell Performance Statistics:
 
                                 Avg         Avg
                     # Ops      Op/sec     KB/sec
                   -------- ----------  ------------
  Add MD:                 0     0.00          0.00
  Store:                  0     0.00          0.00
  Retrieve:               1     0.20          0.15
  Retrieve MD:            0     0.00          0.00
  Delete:                 0     0.00             -
  Query:                687    22.90             -
  WebDAV Put:             0     0.00          0.00
  WebDAV Get:             0     0.00          0.00
 
Hive Performance Statistics:
 
Load 1m: 4.12 Load 5m: 4.21 Load 15m: 4.43
Disk Used: 241.28 GB  Disk Total: 13.38 TB  Usage: 1.8% 
 
 

 


ST5800 $ perfstats -n NODE-101
 
NODE-101 Performance Statistics:
 
 
 
                                 Avg         Avg
                     # Ops      Op/sec     KB/sec
                   -------- ----------  ------------
  Add MD:                 0     0.00          0.00
  Store:                  0     0.00          0.00
  Retrieve:               1     0.20          0.15
  Retrieve MD:            0     0.00          0.00
  Delete:                 0     0.00             -
  Query:                687    22.90             -
  WebDAV Put:             0     0.00          0.00
  WebDAV Get:             0     0.00          0.00
 
Hive Performance Statistics:
 
Load 1m: 4.12 Load 5m: 4.21 Load 15m: 4.43
Disk Used: 241.28 GB  Disk Total: 13.38 TB  Usage: 1.8%
 
 

 

 

 


reboot

Description

Reboots a cell. Rebooting causes an alert to be sent.

Syntax

reboot [options]

Options

Specifies ID of the cell you want to reboot. In a multicell configuration, you must enter a cell ID.

Reboots the switches and service node along with the storage nodes.

Examples


ST5800 $ reboot
Reboot? [y/N]: y 
Connection to hc1-admin closed. 


sensors

Description

Displays voltage, temperature, and fan speed data, as collected by system sensors.

Syntax

sensors [options]

Option

Specifies ID of a cell for which you want to see sensor data. In a multicell configuration, you must enter a cell ID.

Example


ST5800 $ sensors
 
NODE-101:
        DDR Voltage           2.60 Volts
        CPU Voltage           1.42 Volts
        VCC 3.3V              3.32 Volts
        VCC 5V                5.12 Volts
        VCC 12V               12.03 Volts
        Battery Voltage       2.98 Volts
        CPU Temperature       49 degrees C
        System Temperature    32 degrees C
        System Fan 1 speed    11340 RPM
        System Fan 2 speed    11340 RPM
        System Fan 3 speed    11070 RPM
        System Fan 4 speed    10980 RPM
        System Fan 5 speed    11070 RPM
 
NODE-102:
        DDR Voltage           2.60 Volts
        CPU Voltage           1.43 Volts
        VCC 3.3V              3.32 Volts
        VCC 5V                5.10 Volts
        VCC 12V               12.10 Volts
        Battery Voltage       2.98 Volts
        CPU Temperature       49 degrees C
        System Temperature    33 degrees C
        System Fan 1 speed    11700 RPM
        System Fan 2 speed    11430 RPM
        System Fan 3 speed    11250 RPM
        System Fan 4 speed    10980 RPM
        System Fan 5 speed    10980 RPM
 
 
.
.
.
 
ST5800 $
 

 

 


shutdown

Description

Shuts down (powers off) all the nodes in a cell. System shutdown causes the system to send an alert.



caution icon Caution - Use the shutdowncommand only in consultation with 5800 system support personnel.


Syntax

shutdown [options]

Options

Specifies the cell you want to shut down. In a multicell configuration, you must enter a cell ID.

Shuts down the service node in addition to the storage nodes.

Examples


ST5800 $ shutdown
It is not safe to shutdown the system
Do you want to shutdown anyway? [y/N]: y 
Connection to hc1-admin closed. 


sysstat

Description

Displays information about the system status.

Syntax

sysstat [options]

Options

Specifies the cell for which you wish to view statistics. In a multicell configuration, you must enter a cell ID.

Specifies a number of seconds at which to repeat the statistics listing.

Displays information about the online/offline status of each node and disk in the system.



Note - The online/offline status reported by the -v option is the logical system status. To see the state of hardware components, refer to hwstat.


Examples


ST5800 $ sysstat 
Cell 0: Online. Estimated Free Space: 7.50 TB
8 nodes online, 32 disks online.
Data VIP 10.7.224.182, Admin VIP 10.7.224.181
Data services Online, Query Engine Status: HAFaultTolerant
Data Integrity check not completed since boot
Data Reliability check not completed since boot
Query Integrity established as of Wed Sep 05 01:31:20 UTC 2007
NDMP status: Backup ready.
ST5800 $

The output that the sysstat command produces is as follows. Data reported is for all online disks in the entire system.


version

Description

Displays the version of the system software.

Syntax

version [options]

Options

Specifies the cell for which you wish to view the version. In a multicell configuration, you must enter a cell ID.

Displays the version information for each node, the service node, and the switches.

Example



ST5800 $ version -v
ST5800 1.1 release [1.1-11076]
Service Node:
        BIOS Version: 1.1.3
        SMDC Version: 4.13
Switch:
        Overlay Version (sw#1): 11068
        Overlay Version (sw#2): 11068
NODE-101:
        BIOS version: 0.1.8
        SMDC version: 4.18
NODE-102:
        BIOS version: 0.1.8
        SMDC version: 4.18
NODE-103:
        BIOS version: 0.1.8
        SMDC version: 4.18
NODE-104:
        BIOS version: 0.1.8
        SMDC version: 4.18
 
.
.
.
 
 
ST5800 $


wipe

Description

Deletes all data and metadata on the entire hive. It does not delete the system software.



caution icon Caution - All data and metadata in the 5800 system is lost when you run the wipecommand. Consult technical support prior to using this command.


Syntax

wipe

Options

None.

Example


ST5800 $ wipe
Destroy all data and clear the metadata schema? [y/N]: