User management

Edit online

You can manage vSnap server users by issuing the vsnap user command. This command and available options are used to create users, grant and revoke user privileges, query users, and update a user's password.

Users that are created on a vSnap server are operating system users that are added to the vSnap operating system group. Users in the vSnap operating system group are not assigned sudo privileges. As a result, these users require a password to run a command.

You can create a vSnap user by issuing the create command. In this way, you create an operating system user that is assigned to the vsnap group that can run vSnap commands and make API calls. Issue the create command:
$ vsnap user create

If running interactively, you are prompted to enter the username, password, and the password a second time for confirmation. If running non-interactively, the following options are available to the create command:

--username <username>
Enter the username of the user.
--password <password>
Enter the password of the user.
You can grant privileges to an existing operating system account to ensure that the user can run vSnap commands and make API calls. To grant privileges, issue the grant command:
$ vsnap user grant

If running interactively, you are prompted to enter the username, password, and the password a second time for confirmation. If running non-interactively, the following options are available to the grant command:

--username <username>
Enter the username of the user.
--password <password>
Enter the password of the user. This must be the operating system account password if the account already exists on the system.
You can revoke privileges from a user who is assigned to the vsnap group. The user will remain as an operating system user but will no longer be able to run vSnap commands or make API calls. To revoke privileges, issue the revoke command:
$ vsnap user revoke

If running interactively, you are prompted to enter the username. If running non-interactively, the following options are available to the revoke command:

--username <username>
Enter the username of the user.
To display a list of vSnap users who are part of the vsnap group on the vSnap server, issue the show command:
$ vsnap user show
A vSnap user can have the account password changed which will update that user's password on the system. Issue the update command:
$ vsnap user update
If running interactively, you are prompted to enter the username, old password, new password, and the new password a second time for confirmation. If running non-interactively, the following options are available to the update command:
--username <username>
Enter the username of the user.
--password <old_password>
Enter the old password of the user.
--new_password <new_password>
Enter the new password of the user.
If you have already changed the vSnap system password using an external command instead of the vsnap user update command, then the SMB/CIFS password can be output of sync with the system password. Issue the following command to synchronize the SMB/CIFS passwords.
vsnap user resyncsmbpass

If running interactively, you are prompted to enter the username and the current system password. If running non-interactively, the following options are available to the resyncsmbpass command.

--username <username>

Enter the username of the account to be synced.

--password <password>

Enter the current system password of the account to be synced.