Home » Dell Manuals » Storage Devices » Dell PowerStore 5000X » Manual Viewer

Dell PowerStore 5000X EMC PowerStore CLI Guide - Page 7

Object types, Object qualifiers, Actions, Action qualifiers, Example 1

View all Dell PowerStore 5000X manuals

Add to My Manuals
Save this manual to your list of manuals

Page 7 highlights

View the switches provides details on all available switches. Object types Object types identify the type of entity on which to perform an action, such as a local_user, host, volume, or cluster. All actions require an object type. The one exception is the -help switch, which can be used without an object type. Get help explains how to use the -help switch. The object instance on which you perform an action is designated by an identifier that is called an object qualifier, as explained in Object qualifiers. Example 1 In the following example for creating a user, the object type is local_user: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user create -name user1 -password Password789! -role_id operator Example 2 The following example for viewing all user accounts on the system shows that the object type is also local_user. An object identifier is not specified, so the show action displays a list of all user accounts: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user show Object qualifiers Object qualifiers are unique identifiers for objects on the system. Object qualifiers are displayed in the following format: • -id • -name All object types have identifiers that can be used as qualifiers to specify a unique object instance. Some object types have names. For object types that have names, the name qualifier can be used as an alternate to the ID qualifier. When you create an object, such as a user or network interface, it receives an ID, which is the primary object qualifier for that object. The uniqueness of the ID is only guaranteed in the scope of the specified object type. When performing actions such as viewing, modifying, or deleting an object, you specify an object qualifier. All object qualifiers start with a hyphen (-). Example In the following example for changing the password of a user account, the object type is local_user, and the qualifier that is used is name, with a value of operator: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user -name operator set -password NewPassword123! -current_password MyPassword456! Actions Actions are the operations that are performed on an object instance or object type, including creating, modifying, viewing, and deleting. Actions are always required. Action commands provides details on each of the action commands. Example In the following example for changing the password of a user account, the action is set: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user -name operator set -password NewPassword456! -current_password OldPassword456! Action qualifiers Action qualifiers are parameters specific to actions, such as attributes or settings to modify when changing an object. All action qualifiers start with a hyphen (-). Introduction 7

Section	Page
PowerStore_CLI_Guide_Introduction	1
Dell EMC PowerStore CLI Guide	3
Additional Resources	4
Introduction	5
Overview	5
Use PowerStore CLI in scripts	5
Set up the PowerStore CLI client	5
Install the PowerStore CLI client	5
Launch the PowerStore CLI client	6
Certificate verification	6
PowerStore CLI command syntax	6
Executable	6
Switches	6
Object types	7
Object qualifiers	7
Actions	7
Action qualifiers	7
Size qualifiers	8
Action commands	8
The create action command	8
The set action command	9
The show action command	9
The delete action command	11
Get help	11
Help on the PowerStore CLI client	11
Help on object types	11
Help on actions	12
Manage SSL certificates	13
View the switches	13
Access the system	14
Display the header	14
Save PowerStore CLI settings	15
CLI_Reference	16
Compute	16
Table of Contents	16
Compute	28
discovered_initiator	28
show	28
host	29
show	31
create	34
delete	35
set	35
attach	37
detach	38
host_group	38
show	39
create	41
delete	42
set	42
attach	43
detach	43
host_virtual_volume_mapping	44
show	44
host_volume_mapping	47
show	48
vcenter	51
show	51
create	52
delete	53
set	53
virtual_machine	54
show	56
delete	60
set	61
snapshot	61
Migration	62
import_host_initiator	62
show	63
import_host_system	64
show	66
create	68
delete	69
refresh	70
import_host_volume	70
show	72
import_psgroup	74
show	75
discover	77
import_psgroup_volume	77
show	79
import_snapshot_schedules	81
import_session	82
show	85
create	89
delete	90
set	90
cancel	91
cleanup	91
cutover	92
pause	92
resume	93
import_storage_center	93
show	94
discover	97
import_storage_center_consistency_group	97
show	98
import_snapshot_profiles	101
import_storage_center_volume	101
show	103
import_snapshot_profiles	106
import_unity	106
show	108
discover	111
import_unity_consistency_group	111
show	112
import_snapshot_schedules	114
import_unity_volume	115
show	117
import_snapshot_schedules	120
import_vnx_array	120
show	122
discover	124
import_vnx_consistency_group	124
show	126
import_vnx_volume	128
show	131
migration_recommendation	134
show	139
create	140
delete	141
create_migration_sessions	141
start_migration_sessions	142
migration_session	142
show	144
create	149
delete	150
cutover	151
pause	151
resume	151
sync	152
Monitoring	153
alert	153
show	155
set	157
event	157
show	158
job	160
show	167
metrics	173
generate	173
Protection	176
policy	176
show	177
create	184
delete	185
set	185
remote_system	186
show	188
create	192
delete	195
set	196
verify	197
replication_rule	197
show	198
create	201
delete	201
set	202
replication_session	203
show	205
failover	209
pause	210
reprotect	211
resume	212
sync	212
snapshot_rule	213
show	214
create	216
delete	217
set	217
Settings	218
audit_event	218
show	220
chap_config	222
show	222
set	223
dns	224
show	224
set	225
email_notify_destination	226
show	226
create	227
delete	228
set	228
test	229
ip_pool_address	229
show	230
ip_port	233
show	234
set	239
keystore_archive	240
regenerate	240
download	240
license	240
show	241
retrieve	242
upload	243
local_user	243
show	244
create	245
delete	245
set	246
login_session	247
show	247
network	248
show	249
set	251
replace	253
scale	255
ntp	256
show	257
set	258
physical_switch	258
show	259
create	260
delete	262
set	262
role	263
show	264
security_config	265
show	265
smtp_config	266
show	266
set	267
test	268
software_installed	268
show	269
software_package	270
show	272
create	274
delete	274
install	274
puhc	275
x509_certificate	276
show	278
decommission	279
exchange	280
Storage	281
file_dns	281
show	282
create	284
delete	285
set	285
file_ftp	286
show	288
create	291
delete	294
set	294
file_interface	297
show	298
create	301
delete	302
set	302
file_interface_route	303
show	305
create	306
delete	307
set	308
file_kerberos	308
show	309
create	311
delete	312
set	312
upload_keytab	313
download_keytab	313
file_ldap	314
show	316
create	319
delete	321
set	322
upload_certificate	324
upload_config	324
download_certificate	325
download_config	325
file_ndmp	325
show	326
create	328
delete	328
set	329
file_nis	329
show	330
create	332
delete	333
set	333
file_system	334
show	339
create	345
delete	348
set	349
clone	352
refresh	355
refresh_quota	355
restore	356
snapshot	356
file_tree_quota	359
show	361
create	365
delete	365
set	366
refresh	367
file_user_quota	367
show	368
create	372
set	373
refresh	374
file_virus_checker	374
show	375
create	377
delete	377
set	378
upload_config	378
download_config	379
nas_server	379
show	382
create	390
delete	391
set	392
ping	393
update_user_mappings	394
nas_server/download	394
group	394
homedir	395
hosts	395
netgroup	396
nsswitch	396
ntxmap	397
passwd	397
user_mapping_report	397
nas_server/upload	398
group	398
homedir	398
hosts	399
netgroup	399
nsswitch	400
ntxmap	400
passwd	401
nfs_export	401
show	403
create	407
delete	409
set	409
nfs_server	413
show	414
create	417
delete	418
set	418
join	420
unjoin	420
performance_rule	421
show	421
smb_server	423
show	424
create	426
delete	428
set	428
join	429
unjoin	430
smb_share	431
show	432
create	436
delete	437
set	438
storage_container	439
show	439
create	442
delete	442
set	443
mount	443
unmount	444
virtual_volume	444
show	447
delete	455
volume	456
show	460
create	464
delete	465
set	466
attach	467
clone	467
detach	468
refresh	469
restore	470
snapshot	471
volume_group	472
show	476
create	480
delete	480
set	481
add_members	482
clone	483
refresh	484
remove_members	485
restore	486
snapshot	487
Support	487
maintenance_window	488
show	488
set	490
service_config	490
show	491
set	492
service_user	492
show	493
set	493
System and Hardware	494
appliance	494
show	495
set	503
forecast	504
time_to_full	504
bond	505
show	506
cluster	509
show	510
set	511
forecast	512
time_to_full	512
eth_port	513
show	517
set	524
fc_port	525
show	529
set	534
hardware	535
show	541
set	552
drive_repurpose	553
node	553
show	554
sas_port	556
show	558
veth_port	562

Match case Limit results 1 per page

View the switches

provides details on all available switches.

Object types

Object types identify the type of entity on which to perform an action, such as a

local_user

host

volume

, or

cluster

. All actions

require an object type. The one exception is the

-help

switch, which can be used without an object type.

Get help

explains how to use

the

-help

switch.

The object instance on which you perform an action is designated by an identifier that is called an object qualifier, as explained in

Object

qualifiers

Example 1

In the following example for creating a user, the object type is

local_user

pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user create –name user1 –password

Password789! –role_id operator

Example 2

The following example for viewing all user accounts on the system shows that the object type is also

local_user

. An object identifier is

not specified, so the

show

action displays a list of all user accounts:

pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user show

Object qualifiers

Object qualifiers are unique identifiers for objects on the system. Object qualifiers are displayed in the following format:

•

-id <

value

•

-name <

value

All object types have identifiers that can be used as qualifiers to specify a unique object instance. Some object types have names. For

object types that have names, the name qualifier can be used as an alternate to the ID qualifier.

When you create an object, such as a user or network interface, it receives an ID, which is the primary object qualifier for that object. The

uniqueness of the ID is only guaranteed in the scope of the specified object type. When performing actions such as viewing, modifying, or

deleting an object, you specify an object qualifier. All object qualifiers start with a hyphen (-).

Example

In the following example for changing the password of a user account, the object type is local_user, and the qualifier that is used is

name

, with a value of

operator

pstcli -d 10.0.0.1 -u admin -p

MyPassword456!

local_user -name

operator

set –password

NewPassword123!

–current_password

MyPassword456!

Actions

Actions are the operations that are performed on an object instance or object type, including creating, modifying, viewing, and deleting.

Actions are always required.

Action commands

provides details on each of the action commands.

Example

In the following example for changing the password of a user account, the action is

set

pstcli -d 10.0.0.1 -u

admin

-p

MyPassword456!

local_user -name

operator

set –password

NewPassword456!

–current_password

OldPassword456!

Action qualifiers

Action qualifiers are parameters specific to actions, such as attributes or settings to modify when changing an object. All action qualifiers

start with a hyphen (-).

Introduction