Chat now with support
Chat with Support

QoreStor 7.1.1 - Command Line Reference Guide

Introduction to the QoreStor Command Line Reference Guide Introducing QoreStor Managing QoreStor
Alerts Commands Authenticate Commands Email_alerts Commands Email_stats Commands OST RDA SAML sc_manager command Stats Storage Group commands System User
Managing QoreStor Storage Operations
Cloud_tier Connection Container iSCSI NDMP Object_container Object_direct Performance_tier Replication Seed Schedule VTL
Maintaining QoreStor About us

User Command Usage

This topic introduces the user command usage:

  • user --show [options]
  • user --add --name [options]
  • user --update --name [options]
  • user --delete --name
  • user --setpassword --name
  • user --help

NOTE: If you specify a command without supplying the expected value or option, you will be prompted to provide the correct value or option.

user --show [--users] [--logins] [--verbose][--name <username>] [--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|email_recipient>

Description

Displays the current status of the service and root user accounts (using the user --show --users command), and also displays the login types and login times on a QoreStor (using the user --show --logins command).

Syntax

user --show [--users] 
	[--logins]
	[--verbose]
	[--name <user name>]
	[--roles <cifs|||||||secure_connect|object>]

Where

--users     List of users.
--logins    List of logins.
--verbose   verbose
--name      show a specific user.
--roles     List all users who has these roles

Result

Service Account                 : Disabled
Root Account                    : Enabled

User Name                       : backup_user
User Roles                      : ,

User Name                       : admin
User Roles                      : 

Other Examples

Displays the current status of login attempts on a QoreStor.

user --show --logins
User Name       Terminal    Login Time
root            pts/1       Oct 24 10:51 (10.15.13.4)
root            pts/2       Oct 23 20:41 (10.18.0.1)
root            pts/3       Oct 23 20:41 (10.15.0.13)
root            pts/5       Oct 24 09:35 (10.20.21.6)
   pts/6       Oct 24 12:32 (acme13.storage.local)
root            pts/7       Oct 24 12:24 (10.18.11.12)

user --add --name <user name>

Description

Adds a user account with the specified username.

Syntax

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>]

Where

--name          user name
--roles         user role
--full_name     user's full name
--phone         phone number
--email_addr    email address
--description   description

Result

Enter new password: 
Re-type password:
User "Test_User" created successfully.

user --update --name <user name> [--new_name <user name>] [--add_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--remove_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--full_name <full name>] [--phone <phone number>] [--email_addr <

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.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating