Set-VBRUniversalCDPPolicy

Short Description

Modifies a universal CDP policy.

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

Syntax

Set-VBRUniversalCDPPolicy -Policy <VBRUniversalCDPPolicy> [-SourceObject <VBRUniversalCDPSource[]>]

[-ExcludedObject <VBRUniversalCDPSource[]>] [-Destination <IUniversalCdpDestination>] [-Name <String>]

[-Description <String>] [-EnableNetworkMapping] [-NetworkMapping <VBRUniversalCDPNetworkMappingRule[]>]

[-SourceProxy <VBRCDPProxy[]>] [-TargetProxy <VBRCDPProxy[]>] [-Suffix <String>]

[-CompressionLevel <VBRCompressionLevel>] [-NotificationOptions <VBRNotificationOptions>]

[-RetentionOptions <VBRCDPPolicyRetentionOptions>] [-EnableReplicaSeeding]

[-RepositorySeed <CBackupRepository>] [-EnableReplicaMapping] [-OriginalMachine <VBRDiscoveredComputer[]>]

[-ReplicaMachine <VBRNamedObject[]>] [-EnableGuestProcessing]

[-GuestProcessingOptions <VBRApplicationProcessingOptions[]>] [-ReIpRule <IViReIpRule[]>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a universal CDP policy.

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
CompressionLevel	Specifies the compression level of the replicated data: `None`: use this option if you do not want to enable data compression. `Dedupe-friendly`: use this option to set a dedupe-friendly compression level. `Optimal`: use this option to set an optimal compression level. `High`: use this option to set a high compression level. `Extreme`: use this option to set an extreme compression level.	`VBRCompressionLevel`	False	Named	False
Description	Specifies a description for the universal CDP policy.	`String`	False	Named	False
Destination	Specifies the settings of the target location where the workloads will be replicated. Accepts the `IUniversalCdpDestination` object. To create this object, run the `New-VBRUniversalCDPViDestination` or `New-VBRUniversalCDPCloudDestination` cmdlet.	`IUniversalCdpDestination`	False	Named	False
EnableGuestProcessing	Defines if guest processing is enabled for the universal CDP policy.	`SwitchParameter`	False	Named	False
EnableNetworkMapping	Defines if network mapping is enabled for the universal CDP policy.	`SwitchParameter`	False	Named	False
EnableReplicaMapping	Defines if replica mapping is enabled for the universal CDP policy.	`SwitchParameter`	False	Named	False
EnableReplicaSeeding	Defines if replica seeding is enabled for the universal CDP policy.	`SwitchParameter`	False	Named	False
ExcludedObject	Specifies the array of workloads that you want to exclude from the universal CDP policy processing. Accepts the `VBRUniversalCDPSource[]` object. To get this object, run the `Get-VBRDiscoveredComputer` cmdlet.	`VBRUniversalCDPSource[]`	False	Named	False
GuestProcessingOptions	Specifies the array of guest processing settings for the universal CDP policy. Accepts the `VBRApplicationProcessingOptions[]` object. To create this object, run the `New-VBRApplicationProcessingOptions` cmdlet.	`VBRApplicationProcessingOptions[]`	False	Named	False
Name	Specifies a name for the universal CDP policy.	`String`	False	Named	False
NetworkMapping	Specifies the array of network mapping settings. Accepts the `VBRUniversalCDPNetworkMappingRule[]` object. To get this object, run the `New-VBRUniversalCDPNetworkMappingRule` cmdlet.	`VBRUniversalCDPNetworkMappingRule[]`	False	Named	False
NotificationOptions	Specifies notification settings of the universal CDP policy. Accepts the `VBRNotificationOptions` object. To create this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	False	Named	False
OriginalMachine	For replica mapping. Specifies an array of production workloads that you want to replicate using replica mapping. The universal CDP policy will map these workloads to the workloads in the disaster recovery site. Use the `ReplicaMachine` parameter to specify the replicated workloads on the disaster recovery site. Accepts the `VBRDiscoveredComputer[]` object. To get this object, run the `Get-VBRDiscoveredComputer` cmdlet.	`VBRDiscoveredComputer[]`	False	Named	False
Policy	Specifies the universal CDP policy whose settings you want to change. Accepts the `VBRUniversalCDPPolicy` object. To create this object, run the `Add-VBRUniversalCDPPolicy` cmdlet. To get this object, run the `Get-VBRCDPPolicy` cmdlet.	`VBRUniversalCDPPolicy`	True	Named	True (ByPropertyName, ByValue)
ReIpRule	Specifies the array of re-IP rules. Use re-IP rules when the workloads must be replicated to a network with a different IP addressing scheme. Accepts the `IViReIpRule[]` object. To get this object, run the `Get-VBRViReplicaReIpRule` cmdlet.	`IViReIpRule[]`	False	Named	False
ReplicaMachine	For replica mapping. Specifies an array of workloads on the disaster recovery site. The cmdlet will map the production workloads to these workloads. Use the `OriginalMachine` parameter to specify the production workloads. Accepts the `VBRNamedObject[]` object. To get this object, run the `Get-VBRViVM` , `Get-VBRViCloudVM` or `Get-VBRvCDCloudVM` cmdlet.	`VBRNamedObject[]`	False	Named	False
RepositorySeed	For replica seeding. Specifies the backup repository that keeps a full backup of workloads that you want to replicate. Note: Backups for seeding must be created by Veeam Agent for Linux or Veeam Agent for Microsoft Windows. Accepts the `CBackupRepository` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository`	False	Named	False
RetentionOptions	Specifies retention settings of the universal CDP policy. Accepts the `VBRCDPPolicyRetentionOptions` object. To create this object, run the `New-VBRCDPPolicyRetentionOptions` cmdlet.	`VBRCDPPolicyRetentionOptions`	False	Named	False
SourceObject	Specifies the workloads or protection groups that you want to protect with universal CDP. Accepts the `VBRUniversalCDPSource[]` object. To get this object, run the `Get-VBRDiscoveredComputer` or `Get-VBRProtectionGroup` cmdlet.	`VBRUniversalCDPSource[]`	False	Named	False
SourceProxy	Specifies the array of the source CDP proxies that you want to use. Accepts the `VBRCDPProxy[]` object. To get this object, run the `Get-VBRCDPProxy` cmdlet.	`VBRCDPProxy[]`	False	Named	False
Suffix	Specifies the suffix that the cmdlet will add to the name of replicas.	`String`	False	Named	False
TargetProxy	Specifies the array of the target CDP proxies that you want to use. Accepts the `VBRCDPProxy[]` object. To get this object, run the `Get-VBRCDPProxy` cmdlet.	`VBRCDPProxy[]`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRUniversalCDPPolicy object that defines settings of the universal CDP policy.

Examples

Example 1. Excluding Workload from Universal CDP Policy Processing

This example shows how to exclude a workload from the universal CDP policy processing.

$cdpPolicy = Get-VBRCDPPolicy -Name "Universal CDP Policy"

$group = Get-VBRProtectionGroup -Name "Protection Group CDP"

$workloads = Get-VBRDiscoveredComputer -ProtectionGroup $group

Set-VBRUniversalCDPPolicy -Policy $cdpPolicy -ExcludedObject $workloads[0]

Perform the following steps:

Run the Get-VBRCDPPolicy cmdlet. Specify the Name parameter value. Save the result to the $cdpPolicy variable.
Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the Get-VBRDiscoveredComputer cmdlet. Set the $group variable as the ProtectionGroup parameter value. Save the result to the $workloads variable.
Run the Set-VBRUniversalCDPPolicy cmdlet. Set the $cdpPolicy variable as the Policy parameter value. Set the $workloads[0] variable as the ExcludedObject parameter value.