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>] [-UseTemporaryCertificate] [-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.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Container	Specifies the scope of Active Directory objects you want to add to a protection group.	Accepts the VBRADContainer object. To get this object, use the Container parameter of the Get-VBRProtectionGroup cmdlet.	True	Named	True (ByValue, ByProperty Name)
Domain	Specifies the Active Directory domain connection object.	Accepts the VBRADDomain object. To get this object, run the Get-VBRADDomain cmdlet.	False	Named	True (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.	False	Named	True (ByProperty Name)
ExcludeVMs	Defines that the cmdlet will exclude all VMs from the protection scope.	SwitchParameter	False	Named	True (ByProperty Name)
ExcludeOfflineComputers	Defines that the cmdlet will exclude computers that have been offline for over 30 days.	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)
UseTemporaryCertificate	Defines that the cmdlet will use a temporary certificate to connect to the Active Directory objects instead of authenticating with credentials. Note: You cannot use this parameter together with the MasterCredentials parameter.	SwitchParameter	False	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)

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRADContainer

Examples

Example 1. Excluding VMs from Protection Group

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

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

$ad = $group.Container

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

Set-VBRProtectionGroup -ProtectionGroup $group -Container $newad

Perform the following steps:

Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Get the scope of Active Directory objects. Use the Container property of the $group variable. Save the result to the $ad variable.
Run the Set-VBRADContainer cmdlet. Set the $ad variable as the Container parameter value. Provide the ExcludeVMs parameter. Save the result to the $newad variable.
Run the Set-VBRProtectionGroup cmdlet. Set the $group variable as the ProtectionGroup parameter value. Set the $newad variable as the Container parameter value.

Example 2. Configuring Protection Group to Use Temporary Certificate

This example shows how to modify a scope of Active Directory objects so that Veeam Backup & Replication uses a temporary certificate to connect to the objects instead of authenticating with credentials.

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

$ad = $group.Container

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

Set-VBRProtectionGroup -ProtectionGroup $group -Container $newad

Perform the following steps:

Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Get the scope of Active Directory objects. Use the Container property of the $group variable. Save the result to the $ad variable.
Run the Set-VBRADContainer cmdlet. Set the $ad variable as the Container parameter value. Provide the UseTemporaryCertificate parameter. Save the result to the $newad variable.
Run the Set-VBRProtectionGroup cmdlet. Set the $group variable as the ProtectionGroup parameter value. Set the $newad variable as the Container parameter value.

Related Commands