This article hasn't been updated for over 5 years. The information below may be obsolete.
EMC ECS CLI Command Reference
The ECS Command Line Interface (ecscli.py) is a command line tool for EMC Elastic Cloud Storage that provides high-level commands to simplify the process. In this article we provide a listing of the commands used in the ECS CLI.
NOTE: This article does not go into details of how to install the ECS Command-line tool.
What is EMC ECS?
EMC ECS (Elastic Cloud Storage) is an Enterprise-grade object storage platform that allows organisations to flexibly capture, store, protect and manage unstructured data behind the enterprise firewall, with scalability that rivals the public cloud.
Syntax
# ecscli.py command <options>
CLI Commands
You can use the -h flag to list all the available options for each command. A full description of each ecscli.py command is available in the ECS Reference Guide, available via the EMC Support Portal.
| Action | Command |
|---|---|
| Authenticate to ECS Array | ecscli.py authenticate |
| Add an Authentication Provider | ecscli.py authentication add-provider |
| Delete an Authentication Provider | ecscli.py authentication delete-provider |
| List your Authentication Provider | ecscli.py authentication list-providers |
| Show Authentication Provider | ecscli.py authentication show-provider |
| Update your Authentication | ecscli.py authentication update |
| Delete an ECS Bucket | ecscli.py bucket delete |
| Delete an ECS Bucket Quota | ecscli.py bucket delete-quota |
| Get bucket ACL information | ecscli.py bucket get-acl |
| Get bucket group information | ecscli.py bucket get-groups |
| Get Bucket Permissions | ecscli.py bucket get-permissions |
| Get bucket Quota information | ecscli.py bucket get-quota |
| Get Bucket Retention Period | ecscli.py bucket get-ret-period |
| Bucket Info | ecscli.py bucket info |
| Bucket List | ecscli.py bucket list |
| Bucket Lock | ecscli.py bucket lock |
| Bucket Lock Info | ecscli.py bucket lock-info |
| Set Bucket ACL | ecscli.py bucket set-acl |
| Update the Bucket Owner | ecscli.py bucket update-owner |
| Update the Bucket Retention Period | ecscli.py bucket update-ret |
| Update the Bucket isStaleAllowed parameter | ecscli.py bucket update-stale |
| Create or update cas secret for user | ecscli.py cas create_update_secret |
| Delete cas secret for user | ecscli.py cas delete_secret |
| Get cas bucket for user | ecscli.py cas get_bucket |
| Get cas metadata for user with namespace | ecscli.py cas get_metadata |
| Get cas pea for user with namespace | ecscli.py cas get_pea |
| Get cas registered applications for user | ecscli.py cas get_registered_apps |
| Get cas secret for user | ecscli.py cas get_secret |
| Set cas bucket for user | ecscli.py cas set_bucket |
| Set cas metadata for user | ecscli.py cas set_metadata |
| Get Bulk Resources for the Datastore | ecscli.py datastore bulk-get |
| Create a data store | ecscli.py datastore create |
| Delete a data store node | ecscli.py datastore delete |
| List Datastore | ecscli.py datastore list |
| Show Datastore node | ecscli.py datastore show |
| List Datastore tasks | ecscli.py datastore tasks |
| List data fabric services | ecscli.py dataservice list |
| Provision data fabric services | ecscli.py dataservice provision |
| Get configured temp failed zone info | ecscli.py failedzones |
| Show Keystore | ecscli.py keystore show |
| Update Keystore | ecscli.py keystore update |
| SOS metering | ecscli.py meter |
| Create Mgmtuserinfo | ecscli.py mgmtuserinfo add |
| Delete Mgmtuserinfo | ecscli.py mgmtuserinfo delete |
| List Mgmtuserinfo | ecscli.py mgmtuserinfo list |
| SOS Monitoring | ecscli.py monitor |
| Create Namespace | ecscli.py namespace create |
| Create Namespace Retention Class | ecscli.py namespace create-ret |
| Delete Namespace | ecscli.py namespace delete |
| Delete Namespace Quota | ecscli.py namespace delete-quota |
| Get Tenant Namespace | ecscli.py namespace get |
| Get Namespace Quota | ecscli.py namespace get-quota |
| Get Namespace Retention Period | ecscli.py namespace get-ret-period |
| List Namespaces | ecscli.py namespace list |
| Get Namespace Retention Classes | ecscli.py namespace list-ret |
| Show Namespace | ecscli.py namespace show |
| Update Namespace | ecscli.py namespace update |
| Update Namespace Retention Class | ecscli.py namespace update-ret |
| Update Namespace Quota | ecscli.py namespace update-quota |
| Get a list of ECS datanodes | ecscli.py nodes list |
| Create an Objectuser | ecscli.py objectuser create |
| Delete an Objectuser | ecscli.py objectuser delete |
| Get lock info for an Objectuser | ecscli.py objectuser get-lock |
| List an Objectuser | ecscli.py objectuser list |
| Lock an Objectuser | ecscli.py objectuser lock |
| Unlock an Objectuser | ecscli.py objectuser unlock |
| Add an ObjectVPool | ecscli.py objectvpool add |
| Create an ObjectVPool | ecscli.py objectvpool create |
| Delete an ObjectVPool | ecscli.py objectvpool delete |
| List ObjectVPools | ecscli.py objectvpool list |
| Remove an ObjectVPool | ecscli.py objectvpool remove |
| objectvpool show | ecscli.py Show an ObjectVPool |
| Update an ObjectVPool | ecscli.py objectvpool update |
| Add a Secretkeyuser | ecscli.py secretkeyuser add |
| Delete a Secretkeyuser | ecscli.py secretkeyuser delete |
| Show a Secretkeyuser | ecscli.py secretkeyuser show |
| Delete a Secretkeyuser user | ecscli.py secretkeyuser user-delete |
| Show a Secretkeyuser User | ecscli.py secretkeyuser user-show |
| Add a System license | ecscli.py system add-license |
| Connect EMC by ftps | ecscli.py system connectemc-ftps |
| Connect EMC by smtp | ecscli.py system connectemc-smtp |
| Deactivate ESRS callhome configuration | ecscli.py system deactivate-callhome |
| Get System Alerts | ecscli.py system get-alerts |
| Get the ESRS callhome configuration | ecscli.py system get-callhome-config |
| Get the System license | ecscli.py system get-license |
| Get the System logging level | ecscli.py system get-log-level |
| Get the System logs | ecscli.py system get-logs |
| Get the System properties | ecscli.py system get-properties |
| Get the system properties metadata | ecscli.py system get-properties-metadata |
| Send a System Alert | ecscli.py system send-alert |
| Set the system logging level | ecscli.py system set-log-level |
| Set system properties | ecscli.py system set-properties |
| Add a Tenant attribute | ecscli.py tenant add-attribute |
| Create a Tenant | ecscli.py tenant add-group |
| Add a Tenant Role | ecscli.py tenant add-role |
| Update a tenant role | ecscli.py tenant create |
| Delete a Tenant | ecscli.py tenant delete |
| Delete a tenant role | ecscli.py tenant delete-role |
| Get tenant clusters | ecscli.py tenant get-clusters |
| Get tenant hosts | ecscli.py tenant get-hosts |
| Display tenant roles | ecscli.py tenant get-role |
| Get tenant vcenters | ecscli.py tenant get-vcenters |
| List the tenants | ecscli.py tenant list |
| Remove a tenant attribute | ecscli.py tenant remove-attribute |
| Show tenants | ecscli.py tenant show |
| Update tenant quotas | ecscli.py tenant update-quota |
| Create a varray | ecscli.py varray create |
| Delete a varray | ecscli.py varray delete |
| List a varray | ecscli.py varray list |
| Update a varray | ecscli.py varray update |
| VirtualDataCenter delete | ecscli.py vdc delete |
| VirtualDataCenter delete | ecscli.py vdc delete |
| VirtualDataCenter list | ecscli.py vdc list |
| Insert ECS Data VirtualDataCenter | ecscli.py vdc_data insert |
| List ECS Data VirtualDataCenter | ecscli.py vdc_data list |
| Local ECS Data VirtualDataCenter | ecscli.py vdc_data local |
| Show ECS Data VirtualDataCenter | ecscli.py vdc_data show |
| Add storage pools to ECS VPOOL | ecscli.py vpool add_pools |
| Allow tenant access to ECS VPOOL | ecscli.py vpool allow |
| Create an ECS VPOOL | ecscli.py vpool create |
| Delete an ECS VPOOL | ecscli.py vpool delete |
| Disallow tenant access to ECS VPOOL | ecscli.py vpool disallow |
| Get storage pools in ECS VPOOL | ecscli.py vpool get_pools |
| List ECS VPOOLs | ecscli.py vpool list |
| Refresh storage pools in ECS VPOOL | ecscli.py vpool refresh_pools |
| Remove storage pools in ECS VPOOL | ecscli.py vpool remove_pools |
| Show ECS VPOOL | ecscli.py vpool show |
| Update ECS VPOOL | ecscli.py vpool update |
Further Reading
- How to Install ECS Command Line tool (external link).
- ECS Reference Guide (external link)