Add-VBRUserRoleAssignment

In this article

    Short Description

    Adds a role to a user or a user group.

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

    Syntax

    Add-VBRUserRoleAssignment -Name <string> -Role {BackupOperator | RestoreOperator | BackupAdmin | TapeOperator | BackupViewer} [<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.

    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,
    ByProperty
    Name)

    Role

    Specifies a role that you want to assign to a user. You can assign one of the following roles:

    • BackupOperator
    • RestoreOperator
    • BackupAdmin
    • TapeOperator
    • BackupViewer

     

    True

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBRUserRoleAssignment object that defines a role for a user or a user group

    Examples

    Add-VBRUserRoleAssignmentExample 1. Assigning Veeam Backup Operator Role to User

    This command assigns a Veeam Backup Operator role to the Tech\BackupAdmin user. The cmdlet output will contain the following details Role, Type, Name and Id.

    Add-VBRUserRoleAssignment -Name Tech\BackupAdmin -Role "BackupOperator"

          Role  Type Name           Id

          ----  ---- ----           --

    BackupAdmin Group Administrators c5d266c7-8e2b-43f9-92c6-fffc4297074d

    Add-VBRUserRoleAssignmentExample 2. Assigning Veeam Tape Operator Role to User

    This command assigns a Veeam Tape Operator role to the Tech\TapeAdmin user. The cmdlet output will contain the following details Role, Type, Name and Id.

    Add-VBRUserRoleAssignment -Name Tech\TapeAdmin -Role TapeOperator

          Role  Type Name           Id

          ----  ---- ----           --

    BackupAdmin Group Administrators c5d266c7-8e2b-43f9-92c6-fffc4297074d