Description
Updates a specified user account. You can update the username, add roles to or remove roles from the account, add information such as full name, phone number, email address, or description.
Syntax
user --update --name <user name> [--new_name <user name>]
[--add_roles <cifs||||||administrator|secure_connect|object>]
[--remove_roles <cifs||||||administrator|secure_connect|object>]
[--full_name <full name>]
[--phone <phone number>]
[--email_addr <e-mail address (e.g. name@company.com)>]
[--description <anything>]
Where
--name user name
--new_name new user name
--add_roles user role
--remove_roles user role
--full_name user's full name
--phone phone number
--email_addr email address
--description description
Result
Successfully updated User Test_User.
Other Examples
The example below adds the secure_connect role to a user account
Syntax
user --update --name test1 --add_roles secure_connect
Result
Successfully updated User test1.
Description
Deletes the specified user account.
Syntax
user --delete --name <user name>
Where
--name user name
Result
User "Test_User2" has been deleted.
Description
Sets a password for the specified user account.
Syntax
user --setpassword --name <user name>
Where
--name user name
Result
Enter new password:
Re-type password:
Successfully updated User Test_User2.
Description
Displays the list of all user-related options that can be used as a reference when using the QoreStor CLI.
Result
Usage:
user --show [--users]
[--logins]
[--verbose]
[--name <user name>]
[--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|secure_connect|object>]
user --add --name <user name>
[--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|secure_connect|object>]
[--full_name <full name>]
[--phone <phone number>]
[--email_addr <e-mail address (e.g. name@company.com)>]
[--description <anything>]
[--auth_type <local|saml>]
user --update --name <user name>
[--new_name <user name>]
[--add_roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|secure_connect|object>]
[--remove_roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|secure_connect|object>]
[--full_name <full name>]
[--phone <phone number>]
[--email_addr <e-mail address (e.g. name@company.com)>]
[--description <anything>]
user --delete --name <user name>
user --setpassword --name <user name>
user --help
user <command> <command-arguments>
<command> can be one of:
--show Displays command specific information.
--add adds a user account.
--update updates a user account.
--delete delete a user account.
--setpassword sets password to a user account.
For command-specific help, please type user --help <command>
For example:
user --help show
