Set-VBRCloudCDPPolicy

Short Description

Modifies a cloud CDP policy.

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

Syntax

Set-VBRCloudCDPPolicy -Policy <VBRCloudCDPPolicy> [-Entity <IViItem[]>] [-Server <VBRCloudServer>]

[-Datastore <VBRCloudDatastore>] [-Name <String>] [-Description <String>] [-Suffix <String>]

[-SourceProxy <VBRCDPProxy[]>] [-NotificationOptions <VBRNotificationOptions>]

[-RetentionOptions <VBRCDPPolicyRetentionOptions>] [-EnableApplicationProcessingOptions]

[-GuestProcessingOptions <VBRReplicaApplicationProcessingOptions>] [-EnableNetworkMapping]

[-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRCloudServerNetworkInfo[]>] [-EnableReplicaSeeding]

[-RepositorySeed <CBackupRepository>] [-EnableReplicaMapping] [-OriginalVM <CViVmItem[]>]

[-ReplicaVM <VBRViCloudVM[]>] [-Force] [-HighPriority] [<CommonParameters>]

Detailed Description

This cmdlet modifies a cloud 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
Datastore	Returns datastores or disk volumes allocated under cloud resources. The cmdlet will keep cloud CDP replicas in this datastore. Accepts the `VBRCloudDatastore` object. To get this object, run the `Get-VBRCloudDatastore` cmdlet.	`VBRCloudDatastore`	False	Named	False
Description	Specifies a description of a policy.	`String`	False	Named	False
EnableApplicationProcessingOptions	Enables guest processing settings for a cloud CDP policy. Use the `GuestProcessingOptions` parameter to specify the guest processing settings.	`SwitchParameter`	False	Named	False
EnableNetworkMapping	Enables network mapping. To set the network mapping rules, use the following parameters: `SourceNetwork` `TargetNetwork`	`SwitchParameter`	False	Named	False
EnableReplicaMapping	Enables replica mapping.	`SwitchParameter`	False	Named	False
EnableReplicaSeeding	Enables replica seeding. To specify replica seeding repository settings, use the `RepositorySeed` parameter.	`SwitchParameter`	False	Named	False
Entity	Specifies the array of VMs you want to add to the policy. Accepts the `IViItem[]` object. To create this object, run the `Find-VBRViEntity` cmdlet.	`IViItem[]`	False	Named	False
Force	Defines that the cmdlet will create a cloud CDP policy without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
GuestProcessingOptions	Specifies guest processing settings of a cloud CDP policy. Accepts the `VBRReplicaApplicationProcessingOptions` object. To create this object, run the `New-VBRReplicaApplicationProcessingOptions` cmdlet.	`VBRReplicaApplicationProcessingOptions`	False	Named	False
HighPriority	Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.	`SwitchParameter`	False	Named	False
Name	Specifies the name you want to assign to a policy.	`String`	False	Named	False
NotificationOptions	Specifies notification settings of a cloud CDP policy. Accepts the `VBRNotificationOptions` object. To create this object, run the `New-VBRNotificationOptions` cmdlet	`VBRNotificationOptions`	False	Named	False
OriginalVM	For replica mapping. Specifies an array of production VMs that you want to replicate using replica mapping. The cloud CDP policy will map this VM to the VM in the disaster recovery site. Use the `ReplicaVM` parameter to specify the replicated VM on the disaster recovery site. Accepts the `CViVmItem[]` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`CViVmItem[]`	False	Named	False
Policy	Specifies a cloud CDP policy that you want to modify. Accepts the `VBRCloudCDPPolicy` object. To get this object, run the `Get-VBRCDPPolicy` cmdlet.	`VBRCloudCDPPolicy`	True	Named	True (ByPropertyName, ByValue)
ReplicaVM	For replica mapping. Specifies an array VM in the disaster recovery site. The cmdlet will map the production VM to this VM. Use the `OriginalVM` parameter to specify the production VM. Accepts the `CViVmItem[]` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`VBRViCloudVM[]`	False	Named	False
RepositorySeed	For replica seeding. Specifies a backup repository that keeps a full backup of VMs that you want to replicate. Accepts the `CBackupRepository` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository`	False	Named	False
RetentionOptions	Specifies retention settings of a cloud CDP policy. Accepts the `VBRCDPPolicyRetentionOptions` object. To create this object, run the `New-VBRCDPPolicyRetentionOptions` cmdlet.	`VBRCDPPolicyRetentionOptions`	False	Named	False
Server	Specifies a cloud host allocated by a service provider through the hardware plan. The cloud CDP replicas will be created in this host. Accepts the `VBRCloudServer` object. To get this object, run the `Get-VBRCloudServer` cmdlet.	`VBRCloudServer`	False	Named	False
SourceNetwork	For network mapping. Specifies an array of production networks to which the VMs added to a cloud CDP policy are connected. Note: The number of source networks must match the number of target networks. Accepts the `VBRViNetworkInfo[]` object. To get this object, run the `Get-VBRViServerNetworkInfo` cmdlet.	`VBRViNetworkInfo[]`	False	Named	False
SourceProxy	Specifies an array of CDP source proxies added to the backup infrastructure. The cmdlet will use these proxies to transfer data. Default: Automatic selection. Accepts the `VBRCDPProxy[]` object. To get this object, run the `Get-VBRCDPProxy` cmdlet.	`VBRCDPProxy[]`	False	Named	False
Suffix	Specifies the suffix that will be appended to the name of the VM you are replicating. This name will be used to register the replicated VM on the target server. Note: If you omit this parameter, the replicated VMs will get the `_replica` suffix.	`String`	False	Named	False
TargetNetwork	For network mapping. Specifies an array of networks in the disaster recovery site. VMs that are replicated with the cloud CDP policy will be connected to these networks. Note: The number of source networks must match the number of target networks. Accepts the `VBRViNetworkInfo[]` object. To get this object, run the `Get-VBRViServerNetworkInfo` cmdlet.	`VBRCloudServerNetworkInfo[]`	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 VBRCloudCDPPolicy object that contains cloud CDP policy settings.

Examples

Modifying Source Proxies for Cloud CDP Policy

This example shows how to change the CDP source proxies for the DB_replication cloud CDP policy. The cmdlet will set the Proxy_05 to transfer the replica data.

$policy = Get-VBRCDPPolicy -Name "DB_replication"

$proxy = Get-VBRCDPProxy -Name "Proxy_05"

Set-VBRCloudCDPPolicy -Policy $policy -SourceProxy $proxy

Perform the following steps:

Run the Get-VBRCDPPolicy cmdlet. Specify the Name parameter value. Save the result to the $policy variable.
Run the Get-VBRCDPProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
Run the Set-VBRCloudCDPPolicy cmdlet. Set the $policy variable as the Policy parameter value. Set the $proxy variable as the SourceProxy parameter value.