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

Get-VBRADDomain

Short Description

Creates an object for connecting to Active Directory domain.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires Veeam Agent for Microsoft Windows/Veeam Agent for Linux 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
Pipeline
Input

Accept
Wildcard
Characters

ServerName

Specifies the name for connecting to DC server/domain:

  • DNS name for DC server
  • FQDN or NetBIOS for domain

True

Named

True (ByValue,
ByProperty
Name)

False

Port

Specifies the port for authenticating with the DC server/Domain.

Default: 389.

False

Named

True (ByProperty
Name)

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
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

VBRADDomain

Example 1

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

You will need to perform the following steps:

  1. 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.
  2. Run Get-VBRADDomain with the $adcreds variable.

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

PS C:\PS> Get-VBRADDomain -Server support.north -Credentials $adcreds

Example 2

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

PS C:\PS> Get-VBRADDomain -Server support.north -Credentials support\jsmith

Related Commands

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

Backup and Restore of SQL Server Databases

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