--- title: "Get-VBRRoleEntity" description: "Returns roles configured in Veeam Backup & Replication. Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet returns roles configured in Veeam Backup & Replication." canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/get-vbrroleentity.html" breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Roles and Users > Get-VBRRoleEntity" dateModified: "2026-08-19" --- # Get-VBRRoleEntity ## Short Description Returns roles configured in Veeam Backup & Replication. **Product Edition**: Standard, Enterprise, Enterprise Plus, Veeam Universal License ## Syntax ``` Get-VBRRoleEntity [-Name ] [-BuiltIn] [] ``` ## 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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

BuiltIn

Defines that the cmdlet will return only built-in roles.

SwitchParameter

False

Named

False

Name

Specifies an array of roles names. The cmdlet will return custom roles with these names.

String[]

False

Named

True (ByPropertyName, ByValue)

`` This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7). ## Output Object The cmdlet returns the [`VBRRoleEntity`](vbrroleentity.md) object that contains the custom roles settings. ## Examples ::: example ### Example 1. Getting Built-In Roles This command returns built-in roles. ``` Get-VBRRoleEntity -BuiltIn ``` ::: ::: example ### 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: 1. Run the `Get-VBRRoleEntity` cmdlet. Specify the `Name` parameter value. Save the result to the `$roleEntity` variable. 2. Run the [`Add-VBRUserRoleAssignment`](add-vbruserroleassignment.md) cmdlet. Specify the `Name` parameter value. Set the `$roleEntity` variable as the `RoleEntity` parameter value. ::: ## Related Commands [`Add-VBRUserRoleAssignment`](add-vbruserroleassignment.md)