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

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)

<CommonParameters>

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

Example 2. Creating Active Directory Domain Connection Object

Related Commands

Page updated 3/6/2024

Page content applies to build 12.3.2.3617