New-VBRADCustomCredentials

In this article

    Short Description

    Specifies custom credentials for authenticating with Active Directory objects.

    Applies to

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

    Syntax

    New-VBRADCustomCredentials -Entity <VBRADEntity> [-Credentials <CCredentials>]  [<CommonParameters>]

    Detailed Description

    This cmdlet specifies custom credentials for authenticating with Active Directory objects you want to add to a protection group. Veeam Backup & Replication uses these credentials for Veeam Agent deployment and backup\restore activities.

    By default, Veeam Backup & Replication uses Master account credentials for authenticating with all Active Directory objects in a protection group. For authenticating with Active Directory objects that require different credentials Veeam Backup & Replication uses custom credentials.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Entity

    Specifies Active Directory objects for which you want to specify custom credentials.

    Accepts VBRADEntity type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Credentials

    Specifies custom credentials for authenticating with Active Directory objects in a protection group.

    If not set, Veeam Backup & Replication will use Master account credentials for authenticating with associated objects.

    Accepts CCredentials or string (user name) types.

    NOTE: for string type, enter a user name in the "Domain\Username" format.

    False

    Named

    True (ByProperty
    Name)

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    VBRADCustomCredentials

    Example 1

    This example shows how to specify custom credentials for authenticating with Active Directory objects.

    You will need to perform the following steps:

    1. Run Get-VBRADDomain to create the Active Directory domain connection object. Save the result to the $connection variable.
    2. Run Find-VBRADEntity with the $domainconn variable to get the domain container. Save the result to the $root variable.
    3. Run Find-VBRADEntity with the $connection and $root variables to get the "Accounts" container. Save the result to the $accounts variable.
    4. Run Get-Credential to create a credential object for authenticating with the Active Directory objects from the "Accounts" container. Type the credentials you want to use for authenticating with the Active Directory objects from the "Accounts" container and save the result to the $ccreds variable.
    5. Run New-VBRADCustomCredentials with the $accounts and $ccreds variables.

    $connection = Get-VBRADDomain -ServerName support.east -Credentials support\jsmith

    $root = Find-VBRADEntity -Domain $connection

    $accounts = Find-VBRADEntity -Domain $connection -Root $root -Name Accounts

    $ccreds = Get-Credential

    New-VBRADCustomCredentials -Entity $accounts -Credentials $ccreds

    Example 2

    This example shows how to specify Master account credentials for the scope of Active Directory objects.

    You will need to perform the following steps:

    1. Run Get-VBRADDomain to create the Active Directory domain connection object. Save the result to the $connection variable.
    2. Run Find-VBRADEntity with the $connection variable to get the Active Directory container. Save the result to the $objects variable.
    3. Run New-VBRADCustomCredentials with the $objects variable.

    $connection = Get-VBRADDomain -ServerName support.east -Credentials support\jsmith

    $objects = Find-VBRADEntity -Domain $connection -Name Support

    New-VBRADCustomCredentials -Entity $objects

    Related Commands

    Get-VBRADDomain

    Find-VBRADEntity

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.