Using the Command Line Interface › ca_auth - Authentication Command › ca_auth - User Arguments

ca_auth - User Arguments

Before you can use Arcserve Backup, you must have a Arcserve Backup account. Arcserve Backup is designed with a root-level, super user profile, to which complete control of Arcserve Backup is granted. This profile, referred to as the “caroot” user profile, is set up during the first-time installation of Arcserve Backup.

The caroot user has Administrator privileges, and is created by the program at installation. The password for the caroot profile can be set during installation, or it can be set or changed later using ca_auth or AuthSetup.exe, located in the Arcserve Backup home directory. For security reasons, we recommend that you set a password on this account.

Note: The ca_auth.exe command only supports only Arcserve Backup native users, such as caroot, and does not support Windows Users, such as "domain\user" or "hostname\Administrator".

Note: The caroot user profile controls access to the Arcserve Backup GUI and backup-related functions, and should not be confused with the security required to log in to your operating system.

The ca_auth command includes the following user arguments:

ca_auth [-cahost host] -user

add username [passwd] [-assignrole [rolelist]]
delete username
chgpasswd username [passwd]
chgrole username [rolelist]
validate username [password]
group username
getall

add username [passwd] [-assignrole [rolelist]]

Adds a username with the specified password as a Arcserve Backup user.

Note: The username cannot contain the "\" character.

-assignrole [rolelist]

When you add a new user by ca_auth, you must also assign a role to the new user to create a User Profile. A User Profile is the combination of linking the user with the assigned role(s) and the associated permissions for the assigned role(s).

The current available role list is as follows:

1)  Backup Operator

2)  Restore Operator

3)  Device Operator

4)  Tape Operator

5)  Security Administrator

6)  Report Operator

7)  Monitor Operator

8)  Arcserve Administrator

9)  Ownership Checking Exemption Privilege

When you include the -assignrole switch, you will also be prompted as follows:

Please assign roles for this user:

Each role has a corresponding number assigned to it. To assign a role to a new user, you must enter the role number after the -assignrole switch. To add multiple roles, you must insert a comma to separate each role.

For example:

• To assign a Security Administrator role to a new user, enter the following command:

  ca_auth [-cahost host] -user add username [passwd] -assignrole 5
  

• To assign multiple roles to a new user, enter the following command:

  ca_auth [-cahost host] -user add username [passwd] -assignrole 1,2,3,4,5
  

Note: For more information about User Profiles and role definitions, see the Administration Guide.

delete username

Deletes username from the authentication database.

chgpasswd username [passwd]

Changes the password for the specified username.

chgrole username [rolelist]

Changes the assigned role(s) for an existing Arcserve Backup user.

validate username [passwd]

Checks if the specified username and password combination exists, is valid, and can be used to log in to the Arcserve Backup domain.

group username

Provides the name of the user group to which the specified user belongs.

getall

Lists all users known to Arcserve Backup Authentication Service.

More information:

ca_auth - Authentication Command

ca_auth - Examples