This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VBRADDomain
Short Description
Creates an object for connecting to Active Directory domain.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Get-VBRADDomain -ServerName <string> [-Port <int>] [-Credentials <VBRCredentials>] [<CommonParameters>] |
Detailed Description
This cmdlet creates the VBRADDomain object for connecting to the Active Directory domain. Veeam Backup & Replication will use this object to access Active Directory objects that you want to add to the scope of a protection group.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
ServerName | Specifies the name for connecting to DC server/domain:
| True | Named | True (ByValue, | False |
Port | Specifies the port for authenticating with the DC server/Domain. Default: 389. | False | Named | True (ByProperty | False |
Credentials | Specifies credentials for authenticating with DC server/Domain. 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 on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
Example 1
This example shows how to create an Active Directory domain connection object using credentials.
You will need to perform the following steps:
- Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with the DC server or Active Directory domain. Save the result to the $adcreds variable.
- Run Get-VBRADDomain with the $adcreds variable.
Example 2
This command shows how to create an Active Directory domain connection object using credentials in the "Domain\Username" format.
Related Commands
