Summary of Contents for Dot Hill Systems AssuredSAN 6004
Page 1
AssuredSAN 6004 CLI Reference Guide For firmware release GF101 or later Abstract This guide provides information about managing a Dot Hill AssuredSAN 6004 storage system by using its command-line interface (CLI). P/N 83-00006818- 1 1-01 Revision A May 2015...
About this guide This guide provides information about managing a Dot Hill AssuredSAN™ storage system by using its command-line interface (CLI). Intended audience This guide is intended for storage system administrators. Prerequisites Prerequisites for using this product include knowledge of: •...
Page 11
TIP: Provides helpful hints and shortcuts. Document conventions and symbols...
Using the CLI This chapter introduces the AssuredSAN 6004 command-line interface (CLI). In this guide: • The term disk group refers to a vdisk for linear storage. • The term pool refers to a single vdisk for linear storage. Accessing the CLI The CLI software embedded in the controller modules enables you to manage and monitor storage-system operation.
Using CLI interactively By default the CLI is an interactive application. When you are logged into the CLI, the CLI waits for a command to be entered and then responds to it. The following example shows interactively starting a Telnet session, logging into the CLI, executing a command to show volumes, and exiting the CLI: $: telnet IP-address IP-address...
Page 14
$telnet = new Net::Telnet ( Timeout=>10, Errmode=>'die', Prompt => '/\# $/i'); if ( !cLogin($ipAddr, $username, $password) == 1 ) print("Error: $username user failed to log in. Exiting.\n"); $telnet->close; exit(0); For scripting support, the following command can be used to access the XML API and to disable the paging mode that pauses for each full screen of command output.
Page 15
print "Property = " . $name . "\n"; if( $name eq 'response' ) { $sessionKey = $prop->textContent; print "Session Key = $sessionKey\n"; # Run a sample command to obtain the disks in the system. $url = 'http://10.0.0.2/api/show/disks'; $req = HTTP::Request->new(GET => $url); $req->header('sessionKey' =>...
Using the XML API The Management Controller provides access for monitoring and management via the Telnet and SSH protocols for command-line interface semantics, or via the HTTP and HTTPS protocols for XML API request/response semantics. You can use an XML parser, such as XML::Parser in Perl, to process the XML output and store this information as objects.
Scripting guidelines When scripting command input, use CLI syntax as defined in this guide. For use with Telnet or SSH, use a space character between command names, parameters, and their values (as shown throughout this guide). For use with the HTTP interface, use a ’/’ character instead of a space character between command names, parameters, and their values.
<PROPERTY name="time-stamp-numeric" type="uint32" size="25" draw="false" sort="datetime" display-name="Time">1405001789</PROPERTY> </OBJECT> </RESPONSE> XML API optimization The following are two ways to optimize XML API performance: • Use embedded objects. This allows one object to contain not only properties but also other objects. In general, parsing a structure such as this is easier as the association between objects is simpler.
Unless otherwise specified, a parameter value can include spaces and printable UTF-8 characters except: " , < \ A parameter value that includes a space must be enclosed in double quotes. Parameters can be entered in any order. However, for a parameter with no keyword, if you want to specify a value that is partially or entirely the same as the keyword of an optional parameter, you must specify the optional parameter before the value.
Specifying ports Controller module host ports are specified by port number only (to use the same port in both controllers) or by controller ID and port number (to specify a port in one controller). Controller IDs are A for the upper controller and B for the lower controller, and are not case sensitive.
Command completion, editing, and history The CLI supports command completion, command editing, and command history. When entering commands interactively you can abbreviate their names and keywords. For example, you can enter sho cl to run the show cli-parameters command. If you press Tab or Ctrl+i after typing sufficient characters to uniquely identify the command or keyword, the remainder of the command or keyword is displayed so you can confirm your intent.
Table 5 Size representations in base 2 and base 10 Base 2 Base 10 Unit Size in bytes Unit Size in bytes KiB (kibibyte) 1,024 KB (kilobyte) 1,000 MiB (mebibyte) 1,024 MB (megabyte) 1,000 GiB (gibibyte) 1,024 GB (gigabyte) 1,000 TiB (tebibyte) 1,024 TB (terabyte)
Categorical list of commands The following table helps you find a command within a category of functionally related commands. A command might appear in more than one category. Table 7 Commands by category Category Commands CLI and users create user, delete user, exit, help, cli-parameters,...
Alphabetical list of commands This chapter is organized to help you find a command by name. Each command topic includes one or more of the following sections: Description The command's purpose and notes about its usage Min. role The minimum user role required to use the command Syntax The command's syntax Parameters Descriptions of the command's parameters Output Descriptions of fields shown in console format...
abort scrub Description Aborts a media scrub operation. You can abort scrub of specified disk groups, vdisks, or volumes. Min. role manage Syntax abort scrub [vdisk vdisks] [volume volumes] Parameters Specify only one of the following parameters. vdisk vdisks Optional. A comma-separated list of the names or serial numbers of the vdisks to stop scrubbing. A name that includes a space must be enclosed in double quotes.
abort verify Description Aborts a media verify operation. You can abort verification of specified disk groups or vdisks. Min. role manage Syntax abort verify [vdisk vdisks] Parameters vdisk vdisks Optional. A comma-separated list of the names or serial numbers of the vdisks to stop verifying. A name that includes a space must be enclosed in double quotes.
add spares Description Designates specified available disks to be spares. A spare can replace a failed disk of the same type (enterprise SAS, for example) and the same or lower capacity in a disk group with a fault-tolerant RAID level (1, 3, 5, 6, 10, 50). For linear storage, you can add global spares or dedicated spares: •...
check firmware-upgrade-health Description Checks that the system is ready for a firmware upgrade. Under normal conditions, firmware upgrade can be performed safely without risk to data availability or integrity. However, when the system is degraded—for example, because of failed or missing components or lack of multi-pathing to disks—upgrade failure or loss of availability can occur.
Page 29
Check firmware upgrade health for a system that has problems to be resolved before upgrade. # check firmware-upgrade-health Upgrade Health --------------------------------- Fail Condition Detected Risks ---------------------------------------------------------------------------- One or more disks are currently single ported. Data unavailability At least one controller is not up. Data unavailability One or more temperature sensors indicate a critical temperature.
clear cache Description Clears unwritable cache data from both controllers. This data cannot be written to disk because it is associated with a volume that no longer exists or whose disks are not online. If the data is needed, the volume's disks must be brought online. If the data is not needed it can be cleared, in which case it will be lost and data will differ between the host and disk.
clear degraded-disk Description Sets a degraded disk’s health to OK and clears the disk’s error count. For a disk that has been failed by the degraded-disk policy, this command also clears the disk’s metadata. After this command is run, error counts used to measure disk medium errors are restarted. Min.
clear disk-metadata Description Clears metadata from leftover disks. For a leftover disk, the show disks command shows the Usage value LEFTOVR. CAUTION: • Only use this command when all vdisks are online and leftover disks exist. Improper use of this command may result in data loss.
clear events Description Clears the event log in controller A, B, or both. For use by or with direction from technical support. Min. role manage Syntax clear events [a|b|both] Parameters a|b|both Optional. The controller event log to clear. If this parameter is omitted, both event logs are cleared. Example Clear the event log for controller A.
clear expander-status Description Clears the counters and status for SAS expander lanes. For use by or with direction from technical support. Counters and status can be reset to a good state for all enclosures, or for a specific enclosure whose status is Error as shown by the show expander-status command.
create certificate Description Creates or removes a custom security certificate. The storage system supports use of unique certificates for secure data communications, to authenticate that the expected storage systems are being managed. Use of authentication certificates applies to the HTTPS protocol, which is used by the web server in each controller module. After using this command you must restart the system's Management Controllers to have the change take effect.
create host (Deprecated) initiator. create schedule Description Schedules a task to run automatically. Min. role manage Syntax create schedule schedule-specification "specification" task-name task-name schedule-name Parameters schedule-specification "specification" Defines when the task will first run, and optionally when it will recur and expire. You can use a comma to separate optional conditions.
Page 37
Create schedule Sched2 that runs Task2 for the first time on March 1, 2014, and on the first weekday of each month, with no expiration. # create schedule schedule-specification "start 2012-03-01 00:01 only first weekday of month" task-name Task2 Sched2 See also •...
create task Description Creates a task that can be scheduled. You can create a task to enable or disable drive spin down. Min. role manage Syntax To create a task to enable spin down for all disks: create task type EnableDSD name To create a task to disable spin down for all disks: create task...
create user Description Creates a user account. The system supports 12 user accounts. You can create a general user that can access the WBI, CLI, or FTP interface, or an SNMPv3 user that can access the MIB or receive trap notifications. SNMPv3 user accounts support SNMPv3 security features such as authentication and encryption.
Page 40
interfaces interfaces Optional. Specifies the interfaces that the user can access. Multiple values must be separated by commas and no spaces. A command that specifies snmpuser or snmptarget cannot also specify a non-SNMP interface. • cli: Command-line interface. This is enabled by default. •...
Page 41
roles roles Optional. Specifies the user’s roles as one or more of the following values: • monitor: User can view but not change system settings. This is the default. • manage: User can view and change system settings. • diagnostic: User can view and change system settings. Multiple values must be separated with a comma (with no spaces).
Page 42
Create user MIB that can view the SNMP MIB, using authentication and encryption. # create user interfaces snmpuser password Abcd1234 authentication-type SHA privacy-type AES privacy-password Abcd5678 MIB Create user Traps that can receive SNMP trap notifications, using authentication without encryption. # create user interfaces snmptarget authentication-type MD5 trap-host 172.22.4.171 Traps Enter new password: ********...
create vdisk Description Creates a vdisk using the specified RAID level, disks, and spares. This command applies to linear storage only. All disks in the vdisk must be the same type (enterprise SAS, for example). For each RAID level, the minimum and maximum numbers of disks supported are: •...
Page 44
name A name for the new vdisk. Input rules: • The value is case sensitive. • The value can have a maximum of 32 bytes, where ASCII characters are 1 byte, most Latin (Western European) characters with diacritics are 2 bytes, and most Asian characters are 3 bytes.
create volume Description Creates a volume in a vdisk. You must specify a size for the volume. You can create the volume unmapped or set its default mapping. Default mapping settings apply to all hosts, unless overridden by an explicit mapping between a host and the volume. You can later change the mapping by using map volume unmap volume commands.
Page 46
See also • create volume-set • delete volumes • set volume • show ports • show vdisks • show volumes Alphabetical list of commands...
create volume-set Description Creates a specified number of volumes in a vdisk. You must specify a base name and a size for the volumes. You can create the volumes unmapped or set their default mapping. Default mapping settings apply to all hosts, unless overridden by an explicit mapping between a host and the volume. You can later change mappings by using the map volume unmap volume...
size size[B|KB|MB|GB|TB|KiB|MiB|GiB|TiB] Sets the volume size. The unit is optional (B represents bytes). If base 2 is in use, whether you specify a base-2 or base- 1 0 unit, the resulting size will be in base 2. If no unit is specified, the default is 512-byte blocks.
delete initiator-nickname Description Deletes manually created initiators or the nickname of discovered initiators. Volume maps continue to apply to the initiators in the host that is deleted. If you delete the nickname of a discovered initiator, commands will show the initiator by its ID. Min.
delete schedule Description Deletes a task schedule. If you no longer want a scheduled task to occur, you can delete the schedule. When a volume is deleted, its schedules and tasks are also deleted. If the schedule uses a task that is not used by any other schedule, a confirmation prompt will ask whether you want to delete the schedule and the task.
delete task Description Deletes a task. If the task is scheduled, a confirmation prompt will ask whether you want to delete the task and its schedules. Reply yes to delete both, or no to cancel the command. Min. role manage Syntax delete task [prompt yes|no]...
delete user Description Deletes a user account. Except for the user you are logged in as, you can delete any user, including the default users. However, the system requires at least one CLI user with the manage role to exist. When a user is deleted, any sessions associated with that user name are terminated.
delete vdisks Description Deletes specified vdisks. This command applies to linear storage only. This unmaps and deletes all volume in the vdisks and makes all the disks available. CAUTION: Deleting a vdisk will delete all data it contains. NOTE: If you delete a quarantined vdisk and its missing disks are later found, the vdisk will reappear as quarantined or offline and you must delete it again (to clear those disks).
delete volumes Description Deletes specified volumes. CAUTION: Deleting a volume will delete all data it contains and its schedules. Min. role manage Syntax delete volumes volumes Parameters volumes A comma-separated list of the names or serial numbers of the volumes to delete. A name that includes a space must be enclosed in double quotes.
dequarantine Description Removes a disk group from quarantine. CAUTION: Carefully read this topic to determine whether to use the dequarantine command to manually remove a disk group from quarantine. The dequarantine command should only be used as part of the emergency procedure to attempt to recover data and is normally followed by use of the trust command.
Page 56
When a disk group is quarantined, its disks become write-locked, its volumes become inaccessible, and it is not available to hosts until it is dequarantined. If there are interdependencies between the quarantined disk group’s volumes and volumes in other disk groups, quarantine may temporarily impact operation of those other volumes.
Example After determining that vdisk VD1 is quarantined, remove it from quarantine and re-check its status. # show vdisks Name ... Status ... ------------------- ... QTDN ... (RAID 6 quarantined with a down disk) ------------------- # dequarantine vdisk VD1 Info: Vdisk VD1 was dequarantined. (VD1) Success: Command completed successfully.
expand vdisk Description Adds disks to a vdisk to expand its storage capacity. This command applies to linear storage only. The new disks must be the same type as disks already in the vdisk and should also have the same capacity.
Page 60
Expand RAID- 1 0 vdisk R10 to include an additional mirror pair. # expand vdisk disks 2.9-10 R10 Expand RAID-50 vdisk R50, which has four 3-disk sub-vdisks, to include an additional 3-disk sub-vdisk. # expand vdisk disks 2.1-2,2.5 R50 See also • show disks •...
expand volume Description Expands a standard volume. Volume sizes are aligned to 4-MB boundaries. When a volume is created or expanded, if the resulting size would be less than 4 MB it will be increased to 4 MB; if the resulting size would be greater than 4 MB it will be decreased to the nearest 4-MB boundary.
fail Description Forces the partner controller module to crash for a non-maskable interrupt. The command causes the crash by issuing an internal kill command to the Storage Controller in the partner controller module. This might be helpful to gather debug information that is only available via a crash dump. CAUTION: Do not use this command in a production system.
map volume Description Maps specified volumes using settings that override the volumes’ default mapping. When a volume is created, if no mapping settings are specified the volume is not mapped. Otherwise, those settings become its default mapping, which specifies the controller host ports and access level that all connected initiators have to the volume, and the LUN presented to all initiators to identify the volume.
Page 64
volumes A comma-separated list of the names or serial numbers of the volumes to map. For volume syntax, "Command syntax" (page 18). Example Map volume v2 with read-only access to initiator Init1, using port A1 and LUN 100. # map volume access ro ports a1 lun 100 initiator Init1 v2 Map volumes v2 and v3 with read-write access for Init2, using ports A1 and B1 and LUN 101.
meta Description In XML API format only, shows all property metadata for objects. This includes data not shown in brief mode. Min. role monitor Syntax meta basetypes Parameters basetypes A basetype or a list of basetypes separated by commas (with no spaces) to specify the objects for which to show metadata.
ping Description Tests communication with a remote host. The remote host is specified by IP address. Ping sends ICMP echo response packets and waits for replies. Min. role monitor Syntax ping host-address [count] Parameters host-address The remote host’s IP address in dotted decimal form. count Optional.
release volume Description Clears initiator registrations and releases persistent reservations for all or specified volumes. Normally, reservations placed on volumes by initiators accessing those volumes can be released by host software. This command should be used only when the system is in an abnormal state, perhaps due to a configuration problem, and you need to remove all reservations for specified volumes and return them to a “clean”...
remove spares Description Removes specified spares. You can remove global spares and dedicated spares (linear storage only) in the same command. Min. role manage Syntax remove spares disks Parameters disks The IDs of the spares to remove. For disk syntax, see "Command syntax"...
rescan Description This command forces rediscovery of disks and enclosures in the storage system. If both Storage Controllers are online and able to communicate with both expansion modules in each connected enclosure, this command rebuilds the internal SAS layout information, reassigns enclosure IDs based on controller A’s enclosure cabling order, and ensures that the enclosures are displayed in the proper order.
reset all-statistics Description Resets performance statistics for both controllers. You can specify either to reset all live statistics to zero, or to reset (clear) all historical performance statistics for all disks. If you reset historical statistics, an event will be logged and new data samples will continue to be stored every quarter hour. Min.
reset controller-statistics Description Resets performance statistics for controllers. This command resets all controller statistics except Power On Time. To reset this, restart or power cycle a controller. Min. role manage Syntax reset controller-statistics [a|b|both] Parameters a|b|both Optional. Specifies whether to reset statistics for controller A, B, or both. If this parameter is omitted, statistics are reset for both controllers.
reset disk-error-statistics Description Resets error statistics for all or specified disks. Statistics that are reset include: • Number of SMART events recorded • Number of I/O timeouts accessing the disk • Number of times the disk did not respond • Number of attempts by the controllers to spin up the disk •...
reset disk-statistics Description Resets performance statistics for disks. This command resets basic disk statistics but not disk error statistics. To reset these, use the reset disk-error-statistics command. Min. role manage Syntax reset disk-statistics Example Reset statistics for all disks. # reset disk-statistics See also •...
reset host-link Description Resets specified controller host ports (channels). For SAS, you can reset a port pair (either the first and second ports or the third and fourth ports). Resetting a host port issues a COMINIT/COMRESET sequence and might reset other ports. Min.
reset host-port-statistics Description Resets performance statistics for controller host ports. Min. role manage Syntax reset host-port-statistics [ports ports] Parameters ports ports Optional. The controller ID and port number of ports for which to reset statistics. For port syntax, see "Command syntax" (page 18).
reset vdisk-statistics Description Resets performance statistics for all or specified vdisks. This command applies to linear storage only. Min. role manage Syntax reset vdisk-statistics [vdisks] Parameters vdisks Optional. A comma-separated list of the names or serial numbers of the vdisks for which to reset statistics.
reset volume-statistics Description Resets performance statistics for all or specified volumes. Min. role manage Syntax reset volume-statistics [volumes] Parameters volumes Optional. A comma-separated list of the names or serial numbers of the volumes for which to reset statistics. A name that includes a space must be enclosed in double quotes. If this parameter is omitted, statistics are reset for all volumes.
restart mc Description Restarts the Management Controller in a controller module. When you restart a Management Controller, communication with it is lost until it successfully restarts. If the restart fails, the partner Management Controller remains active with full ownership of operations and configuration information.
restart sc Description Restarts the Storage Controller in a controller module. When you restart a Storage Controller, it attempts to shut down with a proper failover sequence, which includes stopping all I/O operations and flushing the write cache to disk, and then the Storage Controller restarts.
restore defaults Description Restores the default configuration to the controllers. For use by or with direction from a service technician. For details about which settings are restored see "Settings changed by restore defaults" (page 350). If the system contains only one controller module when the command is issued, the system’s redundancy mode will be set to Single Controller mode.
scrub vdisk Description Analyzes specified vdisks to find and fix disk errors. This command acts on disks in a vdisk but not dedicated spares or leftover disks. This command will fix parity mismatches for RAID 3, 5, 6, and 50; mirror mismatches for RAID 1 and 10; and media errors for all RAID levels.
scrub volume Description Analyzes specified volumes to find and fix disk errors. This command applies to linear storage only. This command acts on the disk portions spanned by each volume, but it does not act on dedicated spares or leftover disks. This command will fix parity mismatches for RAID 3, 5, 6, and 50; mirror mismatches for RAID 1 and 10;...
set advanced-settings Description Sets advanced system configuration parameters. Min. role manage Syntax set advanced-settings [auto-stall-recovery enabled|disabled|on|off] [auto-write-back enabled|disabled|on|off] [background-disk-scrub enabled|disabled|on|off] [background-scrub enabled|disabled|on|off] [background-scrub-interval interval] [compact-flash-failure enabled|disabled|on|off] [controller-failure enabled|disabled|on|off] [dynamic-spares enabled|disabled|on|off] [emp-poll-rate rate] [fan-failure enabled|disabled|on|off] [host-cache-control enabled|disabled|on|off] [independent-cache enabled|disabled|on|off] [managed-logs enabled|disabled|on|off] [missing-lun-response notready|illegal] [partner-firmware-upgrade enabled|disabled|on|off] [partner-notify enabled|disabled|on|off]...
Page 84
background-scrub enabled|disabled|on|off Optional. Sets whether disks in vdisks are automatically checked for disk defects to ensure system health. The interval between background vdisk scrub finishing and starting again is specified by the background-scrub-interval parameter. • disabled or off: Background vdisk scrub is disabled. This is the default. •...
Page 85
independent-cache enabled|disabled|on|off Optional. Sets the cache redundancy mode for a dual-controller storage system. For the change to take effect, you must restart both Storage Controllers. • disabled or off: Controller failover is enabled and data in a controller’s write-back cache is mirrored to the partner controller.
Page 86
smart enabled|disabled|on|off|detect-only Optional. Enables or disables SMART (Self-Monitoring Analysis and Reporting Technology) monitoring for all disks in the storage system. • disabled or off: Disables SMART for all disks in the system and for all disks added to the system. •...
set cache-parameters Description Sets a volume’s cache options. Settings you can change include: NOTE: Only change the read-ahead cache settings if you fully understand how the host operating system, application, and adapter move data so that you can adjust the settings accordingly. Be prepared to monitor system performance and adjust read-ahead size until you find the optimal size for your application.
Page 89
volume The name or serial number of the volume to change. A name that includes a space must be enclosed in double quotes. Example Set the cache policy, optimization mode, and read-ahead size for volume V1. # set cache-parameters write-policy wb optimization standard read-ahead-size stripe V1 See also •...
set cli-parameters Description Sets options that control CLI behavior. If you are accessing the CLI through the network port, settings apply to the current CLI session only. If you are accessing the CLI through the enclosure’s CLI port, settings persist across sessions. The base, locale, precision, temperature scale, timeout, and units settings are read from the user’s account, and can be overridden by using this command.
Page 91
locale English|en|Spanish|es|French|fr|German|de|Italian|it|Japanese| ja|Korean|ko|Dutch|nl|Chinese-simplified|zh-s|Chinese-traditional|zh-t Optional. The display language. The default is English. pager enabled|on|disabled|off Optional. • enabled or on: Halts output after each full screen to wait for keyboard input. This is the default. • disabled or off: Output is not halted. When displaying output in XML API format, which is intended for scripting, disable paging.
set controller-date Description Sets the date and time parameters for the system. You can set the date and time manually or configure the system to communicate with a Network Time Protocol (NTP) server. Alternatively, you can configure NTP by using the set ntp-parameters command.
Page 93
timestamp timestamp The date and time represented as the number of seconds (not counting leap seconds) that have elapsed since 1970-01-01 00:00:00 UTC. The resulting time will be in UTC, unless you also specify the timezone parameter. Example Manually set the system time and date to 1:45 PM on September 22, 201 1. # set controller-date sep 22 13:45:0 2011 Manually set the system date and time to 4:30:50 PM on November 2, 201 1 by specifying a timestamp and an offset for the Central Time zone.
set debug-log-parameters Description Sets the types of debug messages to include in the Storage Controller debug log. For use by or with direction from technical support. Min. role manage Syntax set debug-log-parameters message-type+|- [...] Parameters message-type+|- One of the following message types, followed by a plus (+) to enable or a minus (-) to disable inclusion in the log: •...
set degraded-disk-policy Description Sets the action for the system to take when it determines that a disk is degraded. This determination is made based on criteria configured with the set degraded-disk-threshold command. A degraded-disk policy will never fail a disk that would result in the loss of data, such as failing a disk in non-fault-tolerant vdisk.
set degraded-disk-threshold Description Sets criteria for the system to identify degraded disks based on a trend of degrading quality of service. Degrading quality of service includes disks that demonstrate a consistent or increasing number of recovered errors (sense key 1) or unrecovered errors (sense key 3). When a configured threshold is reached, a degraded-disk policy is enacted.
Page 97
Parameters name threshold-name Specifies one of the following values that identifies the disk tier and RAID redundancy level: • archive-single: Archive tier, single redundancy RAID. • archive-dual: Archive tier, dual redundancy RAID. • archive: Archive tier, any RAID level. • standard-single: Standard tier, single redundancy RAID. •...
Page 98
Example Degrade any standard disk should it incur three unrecoverable-errors over the period of one day. # set degraded-disk-threshold name standard target unrecoverable-errors threshold-a day.1.3 Degrade any standard disk should it incur eight unrecoverable-errors over the period of the next week.
set disk-parameters Description Sets parameters that affect disk operation. Two features controlled by these parameters are disk Self-Monitoring Analysis and Reporting Technology (SMART) and drive spin down. • Disks equipped with SMART technology can alert the controller of impending disk failure. When SMART is enabled, the system checks for SMART events one minute after a restart and every five minutes thereafter.
set email-parameters Description Sets SMTP notification parameters for events and managed logs. Min. role manage Syntax set email-parameters domain domain email-list email-addresses [include-logs enabled|disabled|on|off] notification-level crit|error|warn|info|none sender sender server server Parameters domain domain The domain name that is joined with an @ symbol to the sender name to form the “from” address for remote notification.
set enclosure Description Sets an enclosure’s name, location, rack number, and rack position. Set these parameters to values that help you identify and locate the enclosure. These values are used when user interfaces show enclosure-related data, such as in output of the show enclosures command and in event-log entries related to enclosures.
set expander-fault-isolation Description Temporarily disables PHY fault isolation for a specific Expander Controller. For use by or with direction from technical support. By default, the Expander Controller in each I/O module performs fault-isolation analysis of SAS expander PHY statistics. When one or more error counters for a specific PHY exceed the built-in thresholds, the PHY is disabled to maintain storage system operation.
set expander-phy Description Disables or enables a specific PHY. For use by or with direction from technical support. Min. role manage Syntax set expander-phy controller a|b|both enabled|disabled|on|off [encl enclosure-ID] phy phy-ID type drive|inter-exp|sc|sc-0|sc-1|sca-p|scb-p|sca-a|scb-a|ingress |expander-ingress-0|expander-ingress-1|egress|expander-egress-0 |expander-egress-1|drawer0-egress|drawer1-egress|drawer2-egress |drawer0-ingress|drawer1-ingress|drawer2-ingress [wwn enclosure-WWN] Parameters controller a|b|both The I/O module containing the PHY to enable or disable: A, B, or both.
wwn enclosure-WWN Optional. The WWN of the enclosure containing the PHY. Specify either this parameter or the encl parameter. Example Disable the first egress PHY in controller A. # set expander-phy encl 0 controller a type egress phy 0 disabled Enable the PHY for disk 5 in controller B.
set initiator Description Sets the name of an initiator. Min. role manage Syntax set initiator [id initiator] [nickname name] Parameters id initiator The ID of the initiator. For SAS the ID is a WWPN. A WWPN can include a colon between each byte but the colons will be discarded.
set led Description Changes the state of the identification LED on a specified device. LEDs are described in the Setup Guide. Min. role manage Syntax To set a disk LED: set led disk ID enable|disable|on|off To set the LEDs for an enclosure and its I/O modules: set led [controller a|b] enable|disable|on|off...
Page 107
Identify drawer 1 in enclosure 1. # set led drawer 1.1 on Identify fan 1 in enclosure 1. # set led fan 1.1 on set led 107...
set network-parameters Description Sets parameters for controller module network ports. You can manually set static IP values for each controller, or you can specify that IP values should be set automatically for both controllers through communication with a Dynamic Host Configuration Protocol (DHCP) server.
Page 109
netmask netmask Optional. An IP subnet mask for the port. ping-broadcast enabled|disabled|on|off Optional. Enables the storage system to respond when a ping to a broadcast address is issued on the system’s subnet. The default is Disabled. Example Use DHCP to set network port IP values. # set network-parameters dhcp See also •...
set ntp-parameters Description Sets Network Time Protocol (NTP) parameters for the system. You can manually set system date and time parameters by using the set controller-date command. You must specify at least one of the optional parameters for the command to succeed. Min.
set password Description Sets a user’s password for system interfaces (such as the CLI). A password can be entered as part of the command, or the command prompts you to enter and re-enter the new password. Min. role manage Syntax set password [password password] [user]...
set prompt Description Sets the prompt for the current CLI session. This setting does not persist beyond the current session. Min. role manage Syntax set prompt prompt Parameters prompt The new prompt. Input rules: • The value is case sensitive. •...
set protocols Description Enables or disables management services and protocols. In console format, if you enable an unsecured protocol the command will prompt for confirmation. Min. role manage Syntax set protocols [activity enabled|disabled|on|off] [debug enabled|disabled|on|off] [ftp enabled|disabled|on|off] [http enabled|disabled|on|off] [https enabled|disabled|on|off] [ses enabled|disabled|on|off] [smis enabled|disabled|on|off] [snmp enabled|disabled|on|off]...
Page 114
See also • set cli-parameters • show protocols 114 Alphabetical list of commands...
set schedule Description Changes parameters for a specified schedule. If you want to change the schedule name, create a new schedule to replace the existing one. You must specify at least one of the optional parameters for the command to succeed. Min.
set snmp-parameters Description Sets SNMP parameters for event notification. To enable or disable SNMP requests to the MIB use the set protocols command. Min. role manage Syntax set snmp-parameters [add-trap-host address] [del-trap-host address] [enable crit|error|warn|info|none] [read-community string] [trap-host-list trap-host-list] [write-community string] Parameters add-trap-host address Optional.
set spares (Deprecated) add spares remove spares. set syslog-parameters Description Sets remote syslog notification parameters for events and managed logs. This allows events to be logged by the syslog of a specified host computer. Syslog is a protocol for sending event messages across an IP network to a logging server.
set system Description Sets the system’s name, contact person, location, and description. The name, location, and contact are included in event messages. All four values are included in system debug logs for reference by service personnel. When using the WBI, the system name appears in the browser title bar or tab. Input rules for each value: •...
set user Description Changes user preferences for the session or permanently. The system requires at least one CLI user with the manage role to exist. A user with the manage role can change any parameter except name. A user with the monitor role can change any parameter for that user except name, roles, and interfaces.
Page 120
interfaces interfaces Optional. Specifies the interfaces that the user can access. Multiple values must be separated by commas and no spaces. A command that specifies snmpuser or snmptarget cannot also specify a non-SNMP interface. • cli: Command-line interface. This is enabled by default. •...
Page 121
session-preferences Optional. Specifies that the current CLI settings will become permanent settings for the user. This parameter cannot be combined with any other parameter. storage-size-base 2|10 Optional. Alias for base. storage-size-precision # Optional. Alias for precision. storage-size-units auto|MB|GB|TB Optional. Alias for units. temperature-scale celsius|c|fahrenheit|f Optional.
set vdisk Description Changes parameters for a specified vdisk. This command applies to linear storage only. Min. role manage Syntax set vdisk [name new-name] [owner a|b] [spin-down-delay delay] vdisk Parameters name new-name Optional. A new name for the vdisk. A name that includes a space must be enclosed in double quotes.
set volume Description Changes parameters for a volume. Syntax set volume [access read-write|rw|read-only|ro] [identifying-information description] [name new-name] volume Parameters access read-write|rw|read-only|ro Deprecated—to change mapping settings, use the map volume command. identifying-information description Optional. A description of the volume to help a host-side user identify it. Input rules: The value is case sensitive.
show advanced-settings Description Shows the settings for advanced system-configuration parameters. Min. role monitor Syntax show advanced-settings Output Vdisk Background Scrub Shows whether disks in vdisks are automatically checked for disk defects to ensure system health. The interval between a scrub finishing and starting again is specified by the Vdisk Background Scrub Interval field.
Page 125
Host Control of Caching Shows whether hosts are allowed to use the SCSI MODE SELECT command to change the storage system's write-back cache setting. • Disabled: Host control of caching is disabled. This is the default. • Enabled: Host control of caching is enabled. Sync Cache Mode Shows how the SCSI SYNCHRONIZE CACHE command is handled: •...
Page 126
Fan Failure Shows whether the cache policy will change from write-back to write-through when a fan fails. • Disabled: The fan failure trigger is disabled. This is the default. • Enabled: The fan failure trigger is enabled. Temperature Exceeded Shows whether the system will shut down a controller when its temperature exceeds the critical operating range.
Auto Stall Recovery Shows whether the auto-stall recovery feature is enabled, which detects situations where a controller stall is preventing I/O operations from completing, and recovers the system so that at least one controller is operational, thus avoiding data-unavailability situations. This feature focuses on Active-Active I/O stalls and failover/recovery stalls.
show cache-parameters Description Shows cache settings and status for the system and optionally for a volume. Min. role monitor Syntax show cache-parameters [volume] Parameters volume Optional. Name or serial number of the volume for which to show settings. A name that includes a space must be enclosed in double quotes.
Page 129
Cache Flush • Enabled: If the controller loses power, it will automatically write cache data to the CompactFlash card. Cache flush is normally enabled, but is temporarily disabled during controller shut down. • Disabled: Cache flush is disabled. Volume cache parameters: Serial Number If a volume is specified, its serial number.
show certificate Description Shows the status of the system’s security certificate. Min. role manage Syntax show certificate [a|b|both] Parameters a|b|both Optional. Specifies whether to show information for controller A, B, or both. If this parameter is omitted, information is shown for both controllers. Output Certificate Status •...
show cli-parameters Description Shows the current CLI session preferences. Min. role monitor Syntax show cli-parameters Output Timeout The time in seconds that the session can be idle before it automatically ends. Valid values are 120–43200 seconds (2–720 minutes). The default is 1800 seconds (30 minutes). Output Format •...
Page 132
Temperature Scale • Fahrenheit: Temperatures are shown in degrees Fahrenheit. • Celsius: Temperatures are shown in degrees Celsius. This is the default. Management Mode Not applicable Example Show current CLI settings. # show cli-parameters Basetypes • cli-parameters • status See also • set cli-parameters •...
show configuration Description Shows system configuration information. NOTE: Output for this command is lengthy. To control whether the output halts after each full screen to wait for keyboard input, enable or disable the pager parameter of the set cli-parameters command. Min.
show controller-date Description Shows the system’s current date and time. Min. role monitor Syntax show controller-date Output Controller Date Date and time in the format year-month-day hour:minutes:seconds. Time-Zone Offset The system’s time zone as an offset in hours and minutes from Coordinated Universal Time (UTC). This is shown only if NTP is enabled.
show controllers Description Shows information about each controller module in the storage system. Min. role monitor Syntax show controllers Output Controller ID • A: Controller A. • B: Controller B. Serial Number • Serial number of the controller module. • Not Available: The controller module is down or not installed. Hardware Version Controller module hardware version.
Page 136
Failed Over to This Controller Indicates whether the partner controller has failed over to this controller: • No: The partner controller has not failed over to this controller. • Yes: The partner controller has either failed or been shut down, and its responsibilities have been taken over by this controller.
Page 137
Controller Redundancy Status • Redundant with independent cache: Both controllers are operational but are not mirroring their cache metadata to each other. • Redundant: Both controllers are operational. • Operational but not redundant: In active-active mode, one controller is operational and the other is offline.
show controller-statistics Description Shows live performance statistics for controller modules. For controller performance statistics, the system samples live data every 15 seconds. Statistics shown only in XML API output are described in "XML API basetype properties" (page 221). Min. role monitor Syntax show controller-statistics...
Page 139
See also • reset all-statistics • reset controller-statistics show controller-statistics 139...
show debug-log-parameters Description Shows which debug message types are enabled (On) or disabled (Off) for inclusion in the Storage Controller debug log. For use by or with direction from technical support. Min. role monitor Syntax show debug-log-parameters Output • host: Host interface debug messages. Enabled by default. •...
show degraded-disk-policy Description Shows the policy settings to enact when the system determines that a disk is degraded. Min. role monitor Syntax show degraded-disk-policy Output Disk Error Notification • Informational: Generate an event with Informational severity. • Warning: Generate an event with Warning severity. •...
show degraded-disk-thresholds Description Shows the configured criteria for the system to identify degraded disks. If no parameter is specified, the command shows information for all degraded disks. Min. role monitor Syntax show degraded-disk-thresholds [name threshold-name] Parameters name threshold-name Optional. Specifies one of the following values (which identifies the disk tier and RAID redundancy level) for which to show information: •...
Page 143
ThresholdLifetime Configured criteria for how many errors of the target type must occur for a disk to be considered degraded. • threshold-value: A numeric value for the threshold count. • --: Threshold is not set. Example Show information for all threshold names. # show degraded-disk-thresholds Show information for threshold name archive-single only.
show disk-parameters Description Shows disk settings. Min. role monitor Syntax show disk-parameters Output SMART Shows whether SMART (Self-Monitoring Analysis and Reporting Technology) is enabled or disabled for disks. • Detect-Only: Each disk in the system retains its individual SMART setting, as will new disks added to the system.
show disks Description Shows information about all disks or disk slots in the storage system. If no parameter is specified, the command shows information for all installed disks. NOTE: In console format, to aid reading, disks are sorted to display in order by enclosure and disk number.
Page 146
Description Shown by default or by the detail or perf parameter. • SAS: Enterprise SAS • SAS MDL: Midline SAS • sSAS: SAS SSD Drive Spin Down Count Shown by the detail parameter. The number of times the DSD feature has spun down this disk. Encl Shown by the encl parameter.
Page 147
Power On Hours Shown by the detail parameter. The total number of hours that the disk has been powered on since it was manufactured. This value is stored in disk metadata and is updated in 30-minute increments. Reason Shown by default or by the detail or perf parameter. If Health is not OK, this field shows the reason for the health state.
Page 148
Status Shown by the encl parameter. • Up: The disk is present and is properly communicating with the expander. • Spun Down: The disk is present and has been spun down by the drive spin down feature. • Warning: The disk is present but the system is having communication problems with the disk LED processor.
Page 149
Show disk-slot information. # show disks encl Show disk performance statistics. # show disks perf Show disk temperature information. # show disks temp Show detailed information for disk 1.1: # show disks 1.1 detail Basetypes • drives • enclosure-list • status See also •...
show disk-statistics Description Shows live or historical performance statistics for disks. For disk performance statistics, the system samples live data every 15 seconds and historical data every quarter hour, and retains historical data for 6 months. The historical option allows you to specify a time range or a number (count) of data samples to include.
Page 151
Bytes per second The data transfer rate calculated over the interval since these statistics were last requested or reset. This value will be zero if it has not been requested or reset since a controller restart. IOPS The number of input/output operations per second, calculated over the interval since these statistics were last requested or reset.
Page 152
Read B/s Shown by the all parameter. The data transfer rate, in bytes per second, for read operations since the last sampling time. Write B/s Shown by the all parameter. Data transfer rate, in bytes per second, for write operations since the last sampling time.
Page 153
See also • reset all-statistics • reset disk-error-statistics • reset disk-statistics • show disks show disk-statistics 153...
show email-parameters Description Shows email (SMTP) notification parameters for events and managed logs. Min. role monitor Syntax show email-parameters Output Email Notification • Disabled: Email notification is disabled. This is the default. • Enabled: Email notification is enabled. Email Notify Filter Shows the minimum severity for which the system should send event notifications: •...
show enclosures Description Shows information about the enclosures in the storage system. Full detail available in XML API output only. Min. role monitor Syntax show enclosures Output Encl The enclosure ID. Encl WWN The enclosure WWN. Name The enclosure name. Location The enclosure location, or blank if not set.
Page 156
EMP controller-ID CH:ID Rev The channel ID and firmware revision of the drawer's Enclosure Management Processor for controller module A's Expander Controller. Status Status of the drawer. • Up • Warning • Error • Unknown • Unavailable • Not Present Health •...
show events Description Shows events logged by each controller in the storage system. A separate set of event numbers is maintained for each controller. Each event number is prefixed with a letter identifying the controller that logged the event. Events are listed from newest to oldest, based on a timestamp with one-second granularity. Therefore the event log sequence matches the actual event sequence within about one second.
Page 158
to timestamp Optional. Shows events that occurred on or before a timestamp specified with the format MMDDYYhhmmss. For example, 04301 1235900 represents April 30 201 1 at 1 1:59:00 p.m. This parameter can be used with the from parameter or the from-event parameter. to-event event-ID Optional.
show expander-status Description Shows diagnostic information relating to SAS Expander Controller physical channels, known as PHY lanes. For use by or with direction from technical support. For each enclosure, this command shows status information for PHYs in I/O module A and then I/O module B.
Page 160
Elem Status A standard SES status for the element: • Disabled: Critical condition is detected. • Error: Unrecoverable condition is detected. Appears only if there is a firmware problem related to PHY definition data. • Non-critical: Non-critical condition is detected. •...
show fans Description Shows information about each fan in the storage system. Min. role monitor Syntax show fans Output Name The fan name in the form Fan loc:position-PSU power-supply-ID. The position is as viewed from the back of the enclosure. Location The fan location in the form Enclosure enclosure-ID - position.
Page 162
See also • show power-supplies 162 Alphabetical list of commands...
show frus Description Shows FRU (field-replaceable unit) information for the storage system. Some information is for use by service technicians. Min. role monitor Syntax show frus Output FRU fields: Name • CHASSIS_MIDPLANE: Chassis and midplane circuit board • RAID_IOM: Controller module •...
FRU Location The location of the FRU in the enclosure: • MID-PLANE SLOT: Chassis midplane • UPPER IOM SLOT: Controller module or expansion module A • LOWER IOM SLOT: Controller module or expansion module B • LEFT IOM SLOT: Controller module or expansion module B, in the left slot as viewed from the back.
show host-phy-statistics Description Shows diagnostic information relating to SAS controller physical channels, known as PHY lanes, for each host port. This command shows PHY status information for each host port found in an enclosure. Each controller in an enclosure may have multiple host ports. A host port may have multiply PHYs. For each PHY, this command shows statistical information in the form of numerical values.
show host-port-statistics Description Shows live performance statistics for each controller host port. For each host port these statistics quantify I/O operations through the port between a host and a volume. For example, each time a host writes to a volume’s cache, the host port’s statistics are adjusted. For host-port performance statistics, the system samples live data every 15 seconds.
Show live performance statistics for host port A1. # show host-port-statistics ports a1 Basetypes • host-port-statistics • status See also • reset all-statistics • reset host-port-statistics • show ports show hosts (Deprecated) show initiators. show hosts (Deprecated) 167...
show initiators Description Shows information about initiators. The command will show information about all initiators by default, or you can use parameters to filter the output. Initiator entries are automatically created for host initiators that have sent an inquiry command or a report luns command to the system.
show inquiry Description Shows inquiry data for each controller module. Min. role monitor Syntax show inquiry Output • Product vendor name, product ID, and vendor ID • Management Controller firmware version and loader version • Storage Controller firmware version and loader version •...
show maps Description Shows information about mappings between volumes and initiators. If no parameter is specified, this command shows explicit mappings (but not default mappings) for all volumes. In a dual-controller system, if a mapping uses corresponding ports on both controllers, such as A1 and B1, the Ports field will simply show 1.
Page 171
Ports • The controller host ports to which the mapping applies. • Blank if not mapped or mapped as no-access. Serial Number The serial number of the volume. Example Show mappings for all volumes. # show maps Show mapping information for all initiators. # show maps initiator Basetypes •...
show network-parameters Description Shows the settings and health of each controller module’s network port. Min. role monitor Syntax show network-parameters Output IP Address The network port IP address. Gateway The network port gateway IP address. Subnet Mask The network port IP subnet mask. MAC Address The controller’s unique Media Access Control address.
show ntp-status Description Shows the status of the use of Network Time Protocol (NTP) in the system. Min. role monitor Syntax show ntp-status Output NTP Status • activated: NTP is enabled. • deactivated: NTP is disabled. NTP Server Address • The current NTP server IP address if NTP is enabled. •...
show ports Description Shows information about host ports in both controllers. Min. role monitor Syntax show ports [detail] Parameters detail Optional. This parameter shows additional detail about the port status. Output Ports Controller ID and port number Media • SAS: Serial Attached SCSI Target ID Port WWN Status...
Page 175
Example Show information about host ports in each controller module. # show ports Show detailed information about host ports in each controller module. # show ports detail Basetypes • port • status show ports 175...
show power-supplies Description Shows information about each power supply in the storage system. Min. role monitor Syntax show power-supplies Output Encl The ID of the enclosure that contains the power supply. Serial Number The serial number of the power supply. Name The power supply identifier and location.
show protocols Description Shows which management services and protocols are enabled or disabled. Min. role monitor Syntax show protocols Output Web Browser Interface (HTTP) Shows whether the standard WBI web server is enabled or disabled. The default is Disabled. Secure Web Browser Interface (HTTPS) Shows whether the secure WBI web server is enabled or disabled.
show provisioning Description Shows information about how the system is provisioned. This command shows the associations between controllers, disks, vdisks or pools, volumes, and mappings. The command will show information for all associations by default, or you can use parameters to filter the output. This command is useful for the following purposes: •...
Page 179
Output Volume information: Volume • Volume name. • Blank if the vdisk or pool does not have a volume. • Volume World Wide Name. • Blank if the vdisk or pool does not have a volume. Ctlr Owning controller of the vdisk or pool. Disks Shorthand list of the disks within a vdisk or pool.
Page 180
Example Show provisioning for the system. # show provisioning Show provisioning for vdisk myR1. # show provisioning vdisks myR1 Show provisioning for all unhealthy vdisks. # show provisioning unhealthy Basetypes • provisioning • status See also • show disks • show maps •...
show redundancy-mode Description Shows the redundancy status of the system. Min. role monitor Syntax show redundancy-mode Output Controller Redundancy Mode Shows the system’s operating mode, also called the cache redundancy mode: • Independent Cache Performance Mode: For a dual-controller system, controller failover is disabled and data in a controller’s write-back cache is not mirrored to the partner controller.
show refresh-counters Description In XML API format only, shows when the data represented by the basetype was last updated. The value 0 means the data has never been updated and is not cached. A value other than 0 is a timestamp indicating that the data has been updated.
show sas-link-health Description Shows the condition of SAS expansion-port connections. Min. role monitor Syntax show sas-link-health Output Encl The enclosure ID. Ctlr The ID of the controller module or expansion module. Name • Out Port: Egress (expansion) port in a controller module or an expansion module. Can be connected to an ingress port in an expansion module.
show schedules Description Shows information about all task schedules. Syntax show schedules [schedule-name] schedule-name Optional. Shows information about the specified schedule only. A name that includes a space must be enclosed in double quotes. If this parameter is omitted, information is shown for all schedules. Output Schedule Name The schedule name.
show sensor-status Description Shows the status of each environmental sensor in each enclosure. Information shown only for a controller enclosure: on-board temperature, disk controller temperature, memory controller temperature, supercapacitor voltage and charge, overall unit (enclosure) status. Information shown for all enclosures: temperature, voltage, and current for each IOM (controller module or expansion module);...
show shutdown-status Description Shows whether each Storage Controller is active or shut down. Min. role monitor Syntax show shutdown-status Output Controller A • up (active) • down (shut down or killed) • not installed Controller B • up (active) • down (shut down or killed) •...
show snmp-parameters Description Shows SNMP settings for event notification. Min. role monitor Syntax show snmp-parameters Output SNMP Trap Notification Level • crit: Only Critical events are sent as traps. • error: Error and Critical events are sent as traps. • warn: Warning, Error, and Critical events are sent as traps. •...
show syslog-parameters Description Shows syslog notification parameters for events and managed logs. Min. role monitor Syntax show syslog-parameters Output Syslog Host IP The IP address of the remote syslog server to use for the notifications. Syslog Notification Level Shows the minimum severity for which the system sends notifications: •...
show system Description Shows information about the storage system. If the system’s health is not OK, each unhealthy component is listed with information to help you resolve the health problem. Min. role monitor Syntax show system [detail] Parameters detail Optional. Shows the SCSI Vendor ID and SCSI Product ID fields on a system where they are hidden by default.
Page 190
Other MC Status The operational status of the Management Controller in the partner controller. This is not factored into system health. • Operational • Not Operational • Not Communicating • Unknown PFU Status Shows whether partner firmware update is running on the system, or is idle. Supported Locales Supported display languages: English, Spanish, French, German, Italian, Japanese, Dutch, Chinese-Simplified, Chinese-Traditional, Korean.
show system-parameters Description Shows certain storage-system settings and configuration limits. For a summary of the physical and logical limits of the storage system, see the system configuration limits topic in the WBI help. Min. role monitor Syntax show system-parameters Output ULP Enabled Shows that the system is using Unified LUN Presentation, which can expose all LUNs through all host ports on both controllers.
show tasks Description Shows information about tasks. Syntax show tasks [task-name] task-name Optional. Shows information about the specified task only. If this parameter is omitted, information is shown for all tasks. Output For an EnableDSD task: Task Name The name of the task. Task Type EnableDSD Status...
Page 193
Example Show information about all tasks. # show tasks Show information about task Task1. # show tasks Task1 Basetypes • tasks • status See also • create schedule • create task • delete task • show schedules show tasks 193...
show unwritable-cache Description Shows the percentage of unwritable data in the system. This data has not been written to disk because it is associated with a volume that no longer exists or whose disks are not online. If the data is needed, the volume’s disks must be brought online.
show users Description Shows configured user accounts. Min. role monitor Syntax show users [show-snmp-password] [user] Parameters show-snmp-password Optional. Minimum role: manage. For SNMPv3 users, this parameter shows Password and Privacy Password values in clear text for reference when configuring users in the corresponding management application.
Page 196
Privacy Type • DES: Data Encryption Standard. • AES: Advanced Encryption Standard. • none: No encryption. This is the default. Password The user password. For a standard user the password is represented by eight asterisks. For an SNMPv3 user this is the authentication password. Privacy Password The encryption password for an SNMPv3 user whose privacy type is set to DES or AES.
show vdisks Description Shows information about all or specified vdisks. Min. role monitor Syntax show vdisks [vdisks] Parameters vdisks Optional. A comma-separated list of the names or serial numbers of the vdisks to show information about. A name that includes a space must be enclosed in double quotes. Output Name The vdisk name.
Page 198
Status • CRIT: Critical. The vdisk is online but isn't fault tolerant because some of its disks are down. • DMGD: Damaged. The disk group is online and fault tolerant, but some of its disks are damaged. • FTDN: Fault tolerant with a down disk. The vdisk is online and fault tolerant, but some of its disks are down.
Page 199
Health • OK • Degraded • Fault • N/A • Unknown Reason If Health is not OK, this field shows the reason for the health state. Action If Health is not OK, this field shows recommended actions to take to resolve the health issue. Example Show information about all vdisks.
show vdisk-statistics Description Shows live or historical performance statistics for vdisks. This command applies to linear storage only. You can view live statistics for all or specified vdisks, or historical statistics for a specified vdisk. The system samples disk-performance statistics every quarter hour and retains performance data for 6 months.
Page 201
historical Optional. Specifies to show historical statistics. If this parameter is omitted, live statistics will be shown. time-range "date/time-range" Optional. Specifies the date/time range of historical statistics to show, in the format "start yyyy-mm-dd hh:mm [AM|PM] end yyyy-mm-dd hh:mm [AM|PM]". If the start date/time is specified but no end date/time is specified, the current date/time will be used as the end date/time.
Page 202
Reset Time The date and time, in the format year-month-day hour:minutes:seconds, when these statistics were last reset, either by a user or by a controller restart. Output Historical Name The vdisk name. Serial Number The vdisk serial number. Data Transferred The total amount of data read and written since the last sampling time.
Page 203
Basetypes • vdisk-statistics (live) • virtual-disk-summary (historical) • vdisk-hist-statistics (historical) • status See also • reset all-statistics • reset vdisk-statistics • show vdisks show vdisk-statistics 203...
show versions Description Shows firmware and hardware version information for each controller module. Min. role monitor Syntax show versions [detail] Parameters detail Optional. Shows information about the versions of firmware and hardware in each controller module. If this parameter is omitted, only firmware-bundle information is shown. Example Show firmware-bundle version information for the system.
show volume-names Description Shows volume names and serial numbers. Min. role monitor Syntax show volume-names [volumes] Parameters volumes Optional. A comma-separated list of the names or serial numbers of the volumes for which to show information. A name that includes a space must be enclosed in double quotes. If this parameter is omitted, information is shown for all volumes.
show volume-reservations Description Shows persistent reservations for all or specified volumes. The persistent group reservations (PGR) mechanism enables application clients on multiple hosts to control access to a storage volume, and limits access by other hosts. Each host must be registered with the storage system in order to establish a persistent reservation for a volume, thereby becoming a reservation holder.
Page 207
Basetypes • volume-reservations • status See also • release volume • show volumes show volume-reservations 207...
show volumes Description Shows information about volumes. The command will show information for all volumes by default, or you can use parameters to filter the output. Min. role monitor Syntax show volumes [details] [type all|standard] [vdisk vdisks] [volumes] Parameters details Optional.
Page 209
Name The name of the volume. Read Ahead Shown by the details parameter. The read-ahead cache setting: • Disabled: Read-ahead is disabled. • Adaptive: Adaptive read-ahead is enabled, which allows the controller to dynamically calculate the optimum read-ahead size for the current workload. •...
show volume-statistics Description Shows live performance statistics for all or specified volumes. For each volume these statistics quantify I/O operations between hosts and the volume. For example, each time a host writes to a volume’s cache, the volume’s statistics are adjusted. For volume performance statistics, the system samples live data every 15 seconds.
shutdown Description Shuts down the Storage Controller in a controller module. This ensures that a proper failover sequence is used, which includes stopping all I/O operations and writing any data in write cache to disk. If the Storage Controller in each controller module is shut down, hosts cannot access the system’s data.
start drawer Description Restarts a drawer that was stopped. Restarting a drawer can take several minutes to complete. A stopped drawer's health is N/A and its status is Unavailable. When a drawer is successfully restarted, the health will change to OK and the status to Up, and event 526 will be logged. Use the "show enclosures"...
stop drawer Description Stops a drawer to prepare the drawer for removal. When a drawer is successfully stopped, the drawer's health changes to N/A, its status changes to Unavailable, and event 525 is logged. Use the "show enclosures" command and the event log to determine when a drawer has been stopped.
test Description Sends a test message to configured destinations for event notification and managed logs. After issuing this command, verify that the test message reached its destinations. Min. role manage Syntax test email|managedlogs|managedlogswarn|managedlogswrap|notification|snmp [region crash1|crash2|crash3|crash4|ecdebug|mc|scdebug] Parameters email|managedlogs|managedlogswarn|managedlogswrap|notification|snmp • email: This option behaves the same as the notification option and remains for backward compatibility only.
trust Description Enables an offline or non-fault-tolerant vdisk (or disk group) to be brought online for emergency data recovery. This command must be enabled before each use. If used improperly this command can cause unstable operation and data loss. Before use, carefully read the cautions and procedures below.
Page 216
5. Unseat the spare disks associated with the vdisk to prevent reconstruction.* 6. Reseat the remaining affected disks. 7. Enable the trust command. 8. Run the trust command on the vdisk. *It is recommended to avoid reconstruction after using the trust command. Reconstruction causes heavy usage of disks that were already reporting errors.
Page 217
State • AVAIL: Available • FAILED: The disk is unusable and must be replaced. Reasons for this status include: excessive media errors, SMART error, disk hardware failure, or unsupported disk. • GLOBAL SP: Global spare • LEFTOVR: Leftover • VDISK: Used in a vdisk •...
unfail controller Description Allows the partner controller module to recover from a simulated failure performed with the fail command (which requires the manage role). If you attempt to unfail a controller that is operating, the command will have no effect. Min.
unmap volume Description Deletes explicit mappings or the default mapping for specified volumes. When an explicit mapping between an initiator and a volume is deleted, access by that initiator to the volume is controlled by the volume’s default mapping (described in help for create volume).
verify vdisk Description Analyzes redundant vdisks to find and fix inconsistencies between their redundancy data and their user data. This command acts on disks that are associated with a vdisk and are neither dedicated spares nor leftovers. This command will fix parity mismatches for RAID 3, 5, 6, and 50, and mirror mismatches for RAID 1 and 10.
XML API basetype properties Chapter 3 describes command output that is shown in console format. This chapter describes the basetype properties that CLI commands display in XML API format, and is organized to help you find a basetype by name. This chapter excludes basetypes that are for internal use only. Each basetype topic includes the following information: •...
advanced-settings-table This basetype is used by show advanced-settings. Table 8 advanced-settings-table properties Name Type Description Shows whether disks in disk groups are automatically checked for disk defects to background- string ensure system health. The interval between a scrub finishing and starting again scrub is specified by the background-scrub-interval parameter.
Page 223
Table 8 advanced-settings-table properties (continued) Name Type Description Shows whether the storage system will automatically use a compatible disk as a dynamic-spares string spare to replace a failed disk in a vdisk if no compatible spare is available. • Disabled: The dynamic spares feature is disabled. This is the default. •...
Page 224
Table 8 advanced-settings-table properties (continued) Name Type Description Numeric equivalents for controller-failure values. controller- uint32 failure-numeric • 0: Disabled • 1: Enabled Shows whether the cache policy will change from write-back to write-through super-cap- string when the supercapacitor that provides backup power for cache is not fully failure charged or fails.
Page 225
Table 8 advanced-settings-table properties (continued) Name Type Description Numeric equivalents for partner-notify values. partner-notify- uint32 numeric • 0: Disabled • 1: Enabled Shows whether the cache policy will change from write-through to write-back auto-write-back string when the trigger condition is cleared. •...
Page 226
Table 8 advanced-settings-table properties (continued) Name Type Description Numeric equivalents for single-controller values. single- string controller- • 0: Disabled numeric • 1: Enabled Not supported. disk- string protection-info Not supported. disk- uint32 protection- info-numeric Shows whether the auto-stall recovery feature is enabled, which detects auto-stall- string situations where a controller stall is preventing I/O operations from completing,...
cache-parameter This basetype is used by show cache-parameters, when a volume is specified, to show volume cache properties. Table 9 cache-parameter properties Name Type Description If a volume is specified, its serial number. serial-number string If a volume is specified, its name. volume-name string If a volume is specified, its cache write policy.
cache-settings This basetype is used by show cache-parameters to show system cache properties. Table 10 cache-settings properties Name Type Description The system’s operating mode, also called the cache redundancy mode. operation-mode string Independent Cache Performance Mode: For a dual-controller system, •...
certificate-status This basetype is used by show certificate. Table 1 1 certificate-status properties Name Type Description • A: Controller A. controller string • B: Controller B. Numeric equivalents for controller values. controller- string numeric • 0: A • 1: B •...
cli-parameters This basetype is used by show cli-parameters. Table 12 cli-parameters properties Name Type Description Time in seconds that the session can be idle before it automatically ends. Valid timeout uint32 values are 120–43200 seconds (2–720 minutes). The default is 1800 seconds (30 minutes).
Page 232
Table 12 cli-parameters properties (continued) Name Type Description Display language. locale string • English (the default) • Spanish • French • German • Italian • Japanese • Korean • Dutch • Chinese-simplified • Chinese-traditional Numeric equivalents for locale values. locale-numeric uint32 •...
Page 233
Table 12 cli-parameters properties (continued) Name Type Description Numeric equivalents for temperature-scale values. temperature- uint32 scale-numeric • 0: Fahrenheit • 1: Celsius The logged-in user's experience level. user-type string • Novice • Standard (the default) • Advanced • Diagnostic Numeric equivalents for user-type values. user-type- uint32 numeric...
code-load-readiness This basetype is used by check firmware-upgrade-health. Table 13 code-load-readiness properties Name Type Description • Pass: There are no risks to performing firmware upgrade. overall-health string • Fail: At least one condition exists that presents a risk of upgrade failure or loss of availability.
code-load-readiness-reasons This basetype is used by check firmware-upgrade-health. Table 14 code-load-readiness-reasons properties Name Type Description The condition that was detected. readiness- string reason Numeric equivalents for readiness-reason values. readiness- string reason-numeric The problems that are likely to result if you do not resolve the conditions before failure-risks string performing a firmware upgrade.
compact-flash This basetype is used by show controllers. Table 15 compact-flash properties Name Type Description • Ctlr A CF: CompactFlash card in controller A. durable-id string • Ctlr B CF: CompactFlash card in controller B. • A: Controller A. controller-id string •...
controller-cache-parameters This basetype is used by show cache-parameters to show controller cache properties. Table 16 controller-cache-parameters properties Name Type Description • cache-params-a: Cache parameters for controller A. durable-id string • cache-params-b: Cache parameters for controller B. • A: Controller A. controller-id string •...
Page 238
Table 16 controller-cache-parameters properties (continued) Name Type Description • Enabled: If the controller loses power, it will automatically write cache data cache-flush string to the CompactFlash card. Cache flush is normally enabled, but is temporarily disabled during controller shut down. •...
controllers This basetype is used by show configuration show controllers. Table 17 controllers properties Name Type Description • durable-id string controller a • controller b • A: Controller A. controller-id string • B: Controller B. • controller-id- uint32 0: B •...
Page 240
Table 17 controllers properties (continued) Name Type Description Indicates whether the partner controller has failed over to this controller. failed-over string • No: The partner controller has not failed over to this controller. • Yes: The partner controller has either failed or been shut down, and its responsibilities have been taken over by this controller.
Page 241
Table 17 controllers properties (continued) Name Type Description FRU template revision number. dash-level string FRU short description. fru-shortname string Date and time, in the format year-month-day hour:minutes:seconds mfg-date string (UTC), when the controller's PCBA was programmed. Unformatted mfg-date value. mfg-date- uint32 numeric City, state/province, and country where the FRU was manufactured.
Page 242
Table 17 controllers properties (continued) Name Type Description Numeric equivalents for phy-isolation values. phy-isolation- uint32 numeric • 0: Enabled • 1: Disabled The system’s operating mode, also called the cache redundancy mode. redundancy-mode string • Independent Cache Performance Mode: For a dual-controller system, controller failover is disabled and data in a controller’s write-back cache is not mirrored to the partner controller.
controller-statistics This basetype is used by show controller-statistics. Table 18 controller-statistics properties Name Type Description • durable-id string controller a • controller b Percentage of time the CPU is busy, from 0 to 100. cpu-load uint32 Number of seconds since the controller was restarted. power-on-time uint32 Percentage of write cache in use, from 0 to 100.
Page 244
Table 18 controller-statistics properties (continued) Name Type Description Date and time, in the format year-month-day hour:minutes:seconds, start-sample- string when sampling started for the iops and bytes-per-second values. time Unformatted start-sample-time value. start-sample- uint32 time-numeric Date and time, in the format year-month-day hour:minutes:seconds, stop-sample- string when sampling stopped for the iops and bytes-per-second values.
debug-log-parameters This basetype is used by show debug-log-parameters. Table 19 debug-log-parameters properties Name Type Description Shows whether host interface debug messages are enabled for inclusion in the host-dbg string Storage Controller debug log. • Off: Disabled. • On: Enabled. Numeric equivalents for host values. host-dbg- uint32 numeric...
Page 246
Table 19 debug-log-parameters properties (continued) Name Type Description Shows whether resource-count debug messages for an I/O interface driver are string enabled for inclusion in the Storage Controller debug log. • Off: Disabled. • On: Enabled. Numeric equivalents for iob values. iob-numeric uint32 •...
Page 247
Table 19 debug-log-parameters properties (continued) Name Type Description Shows whether cache debug messages are enabled for inclusion in the Storage cache string Controller debug log. • Off: Disabled. • On: Enabled. Numeric equivalents for cache values. cache-numeric uint32 • 0: Off •...
Page 248
Table 19 debug-log-parameters properties (continued) Name Type Description Shows whether internal debug messages are enabled for inclusion in the res2 string Storage Controller debug log. • Off: Disabled. • On: Enabled. Numeric equivalents for res2 values. res2-numeric uint32 • 0: Off •...
degraded-disk-policy This basetype is used by show degraded-disk-policy. Table 20 degraded-disk-policy properties Name Type Description Shows degraded disk error information: degraded-disk- string error- Informational: Generate an event with Informational severity. • notification • Warning: Generate an event with Warning severity. •...
degraded-disk-thresholds This basetype is used by show degraded-disk-thresholds. Table 21 degraded-disk-thresholds properties Name Type Description Threshold name. degraded-disk- string name • Recoverable Errors: Soft errors (sense key 1). degraded-disk- string • Unrecoverable Errors: Medium errors (sense key 3). target Configured criteria for how many errors of the target type must occur within a degraded-disk- string certain time period for a disk to be considered degraded.
disk-hist-statistics This basetype is used by show disk-statistics when the historical parameter is specified. Table 22 disk-hist-statistics properties Name Type Description Total number of read and write operations since the last sampling time. number-of-ios uint64 Number of read operations since the last sampling time. number-of-reads uint64 Number of write operations since the last sampling time.
Page 252
Table 22 disk-hist-statistics properties (continued) Name Type Description Unformatted avg-io-size value. avg-io-size- uint64 numeric Average data size of read operations since the last sampling time. avg-read-io- uint64 size Unformatted avg-read-io-size value. avg-read-io- uint64 size-numeric Average data size of write operations since the last sampling time. avg-write-io- uint64 size...
disk-statistics This basetype is used by show disk-statistics when the historical parameter is omitted. Table 23 disk-statistics properties Name Type Description Disk ID in the form disk_enclosure-number.disk-number. durable-id string Disk serial number. serial-number string Data transfer rate calculated over the interval since these statistics were last bytes-per- uint64 requested or reset.
Page 254
Table 23 disk-statistics properties (continued) Name Type Description For port 1, the number of media errors generated by the disk, as specified by its number-of- uint32 manufacturer. media-errors-1 For port 1, the number of other errors generated by the storage system, or number-of- uint32 generated by the disk and not categorized as media errors.
drawer-sensors This basetype is used by show sensor-status. Table 24 drawer-sensors properties Name Type Description Sensor ID. For example: sensor_temp_drawer-ID.sensor-number. durable-id string • 0: Left drawer-id uint32 • 1: Middle • 2: Right Sensor name and location. sensor-name string • For a sensor, its value.
Page 256
Table 24 drawer-sensors properties (continued) Name Type Description Numeric equivalents for container values. container- uint32 numeric • 17: enclosures • 18: midplane • 19: controllers • 20: iom • 21: power-supplies • 22: fan • 31: drawer • sensor-type string Temperature •...
drawers This basetype is used by show enclosures. Table 25 drawers properties Name Type Description Drawer ID in the form drawer_number. durable-id string • 0: Left drawer-id uint8 • 1: Right Drawer WWN. drawer-wwn string Drawer part number. part-number string Drawer name.
Page 258
Table 25 drawers properties (continued) Name Type Description Drawer status: status string • • Error • Warning • Not Present • Unknown • Unavailable Numeric equivalents for status values. status-numeric uint32 • 1: Up • 2: Error • 3: Warning •...
drive-parameters This basetype is used by show disk-parameters. Table 26 drive-parameters properties Name Type Description Shows whether SMART (Self-Monitoring Analysis and Reporting Technology) is smart string enabled or disabled for disks. • Detect-Only: Each disk in the system retains its individual SMART setting, as will new disks added to the system.
drive-summary This basetype is used by show disk-statistics when the historical parameter is specified. Table 27 drive-summary properties Name Type Description Disk ID in the form disk_enclosure-number.disk-number. durable-id string Disk serial number. serial-number string Embedded; see disk-hist-statistics. disk-hist- statistics 260 XML API basetype properties...
drives This basetype is used by show configuration show disks. Table 28 drives properties Name Type Description Disk ID in the form disk_enclosure-ID.slot-number. durable-id string Enclosure ID. enclosure-id uint32 • 0: Left drawer-id uint8 • 1: Middle • 2: Right Not applicable.
Page 262
Table 28 drives properties (continued) Name Type Description • Disabled: The disk has a dual-port connection to the midplane. single-ported string Enabled: The disk has a single-port connection to the midplane. • Numeric equivalents for single-ported values. single-ported- uint32 numeric •...
Page 264
Table 28 drives properties (continued) Name Type Description Numeric code indicating why the disk is down. drive-down-code uint8 Current owner, which is either the preferred owner during normal operation or owner string the partner controller when the preferred owner is offline. •...
Page 265
Table 28 drives properties (continued) Name Type Description The state of the disk (source or destination) if it is involved in a reconstruct recon-state string operation. • From: This disk is being used as the source of a reconstruct operation. •...
Page 266
Table 28 drives properties (continued) Name Type Description Shows whether the disk is spun down by the DSD feature. spun-down uint32 • 0: Not spun down. • 1: Spun down. Total number of I/O operations (reads and writes). number-of-ios uint64 Total bytes transferred.
Page 267
Table 28 drives properties (continued) Name Type Description Numeric equivalents for health values. health-numeric uint32 • 0: OK • 1: Degraded • 2: Fault • 3: Unknown • 4: N/A If Health is not OK, the reason for the health state. health-reason string If Health is not OK, the recommended actions to take to resolve the health issue.
email-parameters This basetype is used by show email-parameters. Table 29 email-parameters properties Name Type Description Shows whether email (SMTP) notification of events is enabled. email- string notification Disabled: Email notification is disabled. • • Enabled: Email notification is enabled. Numeric equivalents for email-notification values. email- uint32 notification-...
enclosure-fru This basetype is used by show configuration show frus. Table 30 enclosure-fru properties Name Type Description FRU name. name string • CHASSIS_MIDPLANE: Chassis and midplane circuit board • RAID_IOM: Controller module • BOD_IOM: Expansion module • POWER_SUPPLY: Power supply module •...
Page 270
Table 30 enclosure-fru properties (continued) Name Type Description FRU status. fru-status string • Absent: The FRU is not present. • Fault: The FRU’s health is Degraded or Fault. • Invalid Data: The FRU ID data is invalid. The FRU’s EEPROM is improperly programmed.
enclosure-list This basetype is used by show configuration, and by show disks when the encl parameter is specified. Table 31 enclosure-list properties Name Type Description Disk slot status. status string • Up: The disk is present and is properly communicating with the expander. •...
enclosures This basetype is used by show configuration show enclosures. Table 32 enclosures properties Name Type Description Enclosure ID in the form enclosure_number. durable-id string Enclosure ID. enclosure-id uint8 Enclosure WWN. enclosure-wwn string Enclosure name. name string Internal name for the enclosure type. type string Numeric equivalents for type values.
Page 273
Table 32 enclosures properties (continued) Name Type Description FRU location. fru-location string • MID-PLANE SLOT: Chassis midplane. • (blank): Not applicable. FRU part number. part-number string Date and time, in the format year-month-day hour:minutes:seconds mfg-date string (UTC), when a PCBA was programmed or a power supply module was manufactured.
Page 274
Table 32 enclosures properties (continued) Name Type Description SCSI address and firmware revision of controller A’s EMP. emp-a-ch-id-rev string Shows the field name EMP B in console format. emp-b string SCSI address and firmware revision of controller B’s EMP. emp-b-ch-id-rev string Enclosure midplane type.
events This basetype is used by show events. Table 33 events properties Name Type Description Date and time, in the format year-month-day hour:minutes:seconds time-stamp string (UTC), when this event was detected. Unformatted time-stamp value. time-stamp- uint32 numeric Event code. For event-code descriptions, see the Event Descriptions Reference event-code string Guide.
eventsLogs This basetype is used by show events when the logs parameter is specified. Table 34 eventsLogs properties Name Type Description Event ID prefaced by A or B to identify the controller that logged the event. event-id string Date and time, in the format year-month-day hour:minutes:seconds time-stamp string (UTC), when this event was detected.
expander-ports This basetype is used by show sas-link-health. Table 35 expander-ports properties Name Type Description Expander port ID. durable-id string Enclosure ID. enclosure-id uint32 • A: Controller A. controller string • B: Controller B. Numeric equivalents for controller values. controller- uint32 numeric •...
This basetype is used by show fans show power-supplies. Table 36 fan properties Name Type Description Fan unit ID in the form fan_enclosure-ID.fan-number. durable-id string Fan unit name in the form Fan loc:position-PSU power-supply-ID. name string The position is as viewed from the back of the enclosure. Fan location in the form Enclosure enclosure-ID - position.
Page 279
Table 36 fan properties (continued) Name Type Description Numeric equivalents for status values. status-numeric uint32 • 0: Up • 1: Error • 2: Off • 3: Missing Fan speed (revolutions per minute). speed uint32 Fan position, as viewed from the back of the enclosure. position string •...
host-port-statistics This basetype is used by show host-port-statistics. Table 37 host-port-statistics properties Name Type Description Host port ID in the form hostport_controller-ID-and-port-number. durable-id string Data transfer rate calculated over the interval since these statistics were last bytes-per- uint64 requested or reset. This value will be zero if it has not been requested or reset second since a controller restart.
hosts This basetype is used by show hosts (Deprecated). Table 38 hosts properties Name Type Description SAS host port WWN. host-id string User-defined name of the host port, or blank. host-name string • Yes: The host was discovered and its entry was automatically created. host-discovered string •...
host-view This basetype is used by show host-maps (Deprecated). Table 39 host-view properties Name Type Description SAS host port WWN. string User-defined name of the host port, or blank. hba-nickname string • Standard: Default profile. host-profile string Embedded; see host-view-mappings. host-view- mapping 282 XML API basetype properties...
host-view-mappings This basetype is used by show maps when the initiator parameter is specified, and show host-maps (Deprecated). Table 40 host-view-mappings properties Name Type Description Volume name. volume-name string Volume serial number. volume-serial string LUN assigned to the mapping. string •...
initiator This basetype is used by show initiators. Table 41 initiator properties Name Type Description Initiator ID. durable-id string The nickname of the initiator, or blank. nickname string • Yes: The initiator was discovered and its entry was automatically created. discovered string •...
initiator-view This basetype is used by show maps when the initiator parameter is specified. Table 42 initiator-view properties Name Type Description • For a SAS initiator, its WWPN. string The nickname of the initiator. hba-nickname string • Standard: Default profile. host-profile string Embedded;...
io-modules This basetype is used by show enclosures for an expansion module. Table 44 io-modules properties Name Type Description Expansion module ID. durable-id string • A: Controller A. controller-id string • B: Controller B. Numeric equivalents for controller-id values. controller-id- uint32 numeric •...
Page 288
Table 44 io-modules properties (continued) Name Type Description Shows the state of the locator LED on an expansion module. locator-led string • • Numeric equivalents for the locator-led property. locator-led- uint32 numeric • 0: Off • 1: On • status string Operational •...
log-header-table This basetype is used in the log file downloaded from the system by using the WBI or FTP. Table 45 log-header-table properties Name Type Description Contact person's name, if specified in the WBI Save Logs panel. log-contact string Contact's email address, if specified in the WBI Save Logs panel. log-email string Contact's phone number, if specified in the WBI Save Logs panel.
network-parameters This basetype is used by show network-parameters. Table 46 network-parameters properties Name Type Description Controller network port ID in the form mgmtport_controller-ID. durable-id string Not applicable active-version uint32 Controller network port IP address. ip-address string Controller network port gateway IP address gateway string Controller network port IP subnet mask...
Page 291
Table 46 network-parameters properties (continued) Name Type Description • Enabled: The system will respond to a broadcast ping. ping-broadcast string Disabled: The system will not respond to a broadcast ping. • Numeric equivalents for ping-broadcast values. ping-broadcast- uint32 numeric • 0: Disabled •...
ntp-status This basetype is used by show ntp-status. Table 47 ntp-status properties Name Type Description Shows whether use of Network Time Protocol (NTP) is enabled. ntp-status string activated: NTP is enabled. • • deactivated: NTP is disabled. • The current NTP server IP address if NTP is enabled. ntp-server- string •...
port This basetype is used by show configuration show ports. Table 48 port properties Name Type Description Controller host port ID in the form hostport_controller-ID-and-port- durable-id string number. • A: Controller A. controller string • B: Controller B. Numeric equivalents for controller values. controller- uint32 numeric...
power-supplies This basetype is used by show power-supplies. Table 49 power-supplies properties Name Type Description Power supply ID in the form psu_enclosure-ID.power-supply-number. durable-id string Enclosure ID. enclosure-id uint32 Power supply serial number. serial-number string FRU long description. description string Power supply identifier and location. name string •...
Page 296
Table 49 power-supplies properties (continued) Name Type Description Power supply temperature. dctemp uint32 • health string • Degraded • Fault • • Unknown Numeric equivalents for health values. health-numeric uint32 • 0: OK • 1: Degraded • 2: Fault • 3: Unknown •...
product-info This basetype is used by show inquiry. Table 50 product-info properties Name Type Description Vendor name. vendor-name string Product model identifier. product-id string Vendor name returned by the SCSI INQUIRY command. scsi-vendor-id string product-info 297...
provisioning This basetype is used by show provisioning. Table 51 provisioning properties Name Type Description • Volume name. volume string • Blank if the vdisk or pool does not have a volume. Volume serial number. volume-serial string • Volume World Wide Name. string Blank if the vdisk or pool does not have a volume.
redundancy This basetype is used by show redundancy-mode. Table 52 redundancy properties Name Type Description The system’s operating mode, also called the cache redundancy mode. redundancy-mode string Independent Cache Performance Mode: For a dual-controller system, • controller failover is disabled and data in a controller’s write-back cache is not mirrored to the partner controller.
Page 300
Table 52 redundancy properties (continued) Name Type Description Numeric equivalents for controller-b-status values. controller-b- uint32 status-numeric • 0: Operational • 1: Down • 2: Not Installed • Controller module serial number controller-b- string • Not Available: The controller is down or not installed. serial-number The operational status of the Management Controller in the partner controller.
refresh-counters This basetype is used by show refresh-counters. Table 53 refresh-counters properties Name Type Description (Not Shows when the data represented by the base type was last updated. basetype-name shown) • 0: The data has never been updated and is not cached. •...
sas-host-phy-statistics This basetype is used by show host-phy-statistics. Table 54 sas-host-phy-statistics properties Name Type Description The controller ID and port number. port string The PHY’s logical location within a group. Logical IDs are 0–3 for host port uint32 PHYs. Each SAS host will have multiple PHYs. The number of doublewords containing running disparity errors that have been disparity- uint32...
sas-port This basetype is used by show ports show host-parameters (Deprecated) for a SAS host port. Table 55 sas-port properties Name Type Description • configured- string Direct topology Number of PHY lanes in the SAS port. width string Expected number of PHY lanes in the SAS port. sas-lanes- string expected...
sas-status-controller-a This basetype is used by show expander-status for controller A and controller B. Table 56 sas-status-controller-a properties Name Type Description Enclosure ID. enclosure-id uint32 The expander type. expander-type string Numeric equivalents for expander-type values. expander-type- string numeric • 0: Left drawer-id uint8 •...
Page 306
Table 56 sas-status-controller-a properties (continued) Name Type Description Numeric equivalents for elem-status values. elem-status- uint32 numeric • 0: Error • 1: OK • 2: Disabled • 3: Non-critical • 4: Error • 5: Not Used • 6: Unknown • 7: Unknown •...
Page 307
Table 56 sas-status-controller-a properties (continued) Name Type Description Number of times the lane between two expanders experienced a conn-crc-errors uint32 communication error. Number of times the PHY has lost doubleword synchronization and restarted the lost-dwords uint32 Link Reset sequence. Number of invalid doublewords that have been received by the PHY, not invalid-dwords uint32 including those received during Link Reset sequences.
sas-status-drawer This basetype is used by show expander-status and has the same properties as sas-status-controller-a. schedules This basetype is used by show schedules show schedule-details (Deprecated). Table 57 schedules properties Name Type Description Schedule name. name string Schedule settings for running the associated task. schedule- string specification...
security-communications-protocols This basetype is used by show protocols. Table 58 security-communications-protocols properties Name Type Description • Disabled: The standard WBI web server is disabled. wbi-http string • Enabled: The standard WBI web server is enabled. Numeric equivalents for wbi-http values. wbi-http- uint32 numeric...
Page 310
Table 58 security-communications-protocols properties (continued) Name Type Description • Disabled: The in-band SES interface is disabled. inband-ses string Enabled: The in-band SES interface is enabled. • Numeric equivalents for inband-ses values. inband-ses- uint32 numeric • 0: Disabled • 1: Enabled •...
sensors This basetype is used by show sensor-status. Table 59 sensors properties Name Type Description Sensor ID. For example: sensor_temp_ctrl_controller-ID.sensor- durable-id string number and sensor_volt_ctrl_controller-ID.sensor-number. Enclosure ID. enclosure-id uint32 Sensor name and location. sensor-name string • For a sensor, its value. value string •...
Page 312
Table 59 sensors properties (continued) Name Type Description • sensor-type string Temperature • Voltage • Current • Charge Capacity • Unknown Type Numeric equivalents for sensor-type values. sensor-type- uint32 numeric • 0: Temperature • 1: Current • 2: Voltage • 3: Charge capacity •...
show-other-mc-status This basetype is used by show shutdown-status. Table 60 show-other-mc-status properties Name Type Description other-mc string Other MC Status The operational status of the Management Controller in the partner controller. other-mc-status string This is not factored into system health. •...
shutdown-status This basetype is used by show shutdown-status. Table 61 shutdown-status properties Name Type Description • A: Controller A. controller string • B: Controller B. • up: The controller is operational. status string • down: The controller is shut down. •...
snmp-parameters This basetype is used by show snmp-parameters. Table 62 snmp-parameters properties Name Type Description Shows whether the Simple Network Management Protocol (SNMP) interface is snmp-enabled string enabled or disabled. • Disabled: SNMP is disabled. • Enabled: SNMP is enabled. Numeric equivalents for snmp-enabled values.
status This basetype is used by all commands except exit, help, and meta. (exit does not provide a response; help always prints text; meta does not use the status object.) Table 63 status properties Name Type Description • Success: The command succeeded. response-type string •...
syslog-parameters This basetype is used by show syslog-parameters. Table 64 syslog-parameters properties Name Type Description The IP address of the remote syslog server to use for the notifications. syslog-host-ip string Shows the minimum severity for which the system sends notifications: syslog- string notification-...
system This basetype is used by show configuration show system. Table 65 system properties Name Type Description The name of the storage system. The default is Uninitialized Name. system-name string The name of the person who administers the system. The default is system-contact string Uninitialized Contact.
Page 319
Table 65 system properties (continued) Name Type Description Storage system node World Wide Name (WWNN). current-node- string Not applicable. fde-security- string status Not applicable. fde-security- uint32 status-numeric Platform type. platform-type string Numeric equivalent for the platform-type value. platform-type- uint32 numeric Platform brand.
system-parameters-table This basetype is used by show system-parameters. Table 66 system-parameters-table properties Name Type Description Shows true to indicate that the system is using Unified LUN Presentation, which ulp-enabled string can expose all LUNs through all host ports on both controllers. The interconnect information is managed in the controller firmware.
Page 321
Table 66 system-parameters-table properties (continued) Name Type Description The maximum number of volume groups that each controller supports. max-volume- uint32 groups-per- controller The maximum number of volumes that a volume group can contain. max-volumes- uint32 per-volume- group Not applicable. max- uint32 replication- sets...
Page 322
Table 66 system-parameters-table properties (continued) Name Type Description Not applicable. min-backing- uint32 store-size Not applicable. max-fc-speed string Not applicable. max-fc-speed- uint32 numeric 322 XML API basetype properties...
tasks This basetype is used by show tasks show task-details (Deprecated). Table 67 tasks properties Name Type Description Task name. name string Type of operation this task performs. type string • EnableDSD • DisableDSD Task status. status string • Uninitialized: Task is not yet ready to run. •...
time-settings-table This basetype is used by show controller-date. Table 68 time-settings-table properties Name Type Description Date and time, in the format year-month-day hour:minutes:seconds date-time string (UTC), reported by the controller being accessed. Unformatted date-time value. date-time- uint32 numeric The system's time zone as an offset in hours and minutes from UTC. This is shown time-zone- string only if NTP is enabled.
unhealthy-component This basetype is used by all commands that show component health. Table 69 unhealthy-component properties Name Type Description Component type. component-type string super-cap: Supercapacitor pack • • MC: Management Controller • port: Host port • controller: Controller module • expansion module: Expansion module •...
Page 326
Table 69 unhealthy-component properties (continued) Name Type Description Component health. health string • • Degraded • Fault • Unknown • Numeric equivalents for health values. health-numeric uint32 • 0: OK • 1: Degraded • 2: Fault • 3: Unknown • 4: N/A If Health is not OK, the reason for the health state.
unwritable-cache This basetype is used by show unwritable-cache. Table 70 unwritable-cache properties Name Type Description The percentage of cache space occupied by unwritable data in controller A. unwritable-a- uint8 percentage The percentage of cache space occupied by unwritable data in controller B. unwritable-b- uint8 percentage...
users This basetype is used by show users. Table 71 users properties Name Type Description User name. username string • monitor: User can view but not change system settings. roles string • manage: User can view and change system settings. •...
Page 329
Table 71 users properties (continued) Name Type Description The number of decimal places (1–10) for display of storage-space sizes. storage-size- uint8 precision The unit for display of storage-space sizes. storage-size- string units • auto: Lets the system determine the proper unit for a size. •...
Page 330
Table 71 users properties (continued) Name Type Description Encryption password for an SNMPv3 user whose privacy type is set to DES or privacy- string password AES. For an SNMPv3 user whose interface-access-SNMP property is set to trap- string snmptarget, this specifies the IP address of the host that will receive SNMP destination traps.
vdisk-hist-statistics This basetype is used by show vdisk-statistics when the historical parameter is specified. Table 72 vdisk-hist-statistics properties Name Type Description Total amount of data read and written since the last sampling time. total-data- uint64 transferred Unformatted total-data-transferred value. total-data- uint64 transferred- numeric...
vdisk-statistics This basetype is used by show vdisk-statistics when the historical parameter is omitted. Table 73 vdisk-statistics properties Name Type Description Vdisk name. name string Vdisk serial number. serial-number string Data transfer rate calculated over the interval since these statistics were last bytes-per- uint64 requested or reset.
versions This basetype is used by show configuration, show versions, and versions (Deprecated). Table 74 versions properties Name Type Description Storage Controller processor type. sc-cpu-type string Firmware bundle version. bundle-version string Firmware bundle build date. build-date string Storage Controller firmware version. sc-fw string Storage Controller firmware base level.
virtual-disk-summary This basetype is used by show vdisk-statistics when the historical parameter is specified. Table 75 virtual-disk-summary properties Name Type Description Vdisk name. name string Vdisk serial number. serial-number string Embedded; see vdisk-hist-statistics. vdisk-hist- statistics 334 XML API basetype properties...
virtual-disks This basetype is used by show configuration show vdisks. Table 76 virtual-disks properties Name Type Description Vdisk name. name string Vdisk capacity, formatted to use the current base, precision, and units. size string Unformatted size value in 512-byte blocks. size-numeric uint32 Amount of free (available) space in the vdisk, formatted to use the current base,...
Page 336
Table 76 virtual-disks properties (continued) Name Type Description Number of spare disks assigned to the vdisk. sparecount uint16 • For RAID levels except NRAID, RAID 1, and RAID 50, the configured chunk chunksize string size for the vdisk. • For NRAID and RAID 1, chunk size has no meaning and is therefore shown as not applicable (N/A).
Page 337
Table 76 virtual-disks properties (continued) Name Type Description Unformatted min-drive-size value in 512-byte blocks. min-drive-size- uint32 numeric Date and time, in the format year-month-day hour:minutes:seconds create-date string (UTC), when the vdisk was created. Unformatted create-date value. create-date- uint32 numeric Not used. cache-read- string ahead...
Page 338
Table 76 virtual-disks properties (continued) Name Type Description Unformatted largest-free-partition-space value in 512-byte blocks. largest-free- uint32 partition- space-numeric • For a RAID- 1 0 or RAID-50 vdisk, the number of disks in each sub-vdisk. num-drives-per- uint8 • For other RAID levels, 1. low-level-array Not used.
Page 339
Table 76 virtual-disks properties (continued) Name Type Description Not applicable. scrub-duration- uint16 goal • health string • Degraded • Fault • Unknown • Numeric equivalents for health values. health-numeric uint32 • 0: OK • 1: Degraded • 2: Fault • 3: Unknown •...
volume-names This basetype is used by show volume-names. Table 77 volume-names properties Name Type Description Volume name. volume-name string Volume serial number. serial-number string 340 XML API basetype properties...
volume-reservations This basetype is used by show volume-reservations. Table 78 volume-reservations properties Name Type Description The name of the volume. volume-name string The serial number of the volume. serial-number string • Free: The volume is not reserved. reservation- string • Reserved: The volume has been reserved by a host.
volumes This basetype is used by show volumes. Table 79 volumes properties Name Type Description Volume ID in the form V#, where # starts at 1 and increments for each new durable-id string volume to uniquely identify it. The value is generated from available data in the current CLI session and may change after an MC restart.
Page 343
Table 79 volumes properties (continued) Name Type Description Numeric equivalents for write-policy values. write-policy- uint32 numeric • 0: write-through • 1: write-back • standard: Optimizes cache for both sequential and random reads. cache- string Appropriate for applications that read and write small files in random order, optimization such as transaction-based and database update applications.
Page 344
Table 79 volumes properties (continued) Name Type Description • N/A: Not applicable. volume- string qualifier Numeric equivalents for volume-qualifier values. volume- uint32 qualifier- • 0: N/A numeric Unformatted size value in 512-byte blocks. blocks uint64 For internal use only. capabilities string Not applicable.
volume-statistics This basetype is used by show volume-statistics. Table 80 volume-statistics properties Name Type Description The name of the volume. volume-name string The serial number of the volume. serial-number string The data transfer rate calculated over the interval since these statistics were last bytes-per- uint64 requested or reset.
Page 347
Table 80 volume-statistics properties (continued) Name Type Description Not applicable. read-cache- uint64 misses The number of times flush from cache to disk is not a full stripe. small-destages uint64 The number of times flush from cache to disk is a full stripe. full-stripe- uint64 write-destages...
volume-view This basetype is used by show maps show volume-maps (Deprecated). Table 81 volume-view properties Name Type Description Volume ID in the form V#, where # starts at 1 and increments for each new durable-id string volume to uniquely identify it. The value is generated from available data in the current CLI session and may change after an MC restart.
volume-view-mappings This basetype is used by show maps show volume-maps (Deprecated). Table 82 volume-view-mappings properties Name Type Description Mapping ID. durable-id string For a mapping between a volume and an initiator, the volume ID—or if the parent-id string volume is a member of a volume group, the volume-group ID. The ID of the mapping target, such as an initiator.
Settings changed by restore defaults This appendix summarizes the system settings that result from using the restore defaults command. Table 83 Settings changed by restore defaults Setting Value System information settings: • System name • Uninitialized Name • System contact •...
Glossary 4U56 An enclosure that is four rack units in height and can contain 56 disks. Additional Sense See ASC/ASCQ. Code/Additional Sense Code Qualifier Advanced Encryption See AES. Standard Advanced Encryption Standard. A specification for the encryption of data using a symmetric-key algorithm.
Page 353
Configuration See CAPI. Application Programming Interface controller A (or B) A short way of referring to controller module A (or B). controller enclosure An enclosure that contains one or two controller modules. controller module A FRU that contains the following subsystems and devices: a Storage Controller processor; a Management Controller processor;...
Page 354
dynamic spare An available compatible disk that is automatically assigned, if the dynamic spares option is enabled, to replace a failed disk in a vdisk with a fault-tolerant RAID level. See also available disk, compatible disk, dedicated spare, and global spare. Expander Controller.
Page 355
Logical Block Address. The address used for specifying the location of a block of data. leftover The state of a disk that the system has excluded from a vdisk because the timestamp in the disk’s metadata is older than the timestamp of other disks in the vdisk, or because the disk was not detected during a rescan.
Page 356
POST Power-on self test. Tests that run immediately after a device is powered on. Power-On Self Test See POST. power supply unit See PSU. Power supply unit. The power supply FRU. RAID head See controller enclosure. recovery In an active-active configuration, recovery is the act of returning ownership of controller resources to a controller (which was offline) from its partner controller.
Page 357
Storage Networking See SNIA. Industry Association A controller enclosure with at least one connected drive enclosure. Product documentation storage system and interfaces use the terms storage system and system interchangeably. syslog A protocol for sending event messages across an IP network to a logging server. tray See enclosure.
Index exit output formats access level scripting commands show user scripting guidelines activity progress interface set base for storage-space sizes enable/disable set locale ALUA set output format array set paging mode See system set precision audience set prompt auto-stall recovery set temperature scale enable/disable set timeout...
Page 359
show shutdown status show maximum number of shut down show parameters controller failure trigger show performance statistics enable/disable show provisioning show setting show SMART setting controller module show spin-down delay force to fail show spin-down setting recover from simulated failure show system SMART setting show firmware and hardware versions show thresholds for degraded...
Page 360
expander show clear status and counters show number of enable/disable PHY fault isolation show performance statistics show status hosts explicit mapping show show mappings syntax HTTP interface fail controller module enable/disable failover status and reason HTTP interface to XML API show controller HTTPS interface fan failure trigger...
Page 361
Management Controllers ping a remote host restart port management-interface access syntax set user ports show user show health for SAS mappings show provisioning show power supplies masked volume show metadata power supply failure trigger clear degraded disk enable/disable clear disk show setting midplane precision for storage-space sizes...
Page 362
set interval for vdisk background reset volume performance show interval for vdisk show controller performance show setting for disk show disk performance show setting for vdisk show host-port performance start manual vdisk show PHY performance start manual volume show vdisk performance SCSI MODE SELECT command show volume performance set handling of...
Page 363
units for storage-space sizes show maximum number per controller set CLI show performance statistics set user show provisioning show CLI start manual scrub users verification authentication type for SNMPv3 abort create versions delete show firmware and hardware make session preferences permanent virtual disk password rules name...
Need help?
Do you have a question about the AssuredSAN 6004 and is the answer not in the manual?
Questions and answers