Add-VBRUserRoleAssignment
Prev1/6Next
Short Description
Adds a role to a user or a user group.
|
Note |
|
If the four-eyes authorization is enabled, you cannot run this cmdlet. For more information, see the Four-Eyes Authorization section in the User Guide for VMware vSphere. |
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Assign a role to a user or user group using a role entity object.
Add-VBRUserRoleAssignment -Name <String> -RoleEntity <VBRRoleEntity> [<CommonParameters>] |
- Assign a role to a user or user group using a role value.
Add-VBRUserRoleAssignment -Name <String> -Role <VBRRole> [<CommonParameters>] |
Detailed Description
This cmdlet adds a role to a user or a user group. For more information on types of roles, see the Roles and Users section of User Guide for VMware vSphere.
Note |
You cannot assign a custom role and a built-in role to the same user or user group. |
Parameters
Parameter |
Description |
Type |
Required |
Position |
Accept Pipeline Input |
|---|---|---|---|---|---|
Name |
Specifies a name of a user or a user group. The cmdlet will assign a role for this user or user group. Note: You must specify the name of a user or a user group in the DOMAIN\Username format. |
String |
True |
Named |
True (ByValue, |
RoleEntity |
Specifies roles. The cmdlet will assign these roles to the user or user group. |
Accepts the VBRRoleEntity object. To get this object, run the Get-VBRRoleEntity cmdlet. |
True |
Named |
False |
Role |
Specifies a role that you want to assign to a user. You can assign one of the following roles:
|
VBRRole |
True |
Named |
False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBRUserRoleAssignment object that defines a role for a user or a user group
Examples
Example 1. Assigning Backup Operator Role to User
|
This command assigns the Backup Operator role to the Tech\BackupAdmin user. The cmdlet output will contain the following details: RoleEntity, Role, Type, Name and Id.
|
Example 2. Assigning Tape Operator Role to User
|
This command assigns the Tape Operator role to the Tech\TapeAdmin user. The cmdlet output will contain the following details: RoleEntity, Role, Type, Name and Id.
|
Example 3. Assigning Custom Role to User
|
This command assigns the r1 custom role to the k4 user. The cmdlet output will contain the following details: RoleEntity, Role, Type, Name and Id.
|
Related Commands