Dell PowerStore 3200T EMC PowerStore CLI User Guide - Page 7

Switches, Object types, Object qualifiers, Actions, Example 1

Page 7 highlights

Switches Use switches to configure PowerStore CLI and connect to a system. Type switches immediately after pstcli. When typing more than one switch on the same line, separate each switch with a space. All switches start with a hyphen (-). View the switches on page 13 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 on page 11 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 on page 7. 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 on page 8 provides details on each of the action commands. Introduction 7

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

Switches
Use switches to configure PowerStore CLI and connect to a system. Type switches immediately after
pstcli
. When typing
more than one switch on the same line, separate each switch with a space. All switches start with a hyphen (-).
View the switches
on page 13 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
on page 11 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
on page 7.
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
on page 8 provides details on each of the action commands.
Introduction
7