EMC Elastic Cloud Storage (ECS)

CLI Quick Reference

Documentation

EMC ECS

Abstract

This document provides reference information on the ECS CLI.

Revision 01
June, 2015
 Copyright © 2013 - 2015 EMC Corporation. All rights reserved.

Published June, 2015

EMC believes the information in this publication is accurate of its publication date.
The information is subject to change without notice.

The information in this publication is provided “as is”. EMC Corporation makes no
representations or warranties of any kind with respect to the information in this
publication, and specifically disclaims implied warranties of merchantability or
fitness for a particular purpose.

Use, copying, and distribution of any EMC software described in this publication
requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation
Trademarks on EMC.com.

VMware is a registered trademarks or trademarks of VMware, Inc. in the United States

and/or other jurisdictions. All other trademarks used herein are the property of their
respective owners.

ECS CLI Quick Reference

Documentation

Part Number 302-001-998

Revision 01

2 ECS CLI Quick Reference

Documentation
 Contents

Contents

Command reference ............................................................9

authenticate .......................................................................9
authentication add-provider ................................................10
authentication delete-provider ............................................11
authentication list-providers................................................12
authentication show-provider ..............................................13
authentication update .........................................................14
bucket create ......................................................................15
bucket delete ......................................................................16
bucket delete-quota ............................................................17
bucket get-acl .....................................................................18
bucket get-groups ...............................................................19
bucket get-permissions .......................................................20
bucket get-quota .................................................................21
bucket get-ret-period ...........................................................22
bucket info..........................................................................23
bucket list ...........................................................................24
bucket lock .........................................................................25
bucket lock-info ..................................................................26
bucket set-acl .....................................................................27
bucket update-owner ..........................................................28
bucket update-ret................................................................29
bucket update-stale ............................................................30
cas create_update_secret....................................................31
cas delete_secret ................................................................32
cas get_bucket ....................................................................33
cas get_metadata................................................................34
cas get_pea ........................................................................35
cas get_registered_apps .....................................................36
cas get_secret .....................................................................37

ECS CLI Quick Reference 3

Documentation
 Contents

cas set_bucket ....................................................................38

cas set_metadata ................................................................39
datastore bulk-get ...............................................................40
datastore create ..................................................................41
datastore delete ..................................................................42
datastore list.......................................................................43
datastore show ...................................................................44
datastore tasks ...................................................................45
dataservice list....................................................................46
dataservice provision ..........................................................47
failedzones .........................................................................48
keystore show .....................................................................49
keystore update ..................................................................50
meter ..................................................................................51
mgmtuserinfo add ...............................................................52
mgmtuserinfo delete ...........................................................53
mgmtuserinfo list ................................................................54
monitor ...............................................................................55
namespace create ...............................................................56
namespace create-ret ..........................................................57
namespace delete ...............................................................58
namespace delete-quota .....................................................59
namespace get ...................................................................60
namespace get-quota..........................................................61
namespace get-ret-period....................................................62
namespace list....................................................................63
namespace list-ret ..............................................................64
namespace show ................................................................65
namespace update .............................................................66
namespace update-ret ........................................................67
namespace update-quota....................................................68
nodes list ............................................................................69
objectuser create ................................................................70

4 ECS CLI Quick Reference

Documentation
 Contents

objectuser delete ................................................................71

objectuser get-lock..............................................................72
objectuser list .....................................................................73
objectuser lock ...................................................................74
objectuser unlock ...............................................................75
objectvpool add ..................................................................76
objectvpool create ..............................................................77
objectvpool delete ..............................................................78
objectvpool list ...................................................................79
objectvpool remove.............................................................80
objectvpool show ................................................................81
objectvpool update .............................................................82
secretkeyuser add ...............................................................83
secretkeyuser delete ...........................................................84
secretkeyuser show .............................................................85
secretkeyuser user-delete....................................................86
secretkeyuser user-show .....................................................87
system add-license .............................................................88
system connectemc-ftps ......................................................89
system connectemc-smtp ....................................................90
system deactivate-callhome ................................................91
system get-alerts .................................................................92
system get-callhome-config .................................................94
system get-license ..............................................................95
system get-log-level ............................................................96
system get-logs ...................................................................97
system get-properties..........................................................99
system get-properties-metadata ..........................................100
system send-alert ................................................................101
system set-log-level ............................................................103
system set-properties ..........................................................104
tenant add-attribute ............................................................105
tenant add-group ................................................................106

ECS CLI Quick Reference 5

Documentation
 Contents

tenant add-role ...................................................................107

tenant create.......................................................................108
tenant delete ......................................................................109
tenant delete-role................................................................110
tenant get-clusters ..............................................................111
tenant get-hosts ..................................................................112
tenant get-role ....................................................................113
tenant get-vcenters .............................................................114
tenant list ...........................................................................115
tenant remove-attribute.......................................................116
tenant show ........................................................................117
tenant update-quota ...........................................................118
varray create .......................................................................119
varray delete .......................................................................120
varray list ............................................................................121
varray update ......................................................................122
vdc delete ...........................................................................123
vdc insert ............................................................................124
vdc list ................................................................................125
vdc_data insert ...................................................................126
vdc_data list .......................................................................127
vdc_data local.....................................................................128
vdc_data show ....................................................................129
vpool add_pools .................................................................130
vpool allow .........................................................................131
vpool create ........................................................................132
vpool delete ........................................................................135
vpool disallow.....................................................................136
vpool get_pools ..................................................................137
vpool list .............................................................................138
vpool refresh_pools ............................................................139
vpool remove_pools ............................................................140
vpool show .........................................................................141

6 ECS CLI Quick Reference

Documentation
 Contents

vpool update.......................................................................142

ECS CLI Quick Reference 7

Documentation
 Command reference

authenticate
ECS authenticate CLI usage.

Syntax

ecscli.py authenticate [-h] [-cf <cookiefile>] [-hostname <hostname>]

[-port <port_number>] -u <username> -d <cookiedir>

Mandatory arguments
• -u <username>, -username <username> : username for login

• -d <cookiedir>, -cookiedir <cookiedir> : cookie directory to store cookie files

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 9

Documentation
 authentication add-provider

authentication add-provider
ECS Authentication Provider Add CLI usage.

Syntax

ecscli.py authentication add-provider [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -configfile
<configfile>

Mandatory arguments
• configfile <configfile> : config file for authentication provider

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

10 ECS CLI Quick Reference

Documentation
 authentication delete-provider

authentication delete-provider
ECS Authentication Provider delete CLI usage.

Syntax

ecscli.py authentication delete-provider [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name
<name>

Mandatory arguments
• -name <name> : name of the authentication provider

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 11

Documentation
 authentication list-providers

authentication list-providers
ECS Authentication Provider List CLI usage

Syntax

ecscli.py authentication list-providers [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-verbose]
[-long]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -verbose, -v : List Authentication providers with details

• -long, -l : List Authentication providers with more details

12 ECS CLI Quick Reference

Documentation
 authentication show-provider

authentication show-provider
ECS Authentication Provider Show CLI usage

Syntax

ecscli.py authentication show-provider [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <name>
[-xml]

Mandatory arguments
• -name <name> - name of the authentication provider

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -xml : XML response

ECS CLI Quick Reference 13

Documentation
 authentication update

authentication update
ECS authenticate CLI usage

Syntax

ecscli.py authentication update [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -configfile
<configfile>

Mandatory arguments
• -configfile <configfile> : config file for authentication provider

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

14 ECS CLI Quick Reference

Documentation
 bucket create

bucket create
ECS Bucket Create CLI usage

Syntax

ecscli.py bucket create [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <bucketname> -vpool <vpool> -fs_enable
<filesystem_enabled> -headtype <head_type>
-stale_allowed <is_stale_allowed> -namespace
<namespace>

Mandatory arguments
• -name <bucketname>, -n <bucketname> : Name of Bucket

• -vpool <vpool>, -vp <vpool> : bucket vPool ID

• -fs_enable <filesystem_enabled>, -fs <filesystem_enabled> : flag indicating

whether file-system is enabled for bucket

• -headtype <head_type>, -ht <head_type> : object head type allowed to access

bucket

• -stale_allowed <is_stale_allowed>, -stale <is_stale_allowed>, -sa

<is_stale_allowed> : tag to allow stale data in bucket

• -namespace <namespace>, -ns <namespace> : namespace associated with

bucket user/tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 15

Documentation
 bucket delete

bucket delete
ECS Bucket Delete CLI usage.

Syntax

ecscli.py bucket delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <bucketname>

Mandatory arguments
• -name <bucketname>, -n <bucketname> : Name of Bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

16 ECS CLI Quick Reference

Documentation
 bucket delete-quota

bucket delete-quota
ECS Delete Bucket Quota CLI usage.

Syntax

ecscli.py bucket delete-quota [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <bucket>
[-namespace <namespace>]

Mandatory arguments
• -name <bucket>, -n <bucket> : name of Bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of Bucket

ECS CLI Quick Reference 17

Documentation
 bucket get-acl

bucket get-acl
ECS Get Bucket ACL CLI usage.

Syntax

ecscli.py bucket get-acl [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <bucket> [-namespace <namespace>]

Mandatory arguments
• -name <bucket>, -n <bucket> : name of bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of bucket

18 ECS CLI Quick Reference

Documentation
 bucket get-groups

bucket get-groups
ECS Get Bucket ACL Groups CLI usage.

Syntax

ecscli.py bucket get-groups [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 19

Documentation
 bucket get-permissions

bucket get-permissions
ECS Get Bucket ACL Permissions CLI usage.

Syntax

ecscli.py bucket get-permissions [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

20 ECS CLI Quick Reference

Documentation
 bucket get-quota

bucket get-quota
ECS Get Bucket Quota CLI usage.

Syntax

ecscli.py bucket get-quota [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <bucket>
[-namespace <namespace>]

Mandatory arguments
• -name <bucket>, -n <bucket> : name of Bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of bucket

ECS CLI Quick Reference 21

Documentation
 bucket get-ret-period

bucket get-ret-period
ECS Get Bucket Retention Period CLI usage.

Syntax

Mandatory arguments
• -name <bucket>, -n <bucket> : name of bucket.

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

22 ECS CLI Quick Reference

Documentation
 bucket info

bucket info
ECS Bucket Info CLI usage.

Syntax

ecscli.py bucket info [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
-name <bucketname>

Mandatory arguments
• -name <bucket>, -n <bucket> : name of bucket.

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 23

Documentation
 bucket list

bucket list
ECS Bucket List CLI usage.

Syntax

ecscli.py [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>] [-v]
{authenticate,authentication,bucket,cas,datastore,dataservice,
failedzones,keystore,meter,mgmtuserinfo,monitor,nodes,objectuser,
objectvpool,secretkeyuser,system,namespace,tenant,varray,
vdc_data,vdc,vpool}...

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of Buckets

• -marker <marker>, -m <marker> : Reference to Last Object Returned

• -limit <limit>, -l <limit> : Number of Objects to List

24 ECS CLI Quick Reference

Documentation
 bucket lock

bucket lock
ECS Bucket Lock CLI usage.

Syntax

ecscli.py bucket lock [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
-name <bucketname> -lock <lock>

Mandatory arguments
• -name <bucketname>, -n <bucketname> : Name of Bucket

• -lock <lock>, -l <lock> : "true" to lock bucket, "false" to unlock

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 25

Documentation
 bucket lock-info

bucket lock-info
ECS Bucket Lock Info CLI usage.

Syntax

ecscli.py bucket lock-info [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <bucketname>
[-namespace <namespace>]

Mandatory arguments
• -name <bucketname>, -n <bucketname> : Name of Bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of Bucket

26 ECS CLI Quick Reference

Documentation
 bucket set-acl

bucket set-acl
ECS Set Bucket ACL CLI usage.

Syntax

ecscli.py bucket set-acl [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <bucket> -configfile <configfile>
[-namespace <namespace>]

Mandatory arguments
• -name <bucket>, -n <bucket> : name of Bucket

• -configfile <configfile> : config file for authentication provider

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of Bucket

ECS CLI Quick Reference 27

Documentation
 bucket update-owner

bucket update-owner
ECS Update Bucket Owner CLI usage.

Syntax

ecscli.py bucket update-owner [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <bucket>
-namespace <namespace> -owner <owner>

Mandatory arguments
• -name <bucket>, -n <bucket> : name of Bucket

• -namespace <namespace>, -ns <namespace> : namespace allowed to access

Bucket

• -owner <owner>, -o <owner> : new owner for this bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

28 ECS CLI Quick Reference

Documentation
 bucket update-ret

bucket update-ret
ECS Update Bucket Retention Period CLI usage.

Syntax

ecscli.py bucket update-ret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <bucket> -period
<period>

Mandatory arguments
• -name <bucket>, -n <bucket> : name of Bucket

• -period <period>, -p <period> : default retention period in seconds

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 29

Documentation
 bucket update-stale

bucket update-stale
ECS Update Bucket isStaleAllowed CLI usage.

Syntax

ecscli.py bucket update-stale [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <bucket>
-stale_allowed <is_stale_allowed>
[-namespace <namespace>]

Mandatory arguments
• -name <bucket>, -n <bucket> : name of Bucket

• -stale_allowed <is_stale_allowed>, -stale <is_stale_allowed>, -sa

<is_stale_allowed> : tag to allow stale data in bucket

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace of Bucket

30 ECS CLI Quick Reference

Documentation
 cas create_update_secret

cas create_update_secret
ECS create or update cas secret for user

Syntax

ecscli.py cas create_update_secret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-format <format>]
[-namespace NAMESPACE]
[-secret SECRET]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

• -secret SECRET, -secret SECRET : CAS namespace

ECS CLI Quick Reference 31

Documentation
 cas delete_secret

cas delete_secret
ECS delete cas secret for user

Syntax

ecscli.py cas delete_secret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-format <format>] [-namespace NAMESPACE]
[-secret SECRET]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

• -secret SECRET, -secret SECRET : CAS namespace

32 ECS CLI Quick Reference

Documentation
 cas get_bucket

cas get_bucket
ECS get cas bucket for user

Syntax

ecscli.py cas get_bucket [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-uid <uid> [-namespace NAMESPACE]
[-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

ECS CLI Quick Reference 33

Documentation
 cas get_metadata

cas get_metadata
ECS get cas metadata for user with namespace

Syntax

ecscli.py cas get_metadata [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-namespace NAMESPACE] [-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

34 ECS CLI Quick Reference

Documentation
 cas get_pea

cas get_pea
ECS get cas pea for user with namespace

Syntax

ecscli.py cas get_pea [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
-uid <uid> [-namespace NAMESPACE]
[-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

ECS CLI Quick Reference 35

Documentation
 cas get_registered_apps

cas get_registered_apps
ECS get cas registered applications for user

Syntax

ecscli.py cas get_registered_apps [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-namespace NAMESPACE]
[-format <format>]

Mandatory arguments
• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format, xml or json (default:json)

36 ECS CLI Quick Reference

Documentation
 cas get_secret

cas get_secret
ECS get cas secret for user

Syntax

ecscli.py cas get_secret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-uid <uid> [-namespace NAMESPACE]
[-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

ECS CLI Quick Reference 37

Documentation
 cas set_bucket

cas set_bucket
ECS set cas bucket for user

Syntax

ecscli.py cas set_bucket [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-uid <uid> [-namespace NAMESPACE]
[-bucket BUCKET] [-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

• -bucket BUCKET, -b BUCKET : CAS bucket name

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

38 ECS CLI Quick Reference

Documentation
 cas set_metadata

cas set_metadata
ECS set cas metadata for user

Syntax

ecscli.py cas set_metadata [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-namespace NAMESPACE] [-metadata METADATA]
[-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : CAS uid

• -namespace NAMESPACE, -ns NAMESPACE : CAS namespace

• -metadata METADATA, -md METADATA : CAS metadata value should be

entered in format 'key':'value','key':'value'...

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 39

Documentation
 datastore bulk-get

datastore bulk-get
ECS Datastore Get Bulk Resources CLI usage.

Syntax

ecscli.py datastore bulk-get [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -ids <ids>

Mandatory arguments
• -ids <ids> : comma-delimited list of resource ids

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

40 ECS CLI Quick Reference

Documentation
 datastore create

datastore create
ECS create data store CLI usage

Syntax

ecscli.py datastore create [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <name> -varray
<varray> [-dsid <datastoreid>]
[-desc <description>]

Mandatory arguments
• -name <name>, -n <name> : Name of data store

• -varray <varray>, -va <varray> : Virtual Array of data store

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -dsid <datastoreid>, -datastoreid <datastoreid> : IP address of data store

• -desc <description>, -description <description> : Description for data store

ECS CLI Quick Reference 41

Documentation
 datastore delete

datastore delete
ECS delete data store node CLI usage

Syntax

ecscli.py datastore delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name NAME

Mandatory arguments
• -name NAME, -n NAME : Name of data store

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

42 ECS CLI Quick Reference

Documentation
 datastore list

datastore list
ECS Datastore List CLI usage.

Syntax

ecscli.py datastore list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-verbose] [-long]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -verbose, -v : data stores list with details

• -long, -l : List Data stores with details in table format

ECS CLI Quick Reference 43

Documentation
 datastore show

datastore show
ECS show data store node CLI usage

Syntax

ecscli.py datastore show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name NAME -poolid POOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -name NAME, -n NAME : Name of data store

• -poolid POOL, -pid POOL : ID of storage pool

44 ECS CLI Quick Reference

Documentation
 datastore tasks

datastore tasks
ECS datastore List tasks CLI usage.

Syntax

ecscli.py datastore tasks [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <name> [-id <opid>]

Mandatory arguments
• -name <name>, -n <name> : Name of data store

• -id <opid> : Operation ID

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 45

Documentation
 dataservice list

dataservice list
ECS List data fabric services CLI usage

Syntax

ecscli.py dataservice list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

46 ECS CLI Quick Reference

Documentation
 dataservice provision

dataservice provision
ECS provision data fabric services CLI usage

Syntax

ecscli.py dataservice provision [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -service <service>
-nodes <node> [<node> ...]

Mandatory arguments
• -service <service>, -s <service> : Type of service (URI)

• -nodes <node> [<node> ...], -n <node> [<node> ...] : ID of node (URI)

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 47

Documentation
 failedzones

failedzones
get configured temp failed zone info CLI usage

Syntax

ecscli.py failedzones [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
[-format <format>] [-repGrpId REPGRPID]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -repGrpId REPGRPID, -rgid REPGRPID : allows retrieval of failed zone info for
particular replication group id

48 ECS CLI Quick Reference

Documentation
 keystore show

keystore show
ECS keystore Show CLI usage.

Syntax

ecscli.py keystore show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-xml]

Mandatory arguments
• -xml : XML response

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 49

Documentation
 keystore update

keystore update
ECS keystore Update CLI usage.

Syntax

ecscli.py keystore update [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-certificatevaluefile <certificatevaluefile>]
[-privatekeyvaluefile <privatekeyvaluefile>]
[-selfsign {true,false}]
[-ipaddresses [IPADDRESSES [IPADDRESSES ...]]]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -certificatevaluefile <certificatevaluefile>, -cvf <certificatevaluefile> : path of file

with certificate to be added

• -privatekeyvaluefile <privatekeyvaluefile>, -pkvf <privatekeyvaluefile> : path of

file with private key to be added

• -selfsign {true,false}, -ss {true,false} : Use self sign or not

• -ipaddresses [IPADDRESSES [IPADDRESSES ...]], -ip [IPADDRESSES

[IPADDRESSES ...]] : server ip addresses for cert rollout mgmt

50 ECS CLI Quick Reference

Documentation
 meter

meter
SOS metering CLI usage

Syntax

ecscli.py meter [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>] -year
<year> -month <month> -day <day> -hour <hour>
[-format <format>] [-minute <minute>]

Mandatory arguments
• -year <year>, -y <year> : Year

• -month <month>, -mon <month> : month of the year {1 - 12}

• -day <day>, -d <day> : day of the month {01 - 31}

• -hour <hour>, -hr <hour> : hour of the day {00 - 23}

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -minute <minute>, -min <minute> : minute of the hour {00 - 59}

ECS CLI Quick Reference 51

Documentation
 mgmtuserinfo add

mgmtuserinfo add
ECS Mgmtuserinfo Create CLI usage.

Syntax

ecscli.py mgmtuserinfo add [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid> -namespace
<namespace>

Mandatory arguments
• -uid <uid> : UID

• -namespace <namespace>, -ns <namespace> : namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

52 ECS CLI Quick Reference

Documentation
 mgmtuserinfo delete

mgmtuserinfo delete
ECS Mgmtuserinfo delete CLI usage.

Syntax

ecscli.py mgmtuserinfo delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-namespace <namespace>]

Mandatory arguments
• -uid <uid> : UID

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace for user. Required if

userscope is NAMESPACE.

ECS CLI Quick Reference 53

Documentation
 mgmtuserinfo list

mgmtuserinfo list
ECS Mgmtuserinfo List CLI usage.

Syntax

ecscli.py mgmtuserinfo list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-namespace <namespace>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace for user. Required if

userscope is NAMESPACE.

54 ECS CLI Quick Reference

Documentation
 monitor

monitor
SOS monitoring CLI usage

Syntax

ecscli.py monitor [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
-start_time START_TIME [-end_time END_TIME]
[-format <format>]

Mandatory arguments
• -start_time START_TIME, -st START_TIME : start datetime in format YYYY-mm-
DDTHH:MM

• -end_time END_TIME, -et END_TIME : start datetime in format YYYY-mm-

DDTHH:MM

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 55

Documentation
 namespace create

namespace create
ECS Namespace Create CLI usage.

Syntax

ecscli.py namespace create [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace <namespace>
-project <project> -objectvpool
<objectvpool> [-tenant <tenant>]
[-format <format>]

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

• -project <project>, -p <project> : name of Project

• -objectvpool <objectvpool>, -ovp <objectvpool> : name of Object Virtual Pool

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -t <tenant> : name of Tenant

• -format <format>, -f <format> : response format: xml or json (default:json)

56 ECS CLI Quick Reference

Documentation
 namespace create-ret

namespace create-ret
ECS Create Namespace Retention Class CLI usage.

Syntax

ecscli.py namespace create-ret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace
<namespace> -class <classname> -period
<period>

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

• -class <classname>, -c <classname> : name of retention class

• -period <period>, -p <period> : period of retention class

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 57

Documentation
 namespace delete

namespace delete
ECS Delete Namespace CLI usage.

Syntax

ecscli.py namespace delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace <namespace>

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

58 ECS CLI Quick Reference

Documentation
 namespace delete-quota

namespace delete-quota
ECS Delete Namespace Quota CLI usage.

Syntax

ecscli.py namespace delete-quota [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-namespace <namespace>]

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 59

Documentation
 namespace get

namespace get
ECS Get Tenant Namespace CLI usage.

Syntax

ecscli.py namespace get [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-tenant <tenant>]

Mandatory arguments
• -tenant <tenant> : name of Tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

60 ECS CLI Quick Reference

Documentation
 namespace get-quota

namespace get-quota
ECS Get Namespace Quota CLI usage.

Syntax

ecscli.py namespace get-quota [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace <namespace>

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : name of Namespace

ECS CLI Quick Reference 61

Documentation
 namespace get-ret-period

namespace get-ret-period
ECS Get Namespace Retention Period CLI usage.

Syntax

ecscli.py namespace get-ret-period [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace
<namespace> -class <classname>
[-format <format>]

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

• -class <classname>, -c <classname> : name of retention class

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

62 ECS CLI Quick Reference

Documentation
 namespace list

namespace list
ECS List Namespaces CLI usage.

Syntax

ecscli.py namespace list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-verbose] [-format <format>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -verbose, -v : List tenants with details

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 63

Documentation
 namespace list-ret

namespace list-ret
ECS Get Namespace Retention Classes CLI usage.

Syntax

ecscli.py namespace list-ret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace <namespace>
[-format <format>]

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

64 ECS CLI Quick Reference

Documentation
 namespace show

namespace show
ECS Show Namespace CLI usage.

Syntax

ecscli.py namespace show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-namespace <namespace> [-format <format>]

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 65

Documentation
 namespace update

namespace update
ECS Update Namespace CLI usage.

Syntax

ecscli.py namespace update [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace <namespace>
-objectvpool <objectvpool>
[-tenant <tenant>] -update <updatelist>
[-format <format>]

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

• -objectvpool <objectvpool>, -ovp <objectvpool> : name of Object Virtual Pool

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -t <tenant> : name of Tenant

• -update <updatelist>, -ud <updatelist> : repeatable key:value addition to

update list; update keys include: add_allowed, del_allowed, add_disallowed,
del_disallowed, namespace_admins

• -format <format>, -f <format> : response format: xml or json (default:json)

66 ECS CLI Quick Reference

Documentation
 namespace update-ret

namespace update-ret
ECS Update Namespace Retention Class CLI usage.

Syntax

ecscli.py namespace update-ret [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace
<namespace> -class <classname> -period
<period>

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

• -class <classname>, -c <classname> : name of retention class

• -period <period>, -p <period> : period of retention class

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 67

Documentation
 namespace update-quota

namespace update-quota
ECS Update Namespace Quota CLI usage.

Syntax

ecscli.py namespace update-quota [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -namespace
<namespace> -block <block>
-notification <notification>

Mandatory arguments
• -namespace <namespace>, -ns <namespace> : name of Namespace

• -block <block>, -blk <block> : block size in GB

• -notification <notification>, -not <notification> : notification size in GB

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

68 ECS CLI Quick Reference

Documentation
 nodes list

nodes list
get list of ECS datanodes information

Syntax

ecscli.py nodes list [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
[-format <format>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 69

Documentation
 objectuser create

objectuser create
ECS Objectuser Create CLI usage.

Syntax

ecscli.py objectuser create [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid> -namespace
NAMESPACE [-tag [TAGS [TAGS ...]]]
[-format <format>]

Mandatory arguments
• -uid <uid> : User identifier

• -namespace NAMESPACE, -ns NAMESPACE : Namespace for user.

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tag [TAGS [TAGS ...]], -tag [TAGS [TAGS ...]] : Space-delimited list of tags
associated with user

• -format <format>, -f <format> : response format: xml or json (default:json)

70 ECS CLI Quick Reference

Documentation
 objectuser delete

objectuser delete
ECS Objectuser Delete CLI usage.

Syntax

ecscli.py objectuser delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid> -namespace
<namespace> [-format <format>]

Mandatory arguments
• -uid <uid> : User identifier

• -namespace <namespace>, -ns <namespace> : Namespace for user.

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 71

Documentation
 objectuser get-lock

objectuser get-lock
ECS Objectuser get lock info CLI usage.

Syntax

ecscli.py objectuser get-lock [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-namespace <namespace>]
[-format <format>]

Mandatory arguments
• -uid <uid> : User identifier

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace identifier for user

• -format <format>, -f <format> : response format: xml or json (default:json)

72 ECS CLI Quick Reference

Documentation
 objectuser list

objectuser list
ECS Objectuser List CLI usage.

Syntax

ecscli.py objectuser list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-uid <uid>] [-namespace <namespace>]
[-format <format>]

Mandatory arguments
• -uid <uid>, -uid <uid> : User identifier. Required if scope is USER.

• -namespace <namespace>, -ns <namespace> : Namespace for user. Required if

scope is USER or NAMESPACE

• -format <format>, -f <format> : response format: xml or json (default:json)

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 73

Documentation
 objectuser lock

objectuser lock
ECS Objectuser Lock CLI usage.

Syntax

ecscli.py objectuser lock [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-uid <uid> -namespace <namespace>
[-format <format>]

Mandatory arguments
• -uid <uid> : User identifier

• -namespace <namespace>, -ns <namespace> : namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

74 ECS CLI Quick Reference

Documentation
 objectuser unlock

objectuser unlock
ECS Objectuser unlock CLI usage.

Syntax

ecscli.py objectuser unlock [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid> -namespace
<namespace> [-format <format>]

Mandatory arguments
• -uid <uid> : UID

• -namespace <namespace>, -ns <namespace> : namespace

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 75

Documentation
 objectvpool add

objectvpool add
ECS ObjectVPool Add CLI usage.

Syntax

ecscli.py objectvpool add [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-id <id> -mapping <mapping> [<mapping> ...]

Mandatory arguments
• -id <id> : id of object vpool

• -mapping <mapping> [<mapping> ...], -m <mapping> [<mapping> ...] : List of

varrayId-zoneId tuples e.g. list of VDC:Virtualarray

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

76 ECS CLI Quick Reference

Documentation
 objectvpool create

objectvpool create
ECS ObjectVPool Create CLI usage.

Syntax

ecscli.py objectvpool create [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -id <id> -name <name>
[-description <description>] -zonemapping
<zonemapping> [<zonemapping> ...]
-allowallnamespaces <allowAllNamespaces>
[-format <format>]

Mandatory arguments
• -id <id> : id of object vpool

• -name <name> : name identifying this classification of replication group

• -description <description>, -desc <description> : description of object vpool

• -zonemapping <zonemapping> [<zonemapping> ...], -zp <zonemapping>

[<zonemapping> ...] : List of varrayId-zoneId tuples e.g. list of Virtualarray:Vdc

• -allowallnamespaces <allowAllNamespaces>, -aan <allowAllNamespaces> :

indicates if vpool allows access to all Namespaces for dataservices

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 77

Documentation
 objectvpool delete

objectvpool delete
ECS ObjectVPool delete CLI usage.

Syntax

ecscli.py objectvpool delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -id <id>

Mandatory arguments
• -id <id> : id of object vpool

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

78 ECS CLI Quick Reference

Documentation
 objectvpool list

objectvpool list
ECS ObjectVPool List CLI usage

Syntax

ecscli.py objectvpool list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-verbose] [-long]
[-format <format>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -verbose, -v : List objectvpools with details

• -long, -l : List objectvpools with more details in tabular format

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 79

Documentation
 objectvpool remove

objectvpool remove
ECS ObjectVPool Remove CLI usage.

Syntax

ecscli.py objectvpool remove [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -id <id> -mapping
<mapping> [<mapping> ...]

Mandatory arguments
• -id <id> : id of object vpool

• -mapping <mapping> [<mapping> ...], -m <mapping> [<mapping> ...] : List of

varrayId-zoneId tuples e.g. list of VDC:Virtualarray

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

80 ECS CLI Quick Reference

Documentation
 objectvpool show

objectvpool show
ECS ObjectVPool show CLI usage.

Syntax

ecscli.py objectvpool show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -id <id>
[-format <format>]

Mandatory arguments
• -id <id> : id of object vpool

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 81

Documentation
 objectvpool update

objectvpool update
ECS ObjectVPool Update CLI usage.

Syntax

ecscli.py objectvpool update [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -id <id> -name <name>
-description <description>
-allowallnamespaces <allowAllNamespaces>

Mandatory arguments
• -id <id> : id of object vpool

• -name <name>, -n <name> : name to update

• -description <description>, -d <description> : Description to update

• -allowallnamespaces <allowAllNamespaces>, -aan <allowAllNamespaces> :

AllowAllNamespaces Boolean to update

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

82 ECS CLI Quick Reference

Documentation
 secretkeyuser add

secretkeyuser add
ECS Secretkeyuser User-Create CLI usage.

Syntax

ecscli.py secretkeyuser add [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-existingkeyexpiry <existingkeyexpiry>]

Mandatory arguments
• -existingkeyexpiry <existingkeyexpiry> : Key expiry in minutes

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 83

Documentation
 secretkeyuser delete

secretkeyuser delete
ECS secretkeyuser delete CLI usage.

Syntax

ecscli.py secretkeyuser delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid> -secretkey
<secretkey> [-namespace <namespace>]

Mandatory arguments
• -uid <uid> : UID

• -secretkey <secretkey>, -sk <secretkey> : Secret Key to delete

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace for user.

84 ECS CLI Quick Reference

Documentation
 secretkeyuser show

secretkeyuser show
ECS Secretkeyuser Show CLI usage.

Syntax

ecscli.py secretkeyuser show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -uid <uid>
[-namespace <namespace>]

Mandatory arguments
• -uid <uid> : UID

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -namespace <namespace>, -ns <namespace> : Namespace for user - sets

userscope to NAMESPACE.

ECS CLI Quick Reference 85

Documentation
 secretkeyuser user-delete

secretkeyuser user-delete
ECS secretkeyuser user-delete CLI usage.

Syntax

ecscli.py secretkeyuser user-delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -secretkey
<secretkey>

Mandatory arguments
• -secretkey <secretkey>, -sk <secretkey> : Secret Key to delete

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

86 ECS CLI Quick Reference

Documentation
 secretkeyuser user-show

secretkeyuser user-show
ECS Secretkeyuser User-Show CLI usage.

Syntax

ecscli.py secretkeyuser user-show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 87

Documentation
 system add-license

system add-license
ECS: CLI usage to add license

Syntax

ecscli.py system add-license [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -licensefile
<licensefile>

Mandatory arguments
• -licensefile <licensefile>, -lf <licensefile> : Name of the license file

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

88 ECS CLI Quick Reference

Documentation
 system connectemc-ftps

system connectemc-ftps
ECS: CLI usage of connect EMC by ftps

Syntax

ecscli.py system connectemc-ftps [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -ftpserver
<ftpserver>

Mandatory arguments
• -ftpserver <ftpserver>, -fsvr <ftpserver> : ftpserver

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 89

Documentation
 system connectemc-smtp

system connectemc-smtp
ECS: CLI usage of connect EMC by smtp

Syntax

ecscli.py system connectemc-smtp [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-format {xml,json,text/plain}]
-primaryemail <primaryemail>
-smtpserver <smtpserver> -senderemail
<senderemail>

Mandatory arguments
• -primaryemail <primaryemail>, -pm <primaryemail> : primaryemail

• -smtpserver <smtpserver>, -sms <smtpserver> : smtpserver

• -senderemail <senderemail>, -se <senderemail> : senderemail

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,

text/plain

90 ECS CLI Quick Reference

Documentation
 system deactivate-callhome

system deactivate-callhome
ECS: CLI usage to get ESRS callhome configuration

Syntax

ecscli.py system deactivate-callhome [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 91

Documentation
 system get-alerts

system get-alerts
ECS: CLI usage to get the alerts

Syntax

ecscli.py system get-alerts [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-severity <severity>]
[-start <start>] [-end <end>]
[-node <node_id>] [-regular <msg_regex>]
[-format {xml,json,text/plain}]
[-maxcount <maxcount>] -filepath <filepath>

Mandatory arguments
• -filepath <filepath>, -fp <filepath> : file path

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -severity <severity>, -sv <severity> : Any value from 0,4,5,7,8,9(FATAL, ERROR,

WARN, INFO, DEBUG, TRACE).

• -start <start>, -st <start> : start date in yyyy-mm-dd_hh:mm:ss format or in

milliseconds

• -end <end>, -en <end> : end date in yyyy-mm-dd_hh:mm:ss format or in

milliseconds

• -node <node_id>, -nd <node_id> : Node

• -regular <msg_regex>, -regex <msg_regex> : Message Regex

• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,

text/plain

92 ECS CLI Quick Reference

Documentation
 system get-alerts

• -maxcount <maxcount>, -mc <maxcount> : Maximum number of log messages

to retrieve

ECS CLI Quick Reference 93

Documentation
 system get-callhome-config

system get-callhome-config

ECS: CLI usage to get ESRS callhome configuration

Syntax

ecscli.py system get-callhome-config [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-format {xml,json,text/plain}]

Mandatory arguments
• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,
text/plain

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

94 ECS CLI Quick Reference

Documentation
 system get-license

system get-license
ECS: CLI usage to get license

Syntax

ecscli.py system get-license [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-format {xml,json,text/plain}]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,

text/plain

ECS CLI Quick Reference 95

Documentation
 system get-log-level

system get-log-level
ECS: CLI usage to get the logging level

Syntax

ecscli.py system get-log-level [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-logs <logs> [<logs> ...]]
[-nodes <nodes> [<nodes> ...]]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -logs <logs> [<logs> ...], -lg <logs> [<logs> ...] : Logs Name

• -nodes <nodes> [<nodes> ...], -nds <nodes> [<nodes> ...] : Nodes

96 ECS CLI Quick Reference

Documentation
 system get-logs

system get-logs
ECS: CLI usage to get the logs

Syntax

ecscli.py system get-logs [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-log <logname>] [-severity <severity>]
[-start <start>] [-end <end>]
[-node <node_id>] [-regular <msg_regex>]
[-format {xml,json,text/plain}]
[-maxcount <maxcount>] -filepath <filepath>

Mandatory arguments
• -filepath <filepath>, -fp <filepath> : file path

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -log <logname>, -lg <logname>: Log Name

• -severity <severity>, -sv <severity> : value from 0,4,5,7,8,9(FATAL, ERROR,

WARN, INFO, DEBUG, TRACE).

• -start <start>, -st <start> : start date in yyyy-mm-dd_hh:mm:ss format or in

milliseconds

• -end <end>, -en <end> : end date in yyyy-mm-dd_hh:mm:ss format or in

milliseconds

• -node <node_id>, -nd <node_id> : Node

• -regular <msg_regex>, -regex <msg_regex> : Message Regex

ECS CLI Quick Reference 97

Documentation
 system get-logs

• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,

text/plain

• -maxcount <maxcount>, -mc <maxcount> : Maximum number of log messages

to retrieve

98 ECS CLI Quick Reference

Documentation
 system get-properties

system get-properties
ECS: CLI usage to get properties

Syntax

ecscli.py system get-properties [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-type {ovf,config,mutated,obsolete,all}]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type {ovf,config,mutated,obsolete,all}, -t {ovf,config,mutated,obsolete,all} :

configuration property type.

ECS CLI Quick Reference 99

Documentation
 system get-properties-metadata

system get-properties-metadata
ECS: CLI usage to get properties metadata

Syntax

ecscli.py system get-properties-metadata [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

100 ECS CLI Quick Reference

Documentation
 system send-alert

system send-alert
ECS: CLI usage to send alert

Syntax

ecscli.py system send-alert [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-severity <severity>]
[-start <start>] [-end <end>]
[-node <node_id>] [-regular <msg_regex>]
[-format {xml,json,text/plain}]
[-maxcount <maxcount>]
[-src <target_version>]
[-eventid <event_id>] [-msg <message>]
[-contact <contact>] [-log <logname>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -severity <severity>, -sv <severity> : Any value from 0,4,5,7,8,9(FATAL, ERROR,

WARN, INFO, DEBUG, TRACE).

• -start <start>, -st <start> : start date in yyyy-mm-dd_hh:mm:ss format or in

milliseconds

• -end <end>, -en <end> : end date in yyyy-mm-dd_hh:mm:ss format or in

milliseconds

• -node <node_id>, -nd <node_id> : Node

• -regular <msg_regex>, -regex <msg_regex> : Message Regex

• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,

text/plain

ECS CLI Quick Reference 101

Documentation
 system send-alert

• -maxcount <maxcount>, -mc <maxcount> : Maximum number of log messages

to retrieve

• -src <target_version>, -source <target_version> : Send Alert

• -eventid <event_id>, -eid <event_id> : Event Id

• -msg <message>, -message <message> : Message

• -contact <contact>, -ct <contact> : Contact

• -log <logname>, -lg <logname> : Log Name

102 ECS CLI Quick Reference

Documentation
 system set-log-level

system set-log-level
ECS: CLI usage to set the logging level

Syntax

ecscli.py system set-log-level [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
[-severity <severity>]
[-logs <logs> [<logs> ...]]
[-nodes <nodes> [<nodes> ...]]
[-expiretime <expiretime>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -severity <severity>, -sv <severity> : Any value from 0,4,5,7,8,9(FATAL, ERROR,

WARN, INFO, DEBUG, TRACE).

• -logs <logs> [<logs> ...], -lg <logs> [<logs> ...] : Logs Name

• -nodes <nodes> [<nodes> ...], -nds <nodes> [<nodes> ...] : Nodes

• -expiretime <expiretime>, -ext <expiretime> : log level expiration time in

minutes

ECS CLI Quick Reference 103

Documentation
 system set-properties

system set-properties
ECS: CLI usage to set properties

Syntax

ecscli.py system set-properties [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>]
(-propertyfile <propertyfile> | -property
name <propertyname>)
[-propertyvaluefile <propertyvaluefile>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -propertyfile <propertyfile>, -pf <propertyfile> : property file

• -propertyname <propertyname>, -pn <propertyname> : property name

• -propertyvaluefile <propertyvaluefile>, -pvf <propertyvaluefile> : property value

file

104 ECS CLI Quick Reference

Documentation
 tenant add-attribute

tenant add-attribute
ECS Tenant add attribute CLI usage.

Syntax

ecscli.py tenant add-attribute [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-name <tenantname>]
[-key <key>] [-value <value>] -domain
<domain>

Mandatory arguments
• -domain <domain> : domain

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile. -name

<tenantname>, -n <tenantname> : Name of Tenant

• -key <key> : key of AD attribute to map to tenant

• -value <value> : value of AD attribute to map to tenant

ECS CLI Quick Reference 105

Documentation
 tenant add-group

tenant add-group
ECS Tenant Create CLI usage.

Syntax

ecscli.py tenant add-group [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-name tenantname]
[-group <group>] [-domain <domain>]

Mandatory arguments
• -group <group> : group

• -domain <domain> : domain

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -name tenantname, -n tenantname : Name of Tenant

106 ECS CLI Quick Reference

Documentation
 tenant add-role

tenant add-role
ECS Tenant role update CLI usage.

Syntax

ecscli.py tenant add-role [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name tenantname -role
{TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER}
(-subject-id subjectid | -group group)

Mandatory arguments
• -name tenantname, -n tenantname : name of Tenant

• -role {TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER}, -r
{TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER} : Role of Tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -subject-id subjectid, -sb subjected : Subject ID

• -group group, -g group : Group

ECS CLI Quick Reference 107

Documentation
 tenant create

tenant create
ECS Tenant role update CLI usage.

Syntax

ecscli.py tenant add-role [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name tenantname -role
{TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER}
(-subject-id subjectid | -group group)

Mandatory arguments
• -name tenantname, -n tenantname : name of Tenant

• -role {TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER}, -r
{TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER} : Role of Tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -subject-id subjectid, -sb subjected : Subject ID

• -group group, -g group : Group

108 ECS CLI Quick Reference

Documentation
 tenant delete

tenant delete
ECS Tenant Delete CLI usage.

Syntax

ecscli.py tenant delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name tenantname

Mandatory arguments
• -name tenantname, -n tenantname : name of Tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

ECS CLI Quick Reference 109

Documentation
 tenant delete-role

tenant delete-role
ECS Tenant role delete CLI usage.

Syntax

ecscli.py tenant delete-role [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name tenantname -role
{TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER}
(-subject-id subjectid | -group group)

Mandatory arguments
• -name tenantname, -n tenantname : name of Tenant

• -role {TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER}, -r
{TENANT_ADMIN,PROJECT_ADMIN,TENANT_APPROVER} : Role of Tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile. -subject-id

subjectid, -sb subjected : Subject ID

• -group group, -g group : Group

110 ECS CLI Quick Reference

Documentation
 tenant get-clusters

tenant get-clusters
ECS Get Hosts CLI usage.

Syntax

ecscli.py tenant get-clusters [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-tenant <tenant>]
[-long] [-verbose]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -tn <tenant> : name of Tenant

• -long, -l : List vcenters with more details in tabular form

• -verbose, -v : List vcenters with details

ECS CLI Quick Reference 111

Documentation
 tenant get-hosts

tenant get-hosts
ECS Get Hosts CLI usage.

Syntax

ecscli.py tenant get-hosts [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-tenant <tenant>]
[-long] [-verbose]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -tn <tenant> : name of Tenant

• -long, -l : List vcenters with more details in tabular form

• -verbose, -v : List vcenters with details

112 ECS CLI Quick Reference

Documentation
 tenant get-role

tenant get-role
ECS Tenant role display CLI usage.

Syntax

ecscli.py tenant get-role [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name tenantname [-xml]

Mandatory arguments
• -name tenantname, -n tenantname : name of Tenant

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -xml : XML response

ECS CLI Quick Reference 113

Documentation
 tenant get-vcenters

tenant get-vcenters
ECS Get Vcenters CLI usage.

Syntax

ecscli.py tenant get-vcenters [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-tenant <tenant>]
[-long] [-verbose]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -tn <tenant> : name of Tenant

• -long, -l : List vcenters with more details in tabular form

• -verbose, -v : List vcenters with details

114 ECS CLI Quick Reference

Documentation
 tenant list

tenant list
ECS Tenant List CLI usage.

Syntax

ecscli.py tenant list [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
[-verbose] [-long]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -verbose, -v : List tenants with details

• -long, -l : List tenants with more details in tabular format

ECS CLI Quick Reference 115

Documentation
 tenant remove-attribute

tenant remove-attribute
ECS Tenant remove attribute CLI usage.

Syntax

ecscli.py tenant remove-attribute [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-name tenantname]
-key key -value value -domain
<domain>

Mandatory arguments
• -key key : key of AD attribute to map to tenant

• -value value : value of AD attribute to map to tenant

• -domain <domain> : domain

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -name tenantname, -n tenantname : Name of Tenant

116 ECS CLI Quick Reference

Documentation
 tenant show

tenant show
ECS Tenant Show CLI usage.

Syntax

ecscli.py tenant show [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
[-name tenantname] [-xml]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -name tenantname, -n tenantname : name of Tenant

• -xml : XML response

ECS CLI Quick Reference 117

Documentation
 tenant update-quota

tenant update-quota
ECS Tenant Update CLI usage.

Syntax

ecscli.py tenant update-quota [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] [-tn <tenant>]
[-quota_enable {true,false}]
[-quota_capacity <quota_capacity>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tn <tenant>, -tenant <tenant> : Name of Tenant

• -quota_enable {true,false}, -qe {true,false} : Boolean value to enable/disable

quota

• -quota_capacity <quota_capacity>, -qc <quota_capacity> : Quota capacity in GB

118 ECS CLI Quick Reference

Documentation
 varray create

varray create
ECS varray Create CLI usage.

Syntax

ecscli.py varray create [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <varrayname> [-format <format>]
[-isProtected <isProtected>]
[-description <description>]

Mandatory arguments
• -name <varrayname>, -name <varrayname> : Name of varray

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

• -isProtected <isProtected>, -protect <isProtected> : true or false whether the

varray has native protection

• -description <description>, -d <description> : user help description

ECS CLI Quick Reference 119

Documentation
 varray delete

varray delete
ECS varray Delete CLI usage.

Syntax

ecscli.py varray delete [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name NAME [-format <format>]

Mandatory arguments
• -name NAME, -name NAME : name (or URI) of varray. URI will be used
directly. name will be used to retrieve URI

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -format <format>, -f <format> : response format: xml or json (default:json)

120 ECS CLI Quick Reference

Documentation
 varray list

varray list
ECS varray List CLI usage.

Syntax

ecscli.py varray list [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
[-uri URI] [-format {xml,json,text/plain}]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -uri URI, -uri URI : varray URI

• -format {xml,json,text/plain}, -fm {xml,json,text/plain} : Response: xml, json,

text/plain

ECS CLI Quick Reference 121

Documentation
 varray update

varray update
ECS update varray CLI usage.

Syntax

ecscli.py varray update [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
(-currentname CURRENTNAME | -uri URI)
[-format <format>] [-newname NEWNAME]
-isProtected <isProtected> -description
<description>

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -currentname CURRENTNAME, -cn CURRENTNAME : current name of varray.

Either this or URI is required

• -uri URI, -uri URI : current URI of varray. Either this or current name is required

• -format <format>, -f <format> : response format: xml or json (default:json)

• -newname NEWNAME, -nn NEWNAME : new name if the varray is being

renamed

• -isProtected <isProtected>, -protect <isProtected> : true or false whether the

varray has native protection. Will default to current value

• -description <description>, -d <description> : general description of varray

usage

122 ECS CLI Quick Reference

Documentation
 vdc delete

vdc delete
ECS VirtualDataCenter delete CLI usage

Syntax

ecscli.py vdc delete [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
(-vdcid VDCID | -name NAME)

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -vdcid VDCID, -vdcid VDCID : URI id of VirtualDataCenter

• -name NAME, -name NAME : common name of VirtualDataCenter

ECS CLI Quick Reference 123

Documentation
 vdc insert

vdc insert
ECS VirtualDataCenter delete CLI usage

Syntax

ecscli.py vdc delete [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
(-vdcid VDCID | -name NAME)

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -vdcid VDCID, -vdcid VDCID : URI id of VirtualDataCenter

• -name NAME, -name NAME : common name of VirtualDataCenter

124 ECS CLI Quick Reference

Documentation
 vdc list

vdc list
ECS VirtualDataCenter list CLI usage

Syntax

ecscli.py vdc list [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
(-name NAME | -vdcid VDCID) [-format <format>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -name NAME, -name NAME : name of vdc. Either this or vdc id is required

• -vdcid VDCID, -vdcid VDCID : current id of vdc. Either this or current name is
required

• -format <format>, -f <format> : response format: xml or json (default:json)

ECS CLI Quick Reference 125

Documentation
 vdc_data insert

vdc_data insert
ECS Data VirtualDataCenter insert CLI usage

Syntax

ecscli.py vdc_data insert [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <vdc_dataname> -key <key> -dataip
<dataip> -cmdip <cmdip>

Mandatory arguments
• -name <vdc_dataname>, -n <vdc_dataname> : Name of VirtualDataCenter

• -key <key>, -k <key> : the secure key of the VirtualDataCenter

• -dataip <dataip>, -dip <dataip> : the IP of the Geo data endpoint to be added

• -cmdip <cmdip>, -cip <cmdip> : the IP of the Geo Commands endpoint

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

126 ECS CLI Quick Reference

Documentation
 vdc_data list

vdc_data list
ECS Data VirtualDataCenter list CLI usage

Syntax

ecscli.py vdc_data list [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-verbose] [-long]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -verbose, -v : Lists VirtualDataCenter with details

• -long, -l : Lists VirtualDataCenter in a large table

ECS CLI Quick Reference 127

Documentation
 vdc_data local

vdc_data local
ECS Data VirtualDataCenter local CLI usage

Syntax

ecscli.py vdc_data local [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-xml]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -xml : XML response

128 ECS CLI Quick Reference

Documentation
 vdc_data show

vdc_data show
ECS Data VirtualDataCenter show CLI usage

Syntax

ecscli.py vdc_data show [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
[-xml] -name <vdc_dataname>

Mandatory arguments
• -name <vdc_dataname>, -n <vdc_dataname> : Name of virtual datacenter

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -xml : XML response

ECS CLI Quick Reference 129

Documentation
 vpool add_pools

vpool add_pools
ECS VPOOL add storage pools CLI usage

Syntax

ecscli.py vpool add_pools [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <vpoolname> -pools <pools>
[<pools> ...] [-type <vpooltype>]
-serialnumber <serialnumber> -devicetype
{isilon,vnxblock,vnxfile,vmax,netapp,vplex,hds,
openstack,scaleio,xtremio,ddmc}

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

• -pools <pools> [<pools> ...] : Pools to be added

• -serialnumber <serialnumber>, -sn <serialnumber> : Native GUID of Storage

System

• -devicetype {isilon, vnxblock, vnxfile, vmax, netapp, vplex, hds, openstack,

scaleio, xtremio, ddmc}, -dt{isilon, vnxblock, vnxfile, vmax, netapp, vplex,
hds, openstack, scaleio, xtremio, ddmc} : device type

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

130 ECS CLI Quick Reference

Documentation
 vpool allow

vpool allow
ECS VPOOL Allow Tenant CLI usage

Syntax

ecscli.py vpool allow [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
-name <vpoolname> [-tenant <tenant>]
[-type <vpooltype>]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -tn <tenant> : Name of the Tenant

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

ECS CLI Quick Reference 131

Documentation
 vpool create

vpool create
ECS VPOOL Create cli usage

Syntax

ecscli.py vpool create [-h] [-hostname <hostname>]

[-port <port_number>] [-portui <ui_port_number>]
[-cf <cookiefile>] -name <vpoolname> -protocol
<protocol> [<protocol> ...] -varrays <varrays>
[<varrays> ...] [-maxsnapshots <max_snapshots>]
[-maxcontinuouscopies <max_continous_copies>]
[-continuouscopiesvpool <continuouscopies_vpool>]
[-provisiontype <provisiontype>]
[-ha <highavailability>] [-rp <rp> [<rp> ...]]
[-rp_source_policy <rp_source_policy>]
[-systemtype <systemtype>]
[-raidlevel <raidlevel> [<raidlevel> ...]]
[-fastpolicy <fastpolicy>]
[-drivetype <drivetype>] [-type <vpooltype>]
-description <description>
[-usematchedpools <useMatchedPools>]
[-multivolconsistency]
[-expandable <expandable>]
[-fastexpansion <fastexpansion>]
[-autotierpolicynames <unique_auto_tier_policy_names>]
[-maxpaths <MaxPaths>] [-minpaths <MinPaths>]
[-thinpreallocper <thinpreallocper>]
[-pathsperinitiator <PathsPerInitiator>]
[-srdf <srdf> [<srdf> ...]]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : Name of VPOOL

• -protocol <protocol> [<protocol> ...], -pl <protocol> [<protocol> ...] : Protocol used
{NFS,CIFS for file; FC, iSCSI for block

• -varrays <varrays> [<varrays> ...], -va <varrays> [<varrays> ...] : varrays

• -description <description>, -desc <description> : Description of VPOOL

132 ECS CLI Quick Reference

Documentation
 vpool create

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -maxsnapshots <max_snapshots>, -msnp <max_snapshots> : Maximum

number of native snapshots

• -maxcontinuouscopies <max_continous_copies>, -mcc

<max_continous_copies> : Maximum number of native continuous copies

• -continuouscopiesvpool <continuouscopies_vpool>, -ccv

<continuouscopies_vpool> : vpool for continuous copies

• -provisiontype <provisiontype>, -pt <provisiontype> : Provision type Values can

be Thin or Thick(mandatory for block VPOOL)

• -ha <highavailability> : high availability eg:hatype:varray:vpool:enableRP

• -rp <rp> [<rp> ...] : RP protection copies parameters, eg:varray:vpool:journalsize

• -rp_source_policy <rp_source_policy>, -rp_policy <rp_source_policy> : RP

protection source policy, eg:journalsize:copymode:rpovalue:rpotype

• -systemtype <systemtype>, -st <systemtype> : Supported System Types

• -raidlevel <raidlevel> [<raidlevel> ...], -rl <raidlevel> [<raidlevel> ...] : Possible

values RAID1, RAID2, RAID3, RAID4, RAID5, RAID6, RAID10

• -fastpolicy <fastpolicy>, -fp <fastpolicy> : Auto-Tiering Policy Name can be

specified, only if SystemType is specified

• -drivetype <drivetype>, -dt <drivetype> : Supported Drive Types

• -type <vpooltype>, -t <vpooltype> : Type of the VPOOL (default:file)

• -usematchedpools <useMatchedPools>, -ump <useMatchedPools> : VPOOL

uses matched pools

• -multivolconsistency, -mvc : multi volume consistency

• -expandable <expandable>, -ex <expandable> : Indicates if non-disruptive

volume expansion should be supported

ECS CLI Quick Reference 133

Documentation
 vpool create

• -fastexpansion <fastexpansion>, -fe <fastexpansion> : Indicates that vpool

volumes should use concatenated meta volumes not striped

• -autotierpolicynames <unique_auto_tier_policy_names>, -apn

<unique_auto_tier_policy_names> : unique_auto_tier_policy_names for
fastpolicy

• -maxpaths <MaxPaths>, -mxp <MaxPaths> : The maximum number of paths

that can be used between a host and a storage volume

• -minpaths <MinPaths>, -mnp <MinPaths> : The minimum number of paths that

can be used between a host and a storage volume

• -thinpreallocper <thinpreallocper>, -tpap <thinpreallocper> : Thin volume pre-

allocation percentage

• -pathsperinitiator <PathsPerInitiator>, -ppi <PathsPerInitiator> : The number of

paths per initiator

• -srdf <srdf> [<srdf> ...] : VMAX SRDF protection parameters,

eg:varray:vpool:policy

134 ECS CLI Quick Reference

Documentation
 vpool delete

vpool delete
ECS VPOOL Delete CLI usage

Syntax

ecscli.py vpool delete [-h] [-hostname <hostname>]

[-port <port_number>] [-portui <ui_port_number>]
[-cf <cookiefile>] -name <vpoolname>
[-type <vpooltype>]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of the VPOOL (default:file)

ECS CLI Quick Reference 135

Documentation
 vpool disallow

vpool disallow
ECS VPOOL disallow Tenant CLI usage

Syntax

ecscli.py vpool disallow [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <vpoolname> [-tenant <tenant>]
[-type <vpooltype>]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -tenant <tenant>, -tn <tenant> : Name of the Tenant

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

136 ECS CLI Quick Reference

Documentation
 vpool get_pools

vpool get_pools
ECS VPOOL Get storage pools CLI usage

Syntax

ecscli.py vpool get_pools [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>] [-cf <cookiefile>]
-name <vpoolname> [-type <vpooltype>]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

ECS CLI Quick Reference 137

Documentation
 vpool list

vpool list
ECS VPOOL List CLI usage

Syntax

ecscli.py vpool list [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
[-type <vpooltype>] [-v] [-long]
[-vdcname <vdcname>]

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL

• -v, -verbose : List VPOOL with details

• -long, -l : List VPOOL with details in table format

• -vdcname <vdcname>, -vn <vdcname> : shortID of VirtualDataCenter

138 ECS CLI Quick Reference

Documentation
 vpool refresh_pools

vpool refresh_pools
ECS VPOOL refresh storage pools CLI usage

Syntax

ecscli.py vpool refresh_pools [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <vpoolname>
[-type <vpooltype>]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

ECS CLI Quick Reference 139

Documentation
 vpool remove_pools

vpool remove_pools
ECS VPOOL remove storage pools CLI usage

Syntax

ecscli.py vpool remove_pools [-h] [-hostname <hostname>]

[-port <port_number>]
[-portui <ui_port_number>]
[-cf <cookiefile>] -name <vpoolname>
-pools <pools> [<pools> ...]
[-type <vpooltype>] -serialnumber
<serialnumber> -devicetype
{isilon, vnxblock, vnxfile, vmax, netapp,
vplex, hds, openstack, scaleio, xtremio, ddmc}

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

• -pools <pools> [<pools> ...] : Pools to be removed

• -serialnumber <serialnumber>, -sn <serialnumber> : Native GUID of Storage

System

• -devicetype {isilon, vnxblock, vnxfile, vmax, netapp, vplex, hds, openstack

,scaleio, xtremio, ddmc}, -dt {isilon, vnxblock, vnxfile, vmax, netapp, vplex,
hds, openstack, scaleio, xtremio, ddmc} : device type

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

140 ECS CLI Quick Reference

Documentation
 vpool show

vpool show
ECS VPOOL Show CLI usage

Syntax

ecscli.py vpool show [-h] [-hostname <hostname>] [-port <port_number>]

[-portui <ui_port_number>] [-cf <cookiefile>]
-name <vpoolname> [-type <vpooltype>] [-xml]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : name of VPOOL

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -type <vpooltype>, -t <vpooltype> : Type of VPOOL (default:file)

• -xml : XML response

ECS CLI Quick Reference 141

Documentation
 vpool update

vpool update
ECS VPOOL Update cli usage

Syntax

ecscli.py vpool update [-h] [-hostname <hostname>]

[-port <port_number>] [-portui <ui_port_number>]
[-cf <cookiefile>] -name <vpoolname>
[-protocol_add <protocol_add> [<protocol_add> ...]
| -protocol_remove <protocol_remove>
[<protocol_remove> ...]]
[-varray_add <varray_add> [<varray_add> ...] |
-varray_remove <varray_remove>
[<varray_remove> ...]]
[-usematchedpools <useMatchedPools>]
[-label <label>] [-ha <highavailability>]
[-maxsnapshots <max_snapshots>]
[-maxcontinuouscopies <maxcontinuouscopies>]
[-type <vpooltype>] [-description <description>]
[-multivolconsistency <multivolconsistency>]
[-expandable <expandable>]
[-fastexpansion <fastexpansion>]
[-fastpolicy <fastpolicy>]
[-autotierpolicynames <unique_auto_tier_policy_names>]
[-maxpaths <MaxPaths>] [-minpaths <MinPaths>]
[-pathsperinitiator <PathsPerInitiator>]
[-thinpreallocper <thinpreallocper>]
[-srdf_add <srdfadd> [<srdfadd> ...]]
[-srdf_remove <srdfremove> [<srdfremove> ...]]
[-rp_add <rp_add> [<rp_add> ...]]
[-rp_remove <rp_remove> [<rp_remove> ...]]
[-rp_source_policy <rp_source_policy>]
[-quota_enable {true,false}]
[-quota_capacity <quota_capacity>]

Mandatory arguments
• -name <vpoolname>, -n <vpoolname> : Name of VPOOL

142 ECS CLI Quick Reference

Documentation
 vpool update

Optional arguments
• -h, --help : show this help message and exit.

• -hostname <hostname>, -hn <hostname> : hostname (fully qualified domain

name) or IPv4 address (for example: 192.0.2.0) or IPv6 address inside quotes
and brackets (for example: "[2001:db8::1]") of ECS.

• -port <port_number>, -po <port_number> : port number of ECS.

• -portui <ui_port_number>, -pu <ui_port_number> : https port number of ECS

Portal UI.

• -cf <cookiefile>, -cookiefile <cookiefile> : Full name of cookiefile.

• -protocol_add <protocol_add> [<protocol_add> ...], -pa <protocol_add>

[<protocol_add> ...] : Protocol to be added to VPOOL

• -protocol_remove <protocol_remove> [<protocol_remove> ...], -prm

<protocol_remove> [<protocol_remove> ...] : Protocol to be removed from
VPOOL

• -varray_add <varray_add> [<varray_add> ...], -va_add <varray_add>

[<varray_add...] : varray to be added to VPOOL

• -varray_remove <varray_remove> [<varray_remove> ...], -va_rm <varray_remove>

[

• <varray_remove> ...] : varray to be removed from VPOOL

• -usematchedpools <useMatchedPools>, -ump <useMatchedPools> : VPOOL

uses matched pools

• -label <label>, -l <label> : New name for VPOOL

• -ha <highavailability> : high availability eg:hatype:varray:vpool:enableRP

• -maxsnapshots <max_snapshots>, -msnp <max_snapshots> : Maximum

number of native snapshots

• -maxcontinuouscopies <maxcontinuouscopies>, -mcc <maxcontinuouscopies>

: Max number of native continuous copies

• -type <vpooltype>, -t <vpooltype> : Type of the VPOOL (default:file)

• -description <description>, -desc <description> : Description of VPOOL

• -multivolconsistency <multivolconsistency>, -mvc <multivolconsistency> : multi

volume consistency

• -expandable <expandable>, -ex <expandable> : True/False Indicates if non-

disruptive volume expansion should be supported

ECS CLI Quick Reference 143

Documentation
 vpool update

• -fastexpansion <fastexpansion>, -fe <fastexpansion> : Indicates that vpool

volumes should use concatenated meta volumes not striped

• -fastpolicy <fastpolicy>, -fp <fastpolicy> : Fast policy Name can be specified

• -autotierpolicynames <unique_auto_tier_policy_names>, -apn

<unique_auto_tier_policy_names> : True/False to select unique auto tier
policy names for fastpolicy

• -maxpaths <MaxPaths>, -mxp <MaxPaths> : The maximum number of paths

that can be used between a host and a storage volume

• -minpaths <MinPaths>, -mnp <MinPaths> : The minimum number of paths that

can be used between a host and a storage volume

• -pathsperinitiator <PathsPerInitiator>, -ppi <PathsPerInitiator> : The number of

paths per initiator

• -thinpreallocper <thinpreallocper>, -tpap <thinpreallocper> : Thin volume pre-

allocation percentage

• -srdf_add <srdfadd> [<srdfadd> ...] : VMAX SRDF protection parameters,

eg:varray:vpool:policy

• -srdf_remove <srdfremove> [<srdfremove> ...] : VMAX SRDF protection

parameters, eg:varray:vpool:policy

• -rp_add <rp_add> [<rp_add> ...] : RP protection parameters,

eg:varray:vpool:journalsize

• -rp_remove <rp_remove> [<rp_remove> ...] : RP protection parameters,

eg:varray:vpool:journalsize

• -rp_source_policy <rp_source_policy>, -rp_policy <rp_source_policy> : RP

protection source policy, eg:journalsize:copymode:rpovalue:rpotype

• -quota_enable {true,false}, -qe {true,false} : Boolean value to enable/disable

quota

• -quota_capacity <quota_capacity>, -qc <quota_capacity> : Quota capacity in GB

144 ECS CLI Quick Reference

Documentation