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

Set-VBRADContainer

Short Description

Modifies a scope of Active Directory objects.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires Veeam Agent for Microsoft Windows/Veeam Agent for Linux license

Syntax

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

Detailed Description

This cmdlet modifies the VBRADContainer object. This object contains a scope of Active Directory objects you want to add to a protection group. To modify the settings of the scope, enter the corresponding parameters with new values. The parameters you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Container

Specifies the scope of Active Directory objects you want to add to a protection group.

Accepts VBRADContainer type.

True

Named

True (ByValue,
ByProperty
Name)

False

Domain

Specifies the Active Directory domain connection object.

Accepts VBRADDomain type.

False

Named

True (ByProperty
Name)

False

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 VBRADEntity[] type.

False

Named

True (ByProperty
Name)

False

ExcludeVMs

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

False

Named

True (ByProperty
Name)

False

ExcludeOffline
Computers

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

False

Named

True (ByProperty
Name)

False

ExcludeComputers

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

False

Named

True (ByProperty
Name)

False

ExcludedEntity

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

NOTE: You cannot exclude Domain Local or Universal groups.

Accepts VBRADEntity[] type.

False

Named

True (ByProperty
Name)

False

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.

True

Named

True (ByProperty
Name)

False

UseCustom
Credentials

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

To specify custom credentials, use the CustomCredentials parameter.

False

Named

True (ByProperty
Name)

False

CustomCredentials

Specifies custom credentials for authenticating with associated Active Directory objects.

Accepts VBRADCustomCredentials[] type.

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

VBRADContainer

Example

This example shows how to exclude VMs from the existing protection group.

You will need to perform the following steps:

  1. Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
  2. Get the scope of Active Directory objects. Use the Container property of the protection group object saved to the $group variable. Save the result to the $ad variable.
  3. Run Set-VBRADContainer with the $ad variable and ExcludeVMs parameter. Save the result to the $newad variable.
  4. Run Set-VBRProtectionGroup with the $group and $newad variables.

PS C:\PS> $group = Get-VBRProtectionGroup -Name "Support PG"

PS C:\PS> $ad = $group.Container

PS C:\PS> $newad = Set-VBRADContainer -Container $ad -ExcludeVMs

PS C:\PS> Set-VBRProtectionGroup -ProtectionGroup $group -Container $newad

Related Commands

Get-VBRProtectionGroup

Set-VBRProtectionGroup

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