Add-VBRvCDCloudCDPPolicy

Short Description

Creates a VDC СDP policy.

Applies to

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

Syntax

Add-VBRvCDCloudCDPPolicy -Entity <IViItem[]> -OrganizationvDC <VBRvCDCloudOrganizationvDC> [-vApp <VBRvCDCloudvApp>] [-StoragePolicy <VBRvCDCloudStoragePolicy>] [-Name <String>] [-Description <String>] [-Suffix <String>] [-SourceProxy <VBRCDPProxy[]>] [-NotificationOptions <VBRNotificationOptions>] [-RetentionOptions <VBRCDPPolicyRetentionOptions>] [-GuestProcessingOptions <VBRReplicaApplicationProcessingOptions>] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRvCDCloudNetworkInfo[]>] [-RepositorySeed <CBackupRepository>] [-OriginalVM <CViVmItem[]>] [-ReplicaVM <VBRvCDCloudVM[]>] [-Force] [-HighPriority]  [<CommonParameters>]

Detailed Description

This cmdlet creates a VDC СDP policy.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Entity

Specifies the array of VMs you want to add to a VDC СDP policy.

Accepts the IViItem[] object. To create this object, run the Find-VBRViEntity cmdlet.

True

Named

True (ByValue)

OrganizationvDC

Specifies the cloud organization VDC. The VDC СDP policy will store replicas in the selected organization VDC.

Accepts the VBRvCDCloudOrganizationvDC object. To get this object, run the Get-VBRvCDCloudOrganizationvDC cmdlet.

True

Named

False

vApp

Specifies the vApp container. The VDC СDP policy will store the replicas in the selected container.

Note: If you do not specify the vApp container, the job will store the replicas in the default vApp.

Accepts the VBRvCDCloudvApp object. To get this object, run the Get-VBRvCDCloudvApp cmdlet.

False

Named

False

StoragePolicy

Specifies the vCD cloud storage policy. The VDC СDP policy will create replicas according to this storage policy settings.

Accepts the VBRvCDCloudStoragePolicy object. To get this object, run the Get-VBRvCDCloudStoragePolicy cmdlet.

False

Named

False

Name

Specifies a name you want to assign to a VDC СDP policy.

String

False

Named

False

Description

Specifies a description of a VDC СDP policy.

String

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

SourceProxy

Used for building a replica from backup files.

Specifies the backup repository that will be used to read the VM data from the already existing backup chain.

Note: You cannot specify a cloud repository.

Accepts the VBRCDPProxy[] object. To get this object, run the Get-VBRCDPProxy cmdlet.

False

Named

False

NotificationOptions

Specifies notification settings of a CDP policy.

Accepts the VBRNotificationOptions object. To create this object, run the New-VBRNotificationOptions cmdlet.

False

Named

False

RetentionOptions

Specifies retention settings of a CDP policy.

Accepts the VBRCDPPolicyRetentionOptions object. To create this object, run the New-VBRCDPPolicyRetentionOptions cmdlet.

False

Named

False

GuestProcessingOptions

Specifies guest processing settings of a CDP policy.

Accepts the VBRReplicaApplicationProcessingOptions object. To create this object, run the New-VBRReplicaApplicationProcessingOptions cmdlet.

False

Named

False

SourceNetwork

For network mapping.

Specifies an array of production networks to which the VMs added to a VCD 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.

False

Named

False

TargetNetwork

For network mapping.

Specifies an array of networks in the disaster recovery site. VMs that are replicated with the VCD 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.

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.

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.

False

Named

False

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.

False

Named

False

Force

Defines that the cmdlet will create a VCD CDP policy without showing warnings in the PowerShell console.

SwitchParameter

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

<CommonParameters>

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

Output Object

The cmdlet returns the VBRvCDCloudCDPPolicy object that contains VDC СDP policy settings.

Examples

Creating Cloud VDC CDP Policy

This example shows how to create the DHCP_replicant cloud VDC CDP policy.

$vm = Find-VBRViEntity -Name "DB server"

$organization =  Get-VBRvCDCloudOrganizationvDC

$vApp = Get-VBRvCDCloudvApp

$storagepolicy = Get-VBRvCDCloudStoragePolicy

Add-VBRvCDCloudCDPPolicy -Entity $vm -OrganizationvDC $organization -vApp $vApp -StoragePolicy $storagepolicy -Name "DHCP_replicant" -Description "DHCP replica"

Perform the following steps:

  1. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $vm variable.
  2. Run the Get-VBRvCDCloudOrganizationvDC cmdlet. Save the result to the $host variable.

The Get-VBRCloudServer cmdlet will return an array of hosts. Mind the ordinal number of the necessary host (in our example, it is the fourth host in the array).

  1. Run the Get-VBRvCDCloudvApp cmdlet. Save the result to the $datastore variable.

The Get-VBRCloudDatastore cmdlet will return an array of datastores. Mind the ordinal number of the necessary datastore (in our example, it is the fourth datastore in the array).

  1. Run the Get-VBRvCDCloudStoragePolicy cmdlet. Save the result to the $storagepolicy variable.

The Get-VBRvCDCloudStoragePolicy cmdlet will return an array of storage policies. Mind the ordinal number of the necessary storage policy (in our example, it is the storage policy in the array).

  1. Run the Add-VBRCloudCDPPolicy cmdlet. Specify the following settings:
  • Set the $vm variable as the Entity parameter value.
  • Set the $organization variable as the OrganizationvDC parameter value.
  • Set the $vApp variable as the vApp parameter value.
  • Set the $storagepolicy variable as the StoragePolicy parameter value.
  • Specify the Name parameter value.
  • Specify the Description parameter value.

Related Commands