C H A P T E R  3

Monitoring and Administration Commands for All Arrays

This chapter describes the sscs commands and their options for monitoring and administrating all Sun arrays, including Sun Storage J4200, J4400, and J4500 arrays, Sun StorEdgeTM 6130 array, Sun StorageTekTM 6140 and 6540 arrays, Sun Storage 6580 and 6780 arrays, Sun StorageTek 2500 Series arrays, and FlexLineTM 240, 280, and 380 Systems. For the configuration and other commands that apply only to arrays with raid controllers, see Chapter 4.


add notification

Sets up email or SNMP trap notification.

Synopsis

Add email notification:

add [ -e <email-address,...>] [ -c <array_type> ] [ -r pager | email ] [ -m down | critical | major | minor ] [ -f ] [ -s ] [ -d ] [ -g ] notification local_email 

Add an SNMP trap notification:

add  -i <IP-address,...> [ -o <port_id>] [-t 1 | 2 | 3 | 4 | 5 ] [-l warning | error | down ] [-m| <down | critical | major | minor>] [-c <community-string> ] [-g ]  notification trap

Add an email filter:

add  -n <event-id> -s info | none notification email-filter 

Turn on the SNMP trap notifier:

add notification trap

Description

Sets up email and SNMP trap notification. You can add one or more email addresses for notifications.

Options

-e,--email <email-address,...>

Specifies that all notifications are sent to the given email addresses.

-i,--ip <IP-address,...>

Specifies the IP address of the host that will receive the SNMP trap data.

-l,--traplevel warning | error | down 

Specifies the trap level associated with this notification.

-o,--port <port-id>

Specifies the port ID used to transfer notifications.

-c,--components <array_type>

Specifies the array model number. For example, j4200 or j4400.

-r,--format pager | email

Specifies the format of the message: email or pager. If no value is specified, the command defaults to email.

-m,--alarm-level down | critical | major | minor

Specifies the minimum priority level of alerts to be sent out. By default, all alerts will be sent out.

-f,--filter true | false 

Enables or disables email filters. The default is false.

-s,--skip-aggregated true | false 

Skips components of aggregated events if set to true.

-d,--advisor true | false 

Adds Service Advisor information to the email if set to true. The default is false.

-g,--config-change true | false 

Sends configuration event emails as well as alert e-mails. The default is false.

-n,--event-number <event_id> 

Specifies the event code to filter.

-s,--severity info | none 

Specifies the severity of events to report.

-t,--trapnumber 1 | 2 | 3 | 4 | 5 

Specifies the trap number associated with this notification.

notification local_email | email-filter | trap 

Specifies that all notifications of the specified type are sent to the given addresses.

local-email - Specifies that you want to receive the notification at your local email address.

email-filter - Specifies that you want to filter the notification.

trap - Specifies that you want to receive notification using the SNMP trap notification.

Examples

sscs add -t 2 -i 10.10.10.1 notification trap


add registeredarray

Discovers an array or all arrays on the same subnet as the management host and registers them.

Synopsis

add -d registeredarray
add -i [ -q ]  registeredarray

Description

Discovers an array by specifying its IP address or all arrays on the same subnet as the management host and registers them. Also queries registered arrays for the remote proxy password.

Options

-i,--ipaddress

Specifies the IP address of the device.

-d,--discover

Automatically discovers all arrays on the same subnet as the management host and registers them. If discover is specified, all other options are ignored and arrays are automatically discovered.

-q,--query-for-password

Queries for the current password for remote proxy for the registered array.

Examples

sscs add -i 10.10.10.1 registeredarray


add userrole

Adds a user name to the user access list and defines the user privileges.

Synopsis

add -u <user-name> userrole storage | guest

Description

Adds a user name to the user access list and defines the user role as having storage or guest privileges.

Options

-u,--username <user-name>

Specifies a user name. The <user-name> must already be defined on the computer in the operating system.

userrole storage | guest 

Specifies the new user’s role.

storage - Provides full storage configuration and monitoring access.

guest - Allows user to view but not change storage configurations.


list alarm

Provides detailed information on a specified alarm or summary information on all alarms.

Synopsis

list [ -s <1..3> ] [ -f <device-type> ] [ -a <service-advisor-ID> ] [ -S ] alarm [ <alarm_ID> ]

Description

Provides detailed information on a specified alarms. When alarm IDs are not specified, it provides summary information on all alarms.

Options

-a,--advisor service-advisor-ID

Lists the Service Advisor ID.

-s,--severity <1..3>

Specifies a severity level at which to filter alarms so that only the alarms of that severity level are listed.

Severity Levels:

0 - minor

1 - major

2 - critical

3 - failure

-f,--faultdevtype <device-type>

Specifies the type of device to list.

-S, --Summary 

Specifies that the system return a summary of alarm information.

alarm [ <alarm_ID> ]

Specifies the alarm or alarms to display. If no alarm is specified, summary information on all alarms is displayed.

Examples

sscs list -f j4200 alarm
sscs list -s 2 alarm
sscs list -s 1 -a alarm
Response Format

(when no advisor option is specified)

Alarm ID: ID
Severity: severity
Type: type
Topic: topic
Event Code: event-code
Date: date
Device: device-id 
Descrip.: Description
Response Format
(when the advisor option is specified)
Alarm ID: ID
Severity: severity
Type: type
Topic: topic
SERVICE ADVISOR
EventCode: event-code
EventType: event-type
Severity: severity-level
Sample Description: event-Description		
Information: event-information
Probable Cause: probable-cause
Recommended Action: recommended-action
Date: date
Device: device-ID 
Descrip.: Description


list array

Lists detailed information about specified arrays or all array names.

Synopsis

list array [ <array-name,...> ]

Description

Lists detailed information about one or more arrays. If you do not specify an array name, then all array names are listed.

Examples

Summary of arrays when no <array-name> value is specified:

sscs list array

Response Format

Array: array-name

...

Array: array-name

 

Detail of array when the <array-name> value is specified (shows array with raid controller):

sscs list array array00

Response Format

Array: array-name

Array Type: array-type

Serial Number: serial-number

Firmware Version: firmware-version

Array WWN: array-WWN

Health Status: OK | Degraded

Hot-Spare Pool Disks: number-of-hot-spare-drives (FC, SATA, and SAS)

Node WWN: node-WWN

Default Host Type: host-type

Default Cache Block Size: 4K | 16K

Default Cache Start %: <0..100>

Default Cache Stop %: <0..100>

Disk Scrubbing: Disabled | Enabled

Failover Alert Delay: 1..300 minutes

Health: OK | Lost Contact |...

Tray ID: tray-ID

Host: host-name

...

Host: host-name

Host Group: host-group

...

Host Group: host-group

Pool: pool-name

...

Pool: pool-name

 


list date

Lists the current date and time for the array in hours, minutes, and seconds. (Not supported by j450 and B6000 JBODs.)

Synopsis

list -a <array-name> date

Description

Lists the current date and time for the array in hours, minutes, and seconds. The time zone of the management system is assumed to be the time zone of the array.

Options

-a,--array <array-name> 

Specifies the array for which you want to see the date.

Examples

sscs list -a array00 date
Response Format

Date: weekday month day HH:MM:SS YYYY

Example

Tue Dec 20 16:09:36 2004


list device

Provides detailed information on a specified device or summary information on all devices.

Synopsis

list [ -n <device-name> ] [ -i <IP-address>] device [ device-ID [,device-ID...]]
list devices

Description

List the details of a device or the devices being monitored.

Options

-n,--name <device-name> 

Specifies the device name for which you want to see the details. If no device is specified, summary information for all devices is displayed.

-i,--ip <IP-address>

Specifies the IP address of the connected host when using remote proxy.

device-ID

Specifies one or more device IDs.

Examples

sscs list -n 2540_array1 device
 
Device Name      : 2540_array1
Type             : 2540
IP Address       : 10.nn.nn.n
Monitored On     : sp-72
Key              : SUN.14617-00.0617053335
Active           : Y
WWN              : 200400a0b82458a0
Alternate IP     : 10.nn.nn.n
Alt IP Number    : 10.nn.nn.n
Management Level : D
Said             : 600A0B80002458810000000045A7B14E
Time Added       : 2008-10-03 11:44:11
Port WWNs        : 200400a0b82458a1,200400a0b82458a2,200500a0b82458a1,200500a0b82458a2
 
sscs list -i 10.1.1.1 device
sscs list device
 
Response Format
DeviceName: device-ID 
Type: type
IP Address: IP-address
Monitored On: interface
Key: device-key
Active: Is the device active? Y | N
WWN: World Wide Name
MgmtLevel: management-level
Said: Storage-Automated-Diagnostic-Environment-Identifier
Time Added: time added
 


list devices

Provides summary information on all devices.

Synopsis

list devices

Description

List a summary of the devices being monitored.

Options

--

Examples

list devices
Monitored	On Device       Type IP Address    WWN              Active ASR
---------   ------------ ---- ------------- ---------------- ------ ---
sp-72       2540_array1  2540 10.nn.nn.n    200400a0bnnnnnnn  Y      N
sp-72       6140_array2  6140 10.nn.nn.n    200400a0bnnnnnnn  Y      N
sp-72       6140_array3  6140 10.nn.nn.n   200400a0bnnnnnnn  Y      N
 
Response Format
Monitored On:	interface
Device 		Array/system being monitored
Type  		Array/system model
IP Address 		IP-address
WWN  		World Wide Name
Active 		Is the device active? Y | N
ASR		Is Auto Service Request on? Y | N
 


list disk

List the disk information on an array.

Synopsis

list -a <array-name> disk [ <disk-name,...> ]

Description

Lists disk information.

Options

-a,--array <array-name>

Specifies the name of the array where the disk resides.

disk <disk-name,...>

This option provides detailed information on the specified disks. When disks are not specified, this option provides detailed information on all the disks in the tray.

Examples

sscs list -a array00 -t 1 disk
Response Format
Tray: tray-ID Disk: disk-name 
Capacity: disk-capacity
Type: SAS | SATA 
Speed (RPM): speed-in-revolutions-per-minute
Status: Optimal | In-use | Available | Failed 
State: Enabled | Disabled 
Role: Data 
Firmware: firmware-version-number
Serial number: serial-number
WWN: WWN-number


list event

Lists the Fault Management Service (FMS) event log information.

Synopsis

list [ -s <1..3> ] [ -d <device_id> ] [ -t <type> ] [ -a ] [ -f <keyword> ] [ -l <limit> ] event [ <event_Id> ]

Description

Lists the FMS event log information. You can filter by device type and severity level.

Options

-s,--severity <1..3>

Specifies a severity level at which to filter events so that only the events of that severity level are listed.

Severity Levels:

0 - warning

1 - error

2 - critical

3 - failure

-d,--device <device_id>

List only events for the given device.

-t,--type <type>

List only events of the given event type.

-a,--aggregated

Specifies that all events are listed and aggregated so that related events are grouped together.

-f, --filter <keyword>

Filter output on the event Description by using the given keyword parameter.

-l,--last <limit>

Limit the number of events printed by the given number.

event <event_id>

Specifies the event ID.

Examples

sscs list -s 3 event
Response Format
 Severity    : Minor
 Date        : Fri Mar 10 10:39:57 MST 2006
 Device      : diag-lsi1 (J4200)
 Component   : Sim.0
 Type        : Problem
 Event Code  : 
 Aggregated  : No
 Description : New problem 
REC_NON_FRU_BATTERY_NEAR_EXPIRATION t0ctrl2:39 discovered on diag-lsi1 "t0ctrl2".


list firmware

Lists the firmware versions of the field-replaceable units (FRU) in this device.

Synopsis

list [ -a <array-name> ] [ -t <type> ] [-x <component_type1 [,component_type1...]>] firmware

Description

Lists the firmware versions of the field-replaceable units in this device. You can define the FRUs to include or exclude.

Options

-a,--array <array-name>

Shows the firmware revision level of the field-replaceable units for the specified array only.

-t <component_type>

Shows the firmware revision level for the specified component type.

-x, --exclude <component_type>

Excludes the specified component type from the list of firmware revision levels.

Examples

List the component firmware revisions for all arrays.

sscs list firmware

List the component firmware revisions for a specified array.

sscs list -a jbod1 firmware


list fru

Lists the field-replaceable units (FRUs) in this device.

Synopsis

list -d <device-name> [ -t <type-name> ] [ -s ] fru [ string,... ]

Description

Lists the field-replaceable units in this array. You can filter by component type.

Options

-d, --device <device-name> 

The array name or array ID.

-t,--type <type-name>

Specifies the type of field-replaceable units installed in this device to list. Use the -s option to see which FRU types would be valid for the chosen device. For example, for the JBOD arrays valid types are:

disk | fans | power supplies | sim | all

-s,--summary

Lists a summary of this field-replaceable unit.

fru [string,...]

Lists the field-replaceable unit or units in this device.

Examples

sscs list -d jbod1 fru

Output includes the component name, FRU type, alarm state, status, revision, and unique ID.

sscs list -d nenc-447 -t all -s fru

Type     Description Alarm    Installed Slot Count 
-------- ----------- -------- --------- ---------- 
battery  battery     Major    2         2          
ctrl     ctrl        Critical 2         2          
disk     disk        -        10        32         
icc      icc         -        1         1          
iom      iom         -        4         4          
midplane midplane    -        3         3          
pcu      pcu         Critical 6         6          
sfp      sfp         Critical 8         24

 


list jobs

Lists job IDs and status associated with the specified array and optionally specified job ID.

Synopsis

list -a array-name jobs [job-id [,job-id...]]

Description

Lists job IDs and status associated with the specified array and optionally specified job ID.

Options

-a,--array <array-name>

Specifies the name of the array.

job-id 

Specifies the job ID.

Examples

sscs list -a jbod1 jobs

Job ID: Install:task27 Status: Done

Job ID: Install:task36 Status: Done

Job ID: Install:task32 Status: Done

Job ID: Install:task35 Status: Done

Job ID: Install:task25 Status: Done

Job ID: Install:task24 Status: Done

Job ID: Install:task45 Status: Done

Job ID: Install:task30 Status: Done

Job ID: Install:task33 Status: Done

Job ID: Install:task34 Status: Done

sscs list -a jbod1 jobs Install:task27

Job ID: Install:task27

Type: Firmware Upgrade

Status: Done

% Complete: 100

Time to Completion: 00:00:00

Priority: Unknown


list log

Lists the user-initiated actions performed for all registered arrays.

Synopsis

list [ -s { [ mmdd ] HHMM | mmddHHMM [ cc ] yy } [ .SS ] ] [ -f { [ mmdd ] HHMM | mmddHHMM [ cc ] yy } [.SS ] ] [ -t <number-of-messages> ] log

Description

Lists the user-initiated actions performed for all registered arrays. You can filter the listings by date and time or most recent entries. If you do not specify any options, all log messages are displayed.

Options

-s,--start { [ mmdd ] HHMM | mmddHHMM [ cc ] yy } [ .SS ]

Lists all log messages starting at the date specified by the date options. Use with the -f,--finish subcommand to specify a date range.

-f,--finish { [ mmdd ] HHMM | mmddHHMM [ cc ] yy } [ .SS ]

Lists all log messages ending at the date specified by the date options. Use with the -s,--start subcommand to specify a date range.

mmdd

Specifies the month and day. For example, 0331 for March 31.

HHMM

Specifies the hour and minute. The hour is based on a 24-hour clock. For example, 1:30 p.m. is 1330.

cc

Specifies the century part of the year.

yy

Specifies the two-digit year.

.SS

Specifies the seconds of the hour.

-t,--tail <number>

Lists the most recent log messages as specified by number.

Examples

sscs list -t 100 log

Lists the last 100 messages.

Response Format
Timestamp:message


list mgmt-sw

Synopsis

list mgmt-sw

Description

Lists the management software application that you are logged into.

Examples

sscs list mgmt-sw
Response Format
Application Name: “Sun StorageTek(TM) Common Array Manager”
User: storage
Current Logins: 2
Server: 10.8.88.173
Server OS: SunOS
Server OS Version: 5.10
Product Version: 4.2.0.0
Build Date: 2005/12/03
Install Info: 4.2.0.0 Build 61
Critical Alarms: 13
Down Alarms: 0
Major Alarms: 24
Minor Alarms: 0


list notification

Synopsis

list notification

Description

Lists the remote notification provider and its status.

Examples

sscs list notification
Response Format
 
Entry 	Email/Events Type       						Device 	Priority  	 Events  
enter-no      	email-address 				notification-type device-type 	priority 					 			events
 
Provider	 Active 			Heartbeat (hrs) 		 				IP                 
provider	 active-flag			 frequency       						IP Address
 
Trap #   	IP Name/Address Port     Min Alert Level
trap-no	    IP Address 					Port			Trap level


list registeredarray

Lists registered array information.

Synopsis

list -a [ <array-name,...> ] registeredarray

Description

Lists registered array information or the names of all arrays.

Options

-a,--array <array-name,....>

Specifies the registered array or arrays to list. If no arrays are specified, a list of all array names is provided (optional).

Examples

sscs list -a array01 registeredarray
Response Format

(summary if no <array-name> values are specified)

Array Name: array-name
...
Array Name: array-name
Response Format

(detail if <array-name> values are specified)

Array Name: array-name
IP Address: IP-address
...
IP Address: IP-address


list site

Synopsis

list site

Description

Lists pertinent information on the site.

Example

sscs list site
*Company Name				: Sun Microsystems
*Site Name				: Interop Lab
Address				: 
Address 2				: 
Mail Stop				: 
*City				: Broomfield
State				: 
*Country				: USA
*Contact First Name				: Fred
*Contact Last Name				: Jones
Telephone Number				: 
Extension				: 
*Contact Email				: Fred.Jones@sun.com


list storage-system

Lists detailed information about one or more arrays.

Synopsis

list storage-system [ <array_name,...> ]

Description

Lists detailed information about one or more arrays. If you do not specify an array name, then all array names are listed.

Examples

sscs list storage-system 
Response Format

(Summary of arrays when no <array-name> value is specified)

Array: array-name
...
Array: array-name

 

Detail of array when the <array-name> value is specified)

 
./sscs list storage-system Flx380-1
Name:                  Flx380-1
  ID:                  Flx380-1
  Type:                6140
  Version:             06.19.25.26
  Vendor:              SUN Microsystems
  Model:               Sun StorEdge 6140 System
  Capacity:            367039329280
  Available Capacity:  110674668544
 


list userrole

Lists the user name and role defining the user’s array privileges.

Synopsis

list userrole [ storage | guest ]

Description

Lists the user name and role defining the array privileges.

Options

userrole storage | guest 

List the users with the specified role. The storage role allows write access so that the user can configure the array. The guest role can only monitor the array.

Example

sscs list userrole storage
Response Format
User Name: user-name User Role: user-role
...
User Name: user-name User Role: user-role


login

Log in to the sscs command-line interface (CLI).

Synopsis

login -h <host-name> [ -s CAM | Legacy ] [ -t ] [ -f ] -u <user-name>

Description

Log in to the sscs command-line interface (CLI) on the management system specified by the -h <host-name>. This command starts a CLI session on the management host.

There are two forms of the CLI:

The only difference is that the local CLI requires a user has to run the command as administrator from a shell on the management host and because of this limitation the login and logout commands aren’t supported.

Both CLIs can manage any array that has been registered and added to the Common Array Manager inventory in the same way that the browser interface can manage any array in the inventory. The array type and array management path (in-band, out-of-band, proxy agents) has no limitations with local or remote CLI usage. Both CLIs manage the same arrays with the same command set.

Logging In and Out Using the CLI

The following explains how to log in to and out of a the management host using the CLI. The options for accessing the CLI are presented in the next section.

There are different CLI directories for the remote and local CLIs.

1. Telnet or ssh to the CAM workstation.

ssh root@cam_workstation1

2. Change to the CLI directory (varies by operating system).

 

a. Access the remote CLI directory:

3. Log into the remote CLI by typing the following command:

% sscs login -h <host-name> -u <user-name>


Note - The Local CLI on a data host does not require the login command. You will need the terminal window login to the host.


b. Access the local CLI directory:

NOTE: sscs has an inactivity timer. The session terminates if you do not enter any sscs commands for 30 minutes. You must log in again before you can enter a command after the timeout.

Options

-h,--hostname <host-name>

Required. Specifies the management host name.

-s,--system-type CAM | Legacy

Optional. This option specifies whether you are logging into any of the current arrays supported by the Common Array Manager or the now legacy 6920 array. In some cases, using the -s CAM option may log you in faster as it skips a step of listening for a response from the legacy array.

You no longer have to specify the array-type to login.

-t,--http 

Enables you to use the HTTP protocol to connect to the CAM server, instead of HTTPS. An HTTP connector is configured in Tomcat, the servlet container in Java, for the Java Web Console at port 6789. If SSL is not functioning between the client and the server, this might be required.

-f,--force 

Exists for backward compatibility with legacy management applications that only allow one login per user. This option forces a login to the management host. If another user with the same user name is already logged on, the duplicate user is then logged off.

-u,--username <user-name>

Specifies the user name that to log in.

Example

./sscs login -h localhost -u root


logout

Synopsis

logout

Description

Logs out of the remote sscs command-line interface session.


modify agent

Modify the fault management agent parameters.

Synopsis

modify  [ -a ] [ -d ] [ -r ] [ -i <integer> ]  agent [ <agent_id> ]

Description

Modify the fault management agent parameters. Fault Management Service (FMS) periodically scans devices for new messages and updated health status. This command allows changing the scan interval as well as enabling or disabling the scan. If no options are given the current agent settings are printed out.

Internal agent properties can be set by using name=value for the strings on the agent.

The most common property to be set is debug=0,1,2,3 to turn on agent debugging.

sscs modify agent debug=3

All other properties are for service only.

Options

-a,--activate 

Specifies that the system activate the monitoring agent.

-d,--deactivate 

Specifies that the system deactivate or turn off the monitoring agent.

-r,--run 

Specifies that the system schedule the agent to run either immediately or as soon as the currently scheduled run has finished.

-i,--interval <integer> 

Specifies the interval, in minutes, before the agent scan runs.

agent [ <agent_id> ]

Specifies the agent that you want to modify. The name of the agent monitoring the device can be retrieved using the list device command

Examples

sscs modify -i 5 agent


modify array

Synopsis

modify [ -N <new-array-name> ] array <array-ID>

Description

Modifies the name assigned to the array.



Note - Refer to the modify array command in Chapter 4 for the extensive configuration options that apply to arrays with raid controller.


Options

-N,--new-array-name <array-name>

Specifies the new name of the array.

array <array-ID>

Specifies the name of the array to be modified.

Examples

sscs modify -n array2 array jbod1


modify firmware

Modifies the firmware versions of the specified field-replaceable units (FRUs) of the specified array.

Synopsis

modify -a <array-name> [ -f ] -o [ -t sim | disk ] [ -x sim | disk ] [ -p <path>] [ -c <field-name>] [ -w ]  firmware

Description

Modifies the firmware versions of the specified field-replaceable units of the specified array.

Options

-a,--array <array-name>

Modifies the firmware revision level of the specified field-replaceable units for the specified array only.

-c,--component <field-name>

Modifies the firmware for the selected components. To get the valid values, execute the sscs list -a <array-name> firmware command. Use either the Name or Model field values.

-f,--force 

Modifies the firmware revision level of the all field-replaceable units even if the firmware revision level is already at the baseline level.

-o,--offline 

Performs an offline upgrade of the specified component(s).

-p,--path <path>

Specifies the path of the firmware image file. Loads firmware from a file directly onto the array. Caution should be exercised when using this command because unsupported firmware can be loaded onto a field-replaceable unit. If -p option is provided, the -c option is required.

-t,--type <fru-type>

Modifies the firmware revision level of the field-replaceable units of the specified type only.

-w,--no-warn

Modifies the firmware without displaying the standard warning.

-x,--exclude sim | disk

Excludes the specified component from being upgraded.

Examples

modify - a MyArray -f firmware


modify mgmt-sw

Synopsis

modify  -X <storage-system-name>  mgmt-sw

Description

Stores the specified storage system name for the session. This command is useful for repeated operations with an array. After this command is executed, the -a option for subsequent sscs commands is not necessary.

Options

-X,--storage-system <storage-system-name>

Specifies the name of the storage system.

Example

modify -X MyArray mgmt-sw


modify registeredarray

Change the locally stored password for a registered array.

 

Synopsis

modify -a <array-name> -q registeredarray

Description

Modifies the locally stored password for a registered array or queries for the current password.

Options

-a,--array <array-name> 

Specifies the name of the array to be modified.

-q,--query-for-password

Queries for the current password for the registered array.

Examples

sscs modify -a array00 -q registeredarray
New Password: myregisteredarray
Re-enter New Password: myregisteredarray


modify site

Modifies the site properties for this instance of CAM.

Synopsis

modify [ -r < site_info >,... ] site [ < site_info = value >,... ]

Description

Modifies the site properties for this instance of CAM. The site properties contain information about the site and provides information needed for the notification providers.

Options

-r,--remove < site_info >

Removes the specified site information.

site < site_info = value >

Modifies existing site settings or adds new site information. Possible values for site_info are: customer, contract, name, address, address2, mailStop, city, state, country, contact, phone, email. Possible values for value consist of an alphanumeric string. If the string includes spaces, enclose the values in quotes.

Examples

sscs modify site name=”Development Lab”
sscs modify -r name site 


modify storage-system

Modifies the array information.

Synopsis

modify  [ -N <storage-system-name> ] [ -d <Description-text> ] [ -u <user-name> ] [ -q ] [ -U <user-name> ] [ -Q ]  storage-system <storage-system-name>

Description

Modifies array information such as array name, description, and user name.

Options

-d,--Description

Provides a textual description of the array.

-N,--new-name

Changes the array name.

-q,--query-for-password

Changes the array password.

-u,--user-name

Changes a username on the array.

storage-system <storage-system-name>

Specifies the array where the changes will take effect.

Example

sscs modify -q storage-system MyArray
Enter the array password:
Confirm password:


modify userrole

Change the user role or the IP address from which the user can log in.

Synopsis

sscs modify -u <user-name> -p <password> -i ANY | <IP-address,...> userrole [ storage | guest ]

Description

Modifies a user role or the IP address from which the user can log in. The storage role can perform configuration changes while the guest role can just monitor an array.

Options

-u,--username <user-name>

Specifies the user name that has an assigned role (storage or guest).

-p,--password-required true | false

Specifies whether to require user login with a password.

-i,--ip-address ANY | <IP-address,...>

Specifies the IP addresses from which the user can log in. You can let the user log in from anywhere or restrict access to specified IP addresses.

userrole storage | guest

Specifies the role assigned to the user.

Examples

sscs modify -u bsmith -p true -i ANY userrole guest


register storage-system

Synopsis

register -i <ip-address> [ -p <port-id> ] [ -u <user-name> ] [ -q ] [ -U <user-name> ] [ -Q ]  storage-system 
register -d storage-system 

Description

Registers a storage system with the host.

Options

-d,--discover

Specifies that the host will discover a registered array.

-i,--ipaddress <ip-address> 

Specifies the IP address of the storage system that you want to register.

-p,--port <port-id>

Specifies the port ID of the storage system that you want to register.

-u,--user storage | root | guest

Specifies the user name that has an assigned role.

-q,--query-for-password

Specifies whether to query for a password for this registered storage system.

-U,--device-specific-user <user-name>

Specifies a specific name for this device.

-Q,--query-for-device-specific-password 

Specifies whether to query for a specific password for this registered device.


register sun-connect

Registers CAM software and all monitored arrays with Auto Service Request.

Synopsis

register [ -u <sun_online_account_username> ] [ -H <proxy-host-name> ] [ -P <proxy-port_number> ] [ -U <proxy_username> ] [ -e all | telemetry ] [ -d <all | telemetry> ] sun-connect

Description

Registers CAM software and all monitored arrays with Auto Service Request. Auto Service Request monitors the array system health and performance and automatically notifies the Sun Technical Support Center when critical events occur. Critical alarms generate an Auto Service Request case. The notifications enable Sun Service to respond faster and more accurately to critical on-site issues. All newly discovered arrays will also be registered with the saved registration options.

Options

-d,--disable all | telemetry

Disables all telemetry mechanisms.

-e,--enable all | telemetry

Enables all telemetry mechanisms.

-H,--proxyHost <proxy-host-name>

Specifies the proxy host name.

-P,--proxyPort <proxy-port_number>

Specifies the proxy port number.

-U, --proxyUser <username>

A proxy host authenticated user name.

-u,--user <sun_online_account_username>

Specifies a valid Sun online account user name. To get one go to: https://portal.sun.com/portal/dt/

sun-connect

Specifies that you are registering the CAM software and all monitored arrays with Auto Service Request.

Examples

sscs register -H Proxy1 -P 8080 -u MySunAcctId -e telemetry sun-connect


remove alarm

Synopsis

remove [ -f <device-type> ] [ -s 0 | 1 | 2 | 3 ] [ -A ] alarm [ <alarm-ID,...> ]

Description

Removes the current alarms.

Options

-f,--faultdevtype <device-type>

Removes alarms by the device type using a device key filter.

-s,--severity string 

Specifies the severity level for which you want to remove alarms.

Severity Levels:

0 - minor

1 - major

2 - critical

3 - failure

-A,--All <alarm>

Removes all of the alarms.

alarm <alarm-ID,...>

Specifies the alarm ID or alarm IDs you want to remove.

Examples

sscs remove -f 6140 alarm
sscs remove -s 2 alarm
sscs remove -A alarm


remove notification

Removes a local or remote notification.

Synopsis

remove  [-e <string[,string...]>]  notification local_email | email-filter | trap 
remove  [-i <IP-address>] [-o <string>] [-t 1 | 2 | 3 | 4 | 5 ]  notification local_email | email-filter | trap
remove  -d <string[,string...]> notification local_email | email-filter | trap
remove  [-c <category-id>] [-e <event-id>] [-a ]  notification <emailAddress[,emailAddress...]>

Description

Removes a local or remote notification.

Options

-a, --all

Specifies that all notifications should be removed.

-c, --category <category-id>

Removes the specified category ID notification.

-d, --id <string,string...>

Removes the specified device ID notification.

-e,--email <string[,string...]>

Stops notifications to the specified recipient.

-e, --event <event-id>

Stops email notifications with the specified event ID.

-i, --ip <IP-address>

Stops sending SNMP trap data to the IP address of the specified host.

-t,--trapnumber 1 | 2 | 3 | 4 | 5 

Stop notifications for the specified trap number.

-o,--port <port-id>

Specifies the port ID used to transfer notifications.

local-email

Removes the notification from your local email address.

email-filter

Removes the email filter from the notification.

trap

Removes the SNMP trap notification.

Examples

sscs remove -e john.doe@address.com notification local_email
sscs remove notification nscc_email
sscs remove -t 2 notification trap


remove registeredarray

Removes one or more arrays from the list of registered arrays.

Synopsis

remove -a <array-name,...> registeredarray

Description

Removes one or more arrays from the list of registered arrays.

Options

-a,--array <array-name,...> 

Specifies the registered arrays to remove.

Example

sscs remove -a array00 registeredarray


remove userrole

Removes a user role assigned to a user name.

Synopsis

remove -u <user-name,...> userrole storage | guest

Description

Removes the privileges (storage or guest role) assigned to a user name.

Options

-u,--username <user-name,...> 

Specifies the user name.

userrole storage | guest

Specifies the user’s role to remove.

Examples

sscs remove -u jf39992 userrole guest


service

Perform service-related commands.

Synopsis

service -a <array-name> [ contact | locate [ -o ] | print [ -t <arrayprofile | log | drive_id> ] enable | disable | set name=<new-name> | syncTime ]

Description

Use this command to perform inband communication tests, locate an array by turning its LED on or off, print the contents of the array profile or log file, change the name of the array, and synchronize the time of a JBOD array with the attached data host.

Options

-a,--array <array-name>

Specifies the array to perform a service.

-t,--target arrayprofile | log

Specifies the target file to print.

-o,--off 

Turns off the locator LED.

contact

Tests connectivity to the array (inband communication test).

disable 

Disables the specified target drive.

enable

Enables the specified target drive.

locate

Locates the array by turning LED on.

name=<new-name>

Changes the name of the array to the specified name.

print

Prints all physical information available for the specified array.

syncTime

Synchronize the time of the JBOD array with the attached host.

Examples

Turn off all LED locate indicators on the specified arrays.

sscs service -d "JBOD(2029QTF0802QCK00E)" -t off locate

Set the JBOD name to J4200_box1

sscs service -d "JBOD(2029QTF0802QCK00E)"  name=J4200_box1 set

Disable drive00 on the array named J4400_box3.

sscs service -a j4400_box3 -t drive00 disable


unregister storage-system

Synopsis

unregister storage-system <storage-system-name,...>

Description

Unregisters an array from the list of registered storage systems.

Options

storage-system <storage-system-name,...>

Specifies the storage system or storage systems that you want to unregister from the list of registered storage-systems.

Example

sscs unregister storage-system array19


unregister sun-connection

Stop notifications of system health and performance to Sun using the Auto Service Request (ASR) feature.

Synopsis

unregister sun-connection

Description

Stops sending system health and performance information on monitored arrays back to Sun. Newly discovered arrays will not be activated with ASR.

Examples

sscs unregister sun-connect


version

Shows the versions of software that you are running on the management host and the SSCS client.

Synopsis

-V, --version

Description

Shows the versions of software that you are running on this array and the client.

Examples

sscs -V
Sun StorageTek(TM) Common Array Manager v6.1.1.0
sscs client v1.1.4