New-VBRADContainer

Short Description

Creates a scope of Active Directory objects for a protection group.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

New-VBRADContainer -Domain <VBRADDomain> -Entity <VBRADEntity[]> -MasterCredentials <CCredentials> [-ExcludeVMs] [-ExcludeOfflineComputers] [-ExcludeComputers] [-ExcludedEntity <VBRADEntity[]>] [-UseCustomCredentials] [-CustomCredentials <VBRADCustomCredentials[]>]  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRADContainer object. This object contains a scope of Active Directory objects. Use this object to create a protection group with the Add-VBRProtectionGroup cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Domain

Specifies the Active Directory domain connection object.

Accepts the VBRADDomain object. To get this object, run the Get-VBRADDomain cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Entity

Specifies the array of the Active Directory objects from the same domain. The cmdlet will add these objects to the protection scope.

You can add the following types of Active Directory objects:

  • Domain
  • Cluster
  • Organization unit
  • Global group
  • Folder
  • Computer

Note: You cannot add Domain Local or Universal groups.

Accepts the VBRADEntity[] object. To get this object, run the Find-VBRADEntity cmdlet.

True

Named

True (ByProperty
Name)

ExcludeVMs

Defines that the cmdlet will exclude all VMs from the protection scope.

By default this parameter is set to True. If you don't want to exclude VMs from the protection scope, set this parameter to False.

SwitchParameter

False

Named

True (ByProperty
Name)

ExcludeOfflineComputers

Defines that the cmdlet will exclude computers that have been offline for over 30 days.

By default this parameter is set to True. If you don't want to exclude offline computers from the protection scope, set this parameter to False.

SwitchParameter

False

Named

True (ByProperty
Name)

ExcludeComputers

Defines that you want to exclude some Active Directory objects from the protection scope.

Use the ExcludeEntity parameter to specify objects you want to exclude from the protection scope.

SwitchParameter

False

Named

True (ByProperty
Name)

ExcludedEntity

Specifies Active Directory objects you want to exclude from the protection scope.

Note: You cannot exclude Domain Local or Universal groups.

Accepts the VBRADEntity[] object. To get this object, run the Find-VBRADEntity cmdlet.

False

Named

True (ByProperty
Name)

MasterCredentials

Specifies Master account credentials for authenticating with all Active Directory objects in a protection scope.

For authenticating with Active Directory objects that require different credentials, Veeam Backup & Replication uses custom credentials. If you want to use custom credentials for some Active Directory objects, set the UseCustomCredentials parameter.

Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.

True

Named

True (ByProperty
Name)

UseCustomCredentials

Defines that you want to use custom credentials for authenticating with some Active Directory objects.

To specify custom credentials, use the CustomCredentials parameter.

SwitchParameter

False

Named

True (ByProperty
Name)

CustomCredentials

Specifies custom credentials for authenticating with associated Active Directory objects.

Accepts the  VBRADCustomCredentials[] object. To create this object, run the New-VBRADCustomCredentials 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

VBRADContainer

Examples

New-VBRADContainerExample 1. Creating Scope of Active Directory Objects

New-VBRADContainerExample 2. Creating Protection Group with Scope of Active Directory Objects

Related Commands

Page updated 5/2/2024

Page content applies to build 12.3.1.1139