Follow

User commands allow you to create a user, assign him as a pool admin (and change his role to allow that), map him to LDAP and query all of the users on an InfiniBox.


user.add_pool 

ROLE: Admin 

Description

Grant pool provisioning privileges to a pool administrator.

This command operates on pool administrators only.

Syntaxuser.add_pool user=POOLADMINUSER pool=POOL 
ArgumentspoolName of an existing pool 
user Name of an existing local user with PoolAdmin role 
Exampleuser.add_pool name=user1 pool=pool1 
Granted provisioning privileges on pool pool1 to user user1 



user.change_email 

ROLE: Admin 

Description

Change local user email. 

Syntaxuser.change_email user=LOCALUSER email=LOCALEMAIL 
Argumentsuser Name of an existing local user 
email A valid email address 
Exampleuser.change_email name=user1 email=user1@infinidat.com 
User user1 email changed from email1 to email2 



user.change_password 

ROLE: All Roles 

Description

Change your password.

Run the command, enter a new password and re-enter when prompted to do so.

Syntaxuser.change_password [user=LOCALUSER] [password_env_variable=ENVVAR]
Argumentsuser Name of an existing local user 
password_env_variableName of an existing environment variable 
Exampleuser.change_password 
Local user user1 password changed 



user.change_role 

ROLE: Admin 

Description

Change local user role.

Available roles: Admin, PoolAdmin, ReadOnly. The availability of these roles depends on the role of the user that runs this command.

Syntaxuser.change_role user=LOCALUSER role=ROLE 
Argumentsrole User role 
user Name of an existing local user 
Exampleuser.change_role name=user1 role=pool-admin-1 
User user1 role changed from PoolAdmin to ReadOnly 



user.create 

ROLE: Admin 

Description

Create a new local user.  

Syntaxuser.create name=NAME email=LOCALEMAIL role=ROLE [password=STR] 
Argumentsname A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. 
email a valid email address 
roleUser role
passwordAny sequence of characters
Exampleuser.create name=user1 password=****** email=user1@infinidat.com role=pool-admin-1 
User user1 created



user.delete 

ROLE: Admin 

Description

Delete local user. 

Syntaxuser.delete user=LOCALUSER 
Argumentsuser Name of an existing local user 
Exampleuser.delete name=user1 
User user1 deleted 



user.disable 

ROLE: Admin 

Description

Disables a local user.

This command prevents the user from logging into the system. The user is not deleted and can be re-enabled.

Syntaxuser.disable user=ENABLEDLOCALUSER 
Argumentsuser Name of an existing enabled local user 
Exampleuser.disable name=pool-admin-1 
Local user "pool-admin-1" disabled 



user.enable 

ROLE: Admin 

Description

Enables a local user. 

Syntaxuser.enable user=DISABLEDLOCALUSER 
Argumentsuser Name of an existing disabled local user 
Exampleuser.enable name=pool-admin-1 
Local user "pool-admin-1" enabled 



user.query 

ROLE: All Roles 

Description

List existing local users.

The users are displayed along with their roles and the pools they have access to. 

Syntaxuser.query [user=LOCALUSER[,LOCALUSER,...]] [role=ROLE] 
Argumentsuser Name of an existing local user (multiple values, separated by commas) 
role User role 
Exampleuser.query 
NAMR  ROLE      POOLS 
user1 Admin     all pools
user2 PoolAdmin pool1
user3 PoolAdmin - 



user.remove_pool 

ROLE: Admin

Description

Revoke pool provisioning privileges from a pool administrator. 

Syntaxuser.remove_pool user=POOLADMINUSER pool=POOL 
Argumentspool Name of an existing pool 
user Name of an existing local user with PoolAdmin role 
Exampleuser.remove_pool name=user1 pool=pool1 
Revoked provisioning privileges on pool pool1 from user user1 



user.rename 

ROLE: Admin

Description

Change local user username. 

Syntaxuser.rename user=LOCALUSER new_name=STR 
Argumentsnew_name Any sequence of characters 
user Name of an existing local user  
Exampleuser.rename name=user1 new_name=user2 
User user1 renamed to user2 
Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:33:40 UTC

Comments