| Sun StorageTek Common Array Manager CLI Guide for the J4000 Array Family |     |
| C H A P T E R 2 |
|
Command Summary |
This chapter describes the sscs subcommands and their options.
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 -n <event-id> -s info | none notification email-filter
Turn on the SNMP trap notifier:
add notification trap
Sets up email and SNMP trap notification. You can add one or more email addresses for notifications.
-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 emails. 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.
sscs add -t 2 -i 10.10.10.1 notification trap
add -d registeredarray add -i [ -q ] registeredarray
Discovers all arrays on the same subnet as the management host and registers them.
-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.
sscs add -i 10.10.10.1 registeredarray
add -u <user-name> userrole storage | guest
Adds a user name to the user access list.
-u,--username <user-name>
Specifies a user name. The <user-name> must exist on the 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 [ -s <1..3> ] [ -f <device-type> ] [ -a <service-advisor-ID> ] [ -S ] alarm [ <alarm_ID> ]
This command provides detailed information on the specified alarms. When alarm IDs are not specified, it provides summary information on all alarms.
-a,--advisor 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.
-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.
sscs list -f j4200 alarm sscs list -s 2 alarm sscs list -s 1 -a alarm
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 [ <array-name,...> ]
Lists detailed information about one or more arrays. If you do not specify an array name, then all array names are listed.
sscs list array
Array: array-name ... Array: array-name
list -a <array-name> date
Lists the current date and time in hours, minutes, and seconds that is set on the array. The time zone of the management system is assumed to be the time zone of the array.
-a,--array <array-name>
Specifies the array for which you want to see the date.
sscs list -a array00 date
Date: weekday month day HH:MM:SS YYYY
Tue Dec 20 16:09:36 2004
list [ -n <device-name> ] [ -i <IP-address>] device [ device-ID [,device-ID...]] list devices
List the details of a device or the devices being monitored.
-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.
Specifies one or more device IDs.
sscs list -n device1 device sscs list devices sscs list -i 10.1.1.1 device
DeviceName: device-ID Type: type IP Address: IP-address Monitored On: interface Key: device-key Active: Y | N WWN: WWN cd /opt/se6x20/cli/bin MgmtLevel: management-level Said: Storage-Automated-Diagnostic-Environment-identifier Time Added: time added
Monitored On Device Type IP Address WWN Active ASR cam-gax.east 5080020000467400 j4500 127.0.0.1 5080020000467400 Y N
list -a <array-name> disk [ <disk-name,...> ]
-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.
sscs list -a array00 -t 1 disk
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 [ -s <1..3> ] [ -d <device_id> ] [ -t <type> ] [ -a ] [ -f <keyword> ] [ -l <limit> ] event [ <event_Id> ]
Lists the FMS event log information.
-s,--severity <1..3>
Specifies a severity level at which to filter events so that only the events of that severity level are listed.
-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>
sscs list -s 3 event
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 [ -a <array-name> ] [ -t <type> ] [-x <component_type1 [,component_type1...]>] firmware
Lists the firmware versions of the field-replaceable units in this device.
-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.
List the component firmware revisions for all JBODs.
sscs list firmware
List the component firmware revisions for a specified JBOD.
sscs list -a jbod1 firmware
list -d <device-name> [ -t disk | fans | power supplies | sim | all ] [ -s ] fru [ string,... ]
Lists the field-replaceable units in this device.
-d <device-name>
-t,--type disk | fans | power supplies | sim | all
Lists the type of field-replaceable units installed in this device.
-s,--summary
Lists a summary of this field-replaceable unit.
fru [string,...]
Lists the field-replaceable unit or units in this device.
sscs list -d jbod1 fru
Output includes the component name, FRU type, alarm state, status, revision, and unique ID.
list -a array-name jobs [job-id [,job-id...]]
Lists job IDs and status associated with the specified JBOD and optionally specified job ID.
-a,--array <array-name>
Specifies the name of the JBOD.
job-id
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
list [ -s { [ mmdd ] HHMM | mmddHHMM [ cc ] yy } [ .SS ] ] [ -f { [ mmdd ] HHMM | mmddHHMM [ cc ] yy } [.SS ] ] [ -t <number-of-messages> ] log
Lists the user-initiated actions performed for all registered arrays. If you do not specify any options, all log messages are displayed.
-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
.SS
Specifies the seconds of the hour.
-t,--tail <number>
Lists the most recent log messages as specified by number.
sscs list -t 100 log
Timestamp:message
list mgmt-sw
Lists the management software application that you are logged into.
sscs list mgmt-sw
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
Lists the remote notification provider and its status.
sscs list notification
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 and trap level
list -a [ <array-name,...> ] registeredarray
Lists registered array information.
-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).
sscs list -a array01 registeredarray
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
Lists pertinent information on the site.
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 [ <array_name,...> ]
Lists detailed information about one or more arrays. If you do not specify an array name, then all array names are listed.
sscs list storage-system array00
Array: array-name ... Array: array-name
list userrole [ storage | guest ]
Lists the user name and user role information.
userrole storage | guest
Specifies the role for this user.
sscs list userrole storage
User Name: user-name User Role: user-role ... User Name: user-name User Role: user-role
login -h <host-name> [ -s CAM | Legacy ] [ -t ] [ -f ] -u <user-name>
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 specified host.
-h,--hostname <host-name>
Specifies the Management Host name.
-s,--system-type CAM | Legacy
Specifies whether you log into Common Array Manager or legacy management software.
-t,--http
Enables you to use the HTTP protocol to connect to the Element Manager (EM) 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 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 has an assigned role.
logout
Logs out of the remote sscs command-line interface session.
modify [ -a ] [ -d ] [ -r ] [ -i <integer> ] agent [ <agent_id> ]
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.
All other properties are for service only.
-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
sscs modify -i 5 agent
modify [ -N <new-array-name> ] array <array-ID>
Modifies the name assigned to the array.
-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.
sscs modify -n array2 array jbod1
modify -a <array-name> [ -f ] -o [ -t sim | disk ] [ -x sim | disk ] [ -p <path>] [ -c <field-name>] [ -w ] firmware
Modifies the firmware versions of the specified field-replaceable units of the specified array.
-a,--array <array-name>
Modifies the firmware revision level of the specified field-replaceable units for the specified array only.
-c,--component <field-name>
Modies 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.
modify - a MyArray -f firmware
modify -X <storage-system-name> mgmt-sw
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.
-X,--storage-system <storage-system-name>
Specifies the name of the storage system.
modify -X MyArray mgmt-sw
modify -a <array-name> -q registeredarray
Modifies the locally stored password for a registered array.
-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.
sscs modify -a array00 -q registeredarray New Password: myregisteredarray Re-enter New Password: myregisteredarray
modify [ -r < site_info >,... ] site [ < site_info = value >,... ]
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.
-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.
sscs modify site name=”Development Lab” sscs modify -r name site
modify [ -N <storage-system-name> ] [ -d <Description-text> ] [ -u <user-name> ] [ -q ] [ -U <user-name> ] [ -Q ] storage-system <storage-system-name>
Modifies the array information.
-d,--Description
Provides a textual description of the array.
-N,--new-name
-q,--query-for-password
-u,--user-name
Changes a username on the array.
storage-system <storage-system-name>
Specifies the array where the changes will take effect.
sscs modify -q storage-system MyArray Enter the array password: Confirm password:
sscs modify -u <user-name> -p <password> -i ANY | <IP-address,...> userrole [ storage | guest ]
-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.
userrole storage | guest
Specifies the role assigned to the user.
sscs modify -u bsmith -p true -i ANY userrole guest
register -i <ip-address> [ -p <port-id> ] [ -u <user-name> ] [ -q ] [ -U <user-name> ] [ -Q ] storage-system register -d storage-system
Registers a storage system with the host.
-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 [ -u <sun_online_account_username> ] [ -H <proxy-host-name> ] [ -P <proxy-port_number> ] [ -U <proxy_username> ] [ -e all | telemetry ] [ -d <all | telemetry> ] sun-connection
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.
-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.
sscs register -H Proxy1 -P 8080 -u MySunAcctId -e telemetry sun-connect
remove [ -f <device-type> ] [ -s 1 | 2 | 3 ] [ -A ] alarm [ <alarm-ID,...> ]
-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.
-A,--All <alarm>
alarm <alarm-ID,...>
Specifies the alarm ID or alarm IDs you want to remove.
sscs remove -f 6140 alarm sscs remove -s 2 alarm sscs remove -A alarm
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...]>
Removes a local or remote notification.
-a, --all
Specifies that all notifications should be removed.
-c, --category <category-id>
Specifies to remove the specified category ID notification.
-d, --id <string,string...>
Specifies to remove the specified device ID.
-e,--email <string[,string...]>
Specifies that notifications should no longer be sent to the specified recipient.
-e, --event <event-id>
Specifies the event ID to be filtered from email notifications.
-i, --ip <IP-address>
Specifies the IP address of the host that will no longer receive the SNMP trap data.
-t,--trapnumber 1 | 2 | 3 | 4 | 5
Specifies the trap number associated with this notification.
-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.
sscs remove -e john.doe@address.com notification local_email sscs remove notification nscc_email sscs remove -t 2 notification trap
remove -a <array-name,...> registeredarray
Removes one or more arrays from the list of registered arrays.
-a,--array <array-name,...>
Specifies the registered arrays to remove.
registeredarray
Removes the array registration.
sscs remove -a array00 registeredarray
remove -u <user-name,...> userrole storage | guest
Removes user names from a user role (storage and guest).
-u,--username <user-name,...>
Specifies the user name to remove.
userrole storage | guest
sscs remove -u jf39992 userrole guest
service -a <array-name> [ contact | locate [ -o ] | print [ -t <arrayprofile | log | drive_id> ] enable | disable | set name=<new-name> | syncTime ]
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 the JBOD with the attached data host.
-a,--array <array-name>
Specifies the array to perform a service.
-t,--target arrayprofile | log
Specifies the target file to print.
-o,--off
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 JBOD to the specified name.
Prints all physical information available for the specified array.
syncTime
Synchronize the time of the JBOD with the attached host.
Turn off all LED locate indicators on the specified JBOD.
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 <storage-system-name,...>
Unregisters an array from the list of registered storage systems.
storage-system <storage-system-name,...>
Specifies the storage system or storage systems that you want to unregister from the list of registered storage-systems.
sscs unregister storage-system array19
unregister sun-connection
Stops sending system health and performance information on monitored arrays back to Sun. Newly discovered arrays will not be activated with ASR.
sscs unregister sun-connect
-V, --version
Shows the versions of software that you are running on this array and the client.
sscs -V Sun StorageTek(TM) Common Array Manager v6.1.1.0 sscs client v1.1.4
| Sun StorageTek Common Array Manager CLI Guide for the J4000 Array Family | 820-4419-10 | |
Copyright © 2008, Sun Microsystems, Inc. All Rights Reserved.