Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

New-VBRADCustomCredentials

Short Description

Specifies custom credentials for authenticating with Active Directory objects.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires Veeam Agent for Microsoft Windows/Veeam Agent for Linux 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 $domainсonn 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.

PS C:\PS> $connection = Get-VBRADDomain -ServerName support.east -Credentials support\jsmith

PS C:\PS> $root = Find-VBRADEntity -Domain $connection

PS C:\PS> $accounts = Find-VBRADEntity -Domain $connection -Root $root -Name Accounts

PS C:\PS> $ccreds = Get-Credential

PS C:\PS> 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.

PS C:\PS> $connection = Get-VBRADDomain -ServerName support.east -Credentials support\jsmith

PS C:\PS> $objects = Find-VBRADEntity -Domain $connection -Name Support

PS C:\PS> New-VBRADCustomCredentials -Entity $objects

Related Commands

Get-VBRADDomain

Find-VBRADEntity

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation