Remove-VBRUserRoleAssignment

Short Description

Removes a role from 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

Remove-VBRUserRoleAssignment -Assignment <VBRUserRoleAssignment> [<CommonParameters>]

Detailed Description

This cmdlet removes a role from a user or a user group.

Note

You cannot remove the role of the last administrator. This is to prevent a situation where no administrator remains.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Assignment	Specifies a role assignment that you want to remove	Accepts the VBRUserRoleAssignment object. To get this object, run the Get-VBRUserRoleAssignment cmdlet.	True	Named	True (ByValue, ByProperty Name)

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Example 1. Removing All Role Assignments from User

This example shows how to remove all roles that are assigned to the User\Administrator user if it has more than one role assigned.

Get-VBRUserRoleAssignment -Name "User\Administrator" | Remove-VBRUserRoleAssignment

Example 2. Removing Custom Role from User

This example shows how to remove a custom role that is assigned to the User\Administrator user.

$role = Get-VBRUserRoleAssignment -Name "User\Administrator" -RoleEntity (Get-VBRRoleEntity -Name "r1")

Remove-VBRUserRoleAssignment -Assignment $role

Perform the following steps:

Run the Get-VBRUserRoleAssignment cmdlet. Specify the Name and RoleEntity parameter values. Save the result to the $role variable.
Run the Remove-VBRUserRoleAssignment cmdlet. Set the $role variable as the Assignment parameter value.

Example 3. Removing Built-In Role from User

This example shows how to remove a built-in role that is assigned to the User\Administrator user.

$role = Get-VBRUserRoleAssignment -Name "User\Administrator" -Role BackupOperator

Remove-VBRUserRoleAssignment -Assignment $role

Perform the following steps:

Run the Get-VBRUserRoleAssignment cmdlet. Specify the Name and Role parameter values. Save the result to the $role variable.
Run the Remove-VBRUserRoleAssignment cmdlet. Set the $role variable as the Assignment parameter value.

Related Commands

Get-VBRUserRoleAssignment