New-VBRADCustomCredentials

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

Type

Required

Position

Accept
Pipeline
Input

Entity

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

Accepts the VBRADEntity object. To get this object, run the Find-VBRADEntity cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

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.

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

Accepts string (user name) or the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.

False

Named

True (ByProperty
Name)

<CommonParameters>

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

Output Object

VBRADCustomCredentials

Examples

New-VBRADCustomCredentialsExample 1. Specifying Credentials for Authenticating with Active Directory Objects

New-VBRADCustomCredentialsExample 2. Specifying Master Account Credentials for Scope of Active Directory Objects

Related Commands

Page updated 3/6/2024

Page content applies to build 12.3.1.1139