This is an archive version of the document. To get the most up-to-date information, see the current version.New-VBRADCustomCredentials
Short Description
Specifies custom credentials for authenticating with Active Directory objects.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
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 | Accept |
Entity | Specifies Active Directory objects for which you want to specify custom credentials. Accepts VBRADEntity type. | True | Named | True (ByValue, | 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 | 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
Example 1
This example shows how to specify custom credentials for authenticating with Active Directory objects.
You will need to perform the following steps:
- Run Get-VBRADDomain to create the Active Directory domain connection object. Save the result to the $connection variable.
- Run Find-VBRADEntity with the $domainconn variable to get the domain container. Save the result to the $root variable.
- Run Find-VBRADEntity with the $connection and $root variables to get the "Accounts" container. Save the result to the $accounts variable.
- 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.
- 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:
- Run Get-VBRADDomain to create the Active Directory domain connection object. Save the result to the $connection variable.
- Run Find-VBRADEntity with the $connection variable to get the Active Directory container. Save the result to the $objects variable.
- 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
