Storage Center OS 7.x CLI Reference Guide (SCOS)

Dell Storage Center OS 7 Command Line Reference Guide

This guide is meant to be a quick reference for SCOS commands, if you need to dive into the details of the available options for each command I’d recommend reviewing Dell’s complete and official CLI guide here.  You can also use the “-h” command to review command options from the CLI.

The SCOS CLI Utility is a Java application (JRE 1.6+) for running commands and writing scripts to manage or automate the management of a Dell Storage Center.   There are commands to perform most common management operations.  It supports Windows, Linux, Solaris, and AIX platforms.  Commands can be executed from a command prompt or included in batch files.

The Java libraries (CompCU.jar) can be downloaded directly from the Dell support site.  You can also get the Dell Compellent Java SDK from github here, if that’s relevant to your environment.

To run commands credentials must be specified:

java –jar compcu.jar –default –host storagecenter1 –user admin –password <password>

To execute a single command, use the “-c” option. Here’s an example:

java -jar compcu.jar -host storagecenter1 -user admin -password <password> -c "os show"

Command Reference:

Command Format Description
alert acknowledge alert acknowledge –controller integer –index integer {options} Marks a Storage Center alert as having been acknowledged. Acknowledgment indicates to the Storage Center that you have read the alert message and are aware of the problem.
alert show alert show {-alert_type alert | history | indication| maintenance}  {-category Connectivity | disk | hardware | storage | system} Returns information for alerts that were generated on a Storage Center. Output depends on the filter options specified in the command.
cache modify cache modify –readcache {true|false} –writecache {true|false} Modifies Storage Center cache.
cache show cache show -txt cache_info.txt -xml cach_info.xml Shows Storage Center cache settings. Output depends on the filter options specified in the command.
cmm copy cmm copy –sourcevolumeindex integer –destvolumeindex integer {options} –copyhistory {true|false} –destvolumeindex integer –priority string Creates a new CMM copy operation on the Storage Center.
cmm migrate cmm migrate –sourcevolumeindex integer –destvolumeindex integer {options} –copyhistory {true|false} –deletesource {true|false} –destvolumeindex integer Creates a new CMM migrate operation on the Storage Center.
cmm mirror cmm mirror –sourcevolumeindex integer –destvolumeindex integer {options} –copyhistory {true|false} –destvolumeindex integer –priority string Creates a new CMM mirror operation on the Storage Center to mirror all data from a source volume to a destination volume.
cmm modify cmm modify –index integer –priority integer | string {options} Modifies the priority of a CMM operation.
cmm delete cmm delete –index integer {options} Deletes a CMM operation from the Storage Center by aborting the operation
cmm show cmm show {options} Shows the attributes of CMM operations.
consistencygroup show consistencygroup show {options} Shows the groups of Replays that are created with and associated with a Consistency Group.
controller show controller show {options} –controlleripaddress string Shows configuration information for each controller present.
diskfolder show diskfolder show {options} Shows Storage Center disk folder information.
mapping show mapping show {options} Shows mapping information for the Storage Center.
os show os show {options} Shows server operating system information.
replay checkviews replay checkviews {options} Checks for and deletes expired views.
replay create replay create {-volumeindex | -deviceid | -serialnumber | -volume } Creates a Replay of a volume. In addition, optionally creates and maps a view volume from the Replay.
replay createview replay createview –index | ({–name | –last} {–volumeindex | –volume | –deviceid | –serialnumber }) Creates a view volume on an existing Replay and optionally maps the new view volume to a server.
replay delete replay delete –index | ({–name | –last} {–volumeindex | – volume | –deviceid | –serialnumber }) Deletes a Replay.
replay show replay show {options} Shows Replay information.
replayprofile createreplay replayprofile createreplay {–index integer | –name string} {options} Creates a Replay on all volumes in a Replay profile, including Replay profiles that form a Consistency Group.
replayprofile show replayprofile show {options} Shows Replay profile information.
server addhba server addhba {–name string | –index integer} –WWN string,…,string {options} Configures a new HBA for an existing server in the Storage Center.
server addtocluster server addtocluster {–name string | –index integer} {–parent string | – parentindex integer} {options} Assigns an existing physical or virtual server to an existing server.
server create server create –name string –wwn string,…,string {options} Configures a physical server into the Storage Center.
server createcluster server createcluster –name string {–os string | –osindex integer} {options} Creates a server cluster with no underlying physical or virtual servers.
server delete server delete {–name string | –index string} {options} Deletes a server from the Storage Center, along with the associated HBAs and volume mappings.
server modify server modify {–index integer | –name string} {options} Modifies a server.
server removefromcluster server removefromcluster {–name string | –index integer} {options} Returns information for alerts that were generated on a Storage Center. Output depends on the filter options specified in the command.
server removehba server removehba {–name string | –index integer} –WWN string,…,string {options} Removes an existing HBA assignment from an attached server.
server show server show {options} Shows the attributes of known attached servers on a Storage Center.
server showhba server showhba {options} Shows server port/HBA information for each attached server known to the Storage Center.
serverfolder create serverfolder create –name string {options} Creates a server folder.
serverfolder delete serverfolder delete {–index integer | –name string} {options} Deletes a server folder.
serverfolder modify serverfolder modify {–index integer | –name string} {–parent string | – parentindex integer} Modifies server folder settings.
serverfolder show serverfolder show {options} Shows information about a server folder.
storageprofile show storageprofile show {options} Shows Storage Profile information.
storagetype show storagetype show {options} Shows information about a storage type
system restart system restart {options} –simultaneous Enables an Administrator to restart a Storage Center.
system show system show {options} Shows current Storage Center management configuration information through the leader controller.
system shutdown system shutdown Enables an Administrator to shut down a Storage Center.
user create user create –username string –password string –privilege integer {options} Enables a user with Administrator privileges to create a new user account on the Storage Center.
user delete user delete {–index integer | –username string} {options} Enables a user with Administrator privileges to delete an existing user account on the Storage Center.
user modify user modify {–index integer | –username string} {options} Enables a user with Administrator privileges to modify existing Storage Center user account information and privileges for any user on the Storage Center.
user show user show {options} Enables a user with Administrator privileges to view information about Storage Center users.
usergroup create usergroup create –name string {–volumefolder string,…,string | –volumefolderindex string,…,string} {–serverfolder string,…,string | –serverfolderindex string,…,string} {–diskfolder string,…,string | –diskfolderindex string,…,string} {options} Enables a user with Administrator privileges to create a user group on the Storage Center and to specify disk, server, and volume folders for the group.
usergroup delete usergroup delete {–index integer | –name string} Enables a user with Administrator privileges to delete an existing Storage Center user group.
usergroup modify usergroup modify {–index integer | –name string} {options} Enables a user with Administrator privileges to modify information and privileges for a Storage Center user group.
usergroup show usergroup show {options} Enables a user with Administrator privileges to display information about Storage Center user groups.
volume create volume create –name string –size integer [k|m|g|t] {options} Creates a new volume and optionally maps the new volume to a server.
volume delete volume delete {–deviceid string | –index integer | –name string | –serialnumber string} {options} Deletes a volume.
volume erase volume erase {–deviceid string | –index integer | –name string | –serialnumber string} Erases all data from a volume. This command is deprecated for Storage Center 5.0 and later.
volume expand volume expand {–deviceid string | –index integer | –name string –serialnumber string} –size integer [k|m|g|t] Expands the size of a volume.
volume map volume map {–deviceid string | –index integer | –name string | –serialnumber string} {–server string | –serverindex integer} {–boot | –lun} {options} Maps an existing volume to a server.
volume modify volume modify {–deviceid string | –index integer | –name string | –serialnumber string} {options} Modifies a volume.
volume show volume show {options} Shows volume information.
volume unmap volume unmap {–deviceid string | –index integer | –name string | –serialnumber string} Deletes all mappings for a volume.
volumefolder create volumefolder create –name string {options} Creates a volume folder.
volumefolder delete volumefolder delete {–index integer | –name string} –parent string Deletes a volume folder.
volumefolder modify volumefolder modify {–index integer | –name string} [–parent string | – parentindex integer] Modifies a volume folder.
volumefolder show volumefolder show {options} Shows volume folder information.

 

Advertisements

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.