This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRADContainer

Short Description

Modifies a scope of Active Directory objects.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal 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, specify new values for the necessary parameters. 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
ExcludeOfflineComputers	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
UseCustomCredentials	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

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRADContainer

Example

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

You will need to perform the following steps:

Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
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.
Run Set-VBRADContainer with the $ad variable and ExcludeVMs parameter. Save the result to the $newad variable.
Run Set-VBRProtectionGroup with the $group and $newad variables.

$group = Get-VBRProtectionGroup -Name "Support PG"

$ad = $group.Container

$newad = Set-VBRADContainer -Container $ad -ExcludeVMs

Set-VBRProtectionGroup -ProtectionGroup $group -Container $newad

Related Commands

Get-VBRProtectionGroup

Set-VBRProtectionGroup