Set-VBRvCDCDPPolicy
Short Description
Modifies a Cloud Director CDP policy.
Applies to
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRvCDCDPPolicy -Policy <VBRvCDCDPPolicy> [-Name <string>] [-Description <string>] [-SourceObject <IVcdItem[]>] [-ExcludedObject <IVcdItem[]>] [-EnableNetworkMapping] [-SourceNetwork <VBRvCDOrgVdcNetworkInfo[]>] [-TargetNetwork <VBRvCDOrgVdcNetworkInfo[]>] [-EnableInitialSeeding] [-RepositorySeed <CBackupRepository>] [-EnableReplicaMapping] [-OriginalVApp <CVcdVappItem[]>] [-ReplicaVApp <CVcdVappItem[]>] [-SourceProxy <VBRCDPProxy[]>] [-TargetProxy <VBRCDPProxy[]>] [-Suffix <string>] [-EnableApplicationProcessing] [-GuestProcessingOptions <VBRReplicaApplicationProcessingOptions>] [-CompressionLevel {None | DedupeFriendly | Optimal | High | Extreme}] [-NotificationOptions <VBRNotificationOptions>] [-RetentionOptions <VBRCDPPolicyRetentionOptions>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies a Cloud Director 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
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Policy | Specifies the Cloud Director CDP policy that you want to modify. | Accepts the VBRvCDCDPPolicy object. To get this object, run the Get-VBRCDPPolicy cmdlet. | True | Named | True (ByValue) |
Name | Specifies a name for the CDP policy. The cmdlet will replace the CDP policy name with this name. | String | False | Named | False |
Description | Specifies a description for the CDP policy. The cmdlet will replace the CDP policy description with this description. | String | False | Named | False |
SourceObject | Specifies an array of the vApps that you want to protect. | Accepts the IVcdItem[] object. To get this object, run the Find-VBRvCloudEntity cmdlet. | False | Named | False |
ExcludedObject | Specifies an array of VM containers that you want to exclude from the CDP policy. You can exclude the following types of Cloud Director source objects:
| Accepts the IVcdItem[] object. To get this object, run the Find-VBRvCloudEntity cmdlet. | False | Named | False |
EnableNetworkMapping | Enables network mapping. | SwitchParameter | False | Named | False |
SourceNetwork | For the network mapping functionality. Specifies an array of the production networks to which the vApps are connected. Note: The number of the source and the target networks must be the same. | Accepts the VBRvCDOrgVdcNetworkInfo[] object. To get this object, run the Get-VBRVCDOrgVdcNetworkInfo cmdlet. | False | Named | False |
TargetNetwork | For the network mapping functionality. Specifies an array of the networks in the Disaster Recovery site. The replicated vApps will be connected to these networks. Note: The number of the source and the target networks must be the same. | Accepts the VBRvCDOrgVdcNetworkInfo[] object. To get this object, run the Get-VBRVCDOrgVdcNetworkInfo cmdlet. | False | Named | False |
EnableInitialSeeding | Enables replica seeding. | SwitchParameter | False | Named | False |
RepositorySeed | For the replica seeding functionality. Specifies the backup repository that keeps the full backups of vApps that you want to replicate. | Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet. | False | Named | False |
EnableReplicaMapping | Enables the replica mapping functionality. | SwitchParameter | False | Named | False |
OriginalVApp | For the replica mapping functionality. Specifies an array of productions vApp for which you plan to use replica mapping. The CDP policy will map these vApps to the vApps in the disaster recovery site. Use the ReplicaVApp parameter to specify the vApps in the disaster recovery site. | Accepts the CVcdVappItem[] object. To get this object, run the Find-VBRvCloudEntity cmdlet. | False | Named | False |
ReplicaVApp | For the replica mapping functionality. Specifies an array of vApps in the disaster recovery site. The cmdlet will map the production vApps to these vApps and will use these vApps as replicas. Use the OriginalVApp parameter to specify the vApps in the production site. | Accepts the CVcdVappItem[] object. To get this object, run the Find-VBRvCloudEntity cmdlet. | False | Named | False |
SourceProxy | Specifies an array of the VMware CDP proxy in the production site that you want to assign to the CDP policy. Default: Automatic selection. | Accepts the VBRCDPProxy[] object. To get this object, run the Get-VBRCDPProxy cmdlet. | False | Named | False |
TargetProxy | Specifies an array of the target VMware CDP proxies that you want to assign to the CDP policy. Default: Automatic selection. | Accepts the VBRCDPProxy[] object. To get this object, run the Get-VBRCDPProxy cmdlet. | False | Named | False |
Suffix | Specifies the suffix that the cmdlet will add to the name of vApps replicated with CDP policies. | String | False | Named | False |
EnableApplicationProcessing | Enables guest processing settings for the CDP policy. Use the GuestProcessingOptions parameter to specify the guest processing settings. | SwitchParameter | False | Named | False |
GuestProcessingOptions | Specifies guest processing options. | Accepts the VBRReplicaApplicationProcessingOptions object. To create this object, run the New-VBRReplicaApplicationProcessingOptions cmdlet. | False | Named | False |
CompressionLevel | Specifies the compression level for the replicated data:
| VBRCompressionLevel | False | Named | False |
NotificationOptions | Specifies notification options of the CDP policy. | Accepts the VBRNotificationOptions object. To create this object, run the New-VBRNotificationOptions cmdlet. | False | Named | False |
RetentionOptions | Specifies retention settings. | Accepts the VBRCDPPolicyRetentionOptions object. To create this object, run the New-VBRCDPPolicyRetentionOptions cmdlet. | False | Named |
|
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBRvCDCDPPolicy object that defines settings of the CDP policy.
Examples
Creating Cloud Director CDP Policy
This example shows how to modify the compression level for the replicated data. The cmdlet will set the compression level to dedupe-friendly compression level.
$policy = Get-VBRCDPPolicy Set-VBRvCDCDPPolicy -Policy $policy -CompressionLevel DedupeFriendly |
Perform the following steps:
- Run the Get-VBRCDPPolicy cmdlet. Specify the Name parameter value. Save the result to the $server variable.
- Run the Set-VBRvCDCDPPolicy cmdlet. Set the $policy variable as the Policy parameter value. Specify the CompressionLevel parameter value.
Related Commands