Get-VBRRoleEntity

Short Description

Returns roles configured in Veeam Backup & Replication.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VBRRoleEntity [-Name <String[]>] [-BuiltIn] [<CommonParameters>]

Detailed Description

This cmdlet returns roles configured in Veeam Backup & Replication. You can filter the results by name or return only built-in custom roles.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Name	Specifies an array of roles names. The cmdlet will return custom roles with these names.	String[]	False	Named	True (ByValue, ByProperty Name)
BuiltIn	Defines that the cmdlet will return only built-in roles.	SwitchParameter	False	Named	False

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

Output Object

The cmdlet returns the VBRRoleEntity object that contains the custom roles settings.

Examples

Example 1. Getting Built-In Roles

This command returns built-in roles.

Get-VBRRoleEntity -BuiltIn

Example 2. Assigning Role to User

This example shows how to get a role and assign it to a user.

$roleEntity = Get-VBRRoleEntity -Name "BackupOperator"

Add-VBRUserRoleAssignment -Name "Tech\jsmith" -RoleEntity $roleEntity

Perform the following steps:

Run the Get-VBRRoleEntity cmdlet. Specify the Name parameter value. Save the result to the $roleEntity variable.
Run the Add-VBRUserRoleAssignment cmdlet. Specify the Name parameter value. Set the $roleEntity variable as the RoleEntity parameter value.

Related Commands