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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ServerName	Specifies the name for connecting to DC server/domain: DNS name for DC server FQDN or NetBIOS for domain	String	True	Named	True (ByValue, ByProperty Name)
Port	Specifies the port for authenticating with the DC server/Domain. Default: 389.	Int	False	Named	True (ByProperty Name)
Credentials	Specifies credentials for authenticating with DC server/Domain. 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)

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

Output Object

VBRADDomain

Examples

Example 1. Creating Active Directory Domain Connection Object

This example shows how to create an Active Directory domain connection object using credentials.

$adcreds = Get-Credential

Get-VBRADDomain -Server support.north -Credentials $adcreds

Perform the following steps:

Run the Get-Credential cmdlet. 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 the Get-VBRADDomain cmdlet. Specify the Server parameter value. Set the $adcreds variable as the Credentials parameter value.

Example 2. Creating Active Directory Domain Connection Object

This command shows how to create an Active Directory domain connection object using credentials in the Domain\Username format.

Get-VBRADDomain -Server support.north -Credentials support\jsmith

Related Commands