Set-VBRReplicaApplicationProcessingOptions

Short Description

Modifies guest processing settings for vCD replica jobs and CDP policies.

Applies to

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

Syntax

Set-VBRReplicaApplicationProcessingOptions -ReplicaApplicationProcessingOptions <VBRReplicaApplicationProcessingOptions> [-GuestInteractionProxy <CHost[]>] [-GuestOSCredentials <CCredentials>] [-ApplicationProcessingOptions <VBRApplicationProcessingOptions[]>] [-IndividualGuestOSCredentials <VBRIndividualGuestOSCredentials[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies guest processing settings for vCD replica jobs and CDP policies.

Note

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

ReplicaApplicationProcessingOptions

Specifies guest processing settings that you want to modify.

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

True

Named

False

GuestInteractionProxy

Specifies an arraof of VMs that will be used as guest interaction proxies.

Accepts the CHost[] object. To create this object, run the Get-VBRServer cmdlet.

False

Named

False

GuestOSCredentials

Specifies a user account that will be used to connect to VMs added to the vCD replica jobs or CDP policies and deploy the runtime process on their guest OSes.

Accepts the CCredentials object. To create this object, run the Get-VBRCredentials cmdlet.

False

Named

False

ApplicationProcessingOptions

Specifies application-aware processing settings.

Accepts the VBRApplicationProcessingOptions[] object. To create this object, run the New-VBRApplicationProcessingOptions cmdlet.

False

Named

False

IndividualGuestOSCredentials

Specifies a user account that will be used connect to the specific VMs guest OSes.

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

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 VBRReplicaApplicationProcessingOptions object that defines guest processing settings for CDP policies.

Examples

Modifying Guest Processing Settings for CDP Policies

This example shows how to assign the CDP Admin user account to the WinSrv2073 VM guest OS.

$vm = Find-VBRViEntity -Name "WinSrv2073"

$credentials = Get-VBRCredentials -Name "CDP Admin"

$oscreds = New-VBRIndividualGuestOSCredentials -IndividualMachine $vm -MachineCredentials $credentials

Set-VBRReplicaApplicationProcessingOptions -IndividualGuestOSCredentials $oscreds

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-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
  3. Run the New-VBRCDPPolicyRetentionOptions cmdlet. Specify the IndividualMachine and MachineCredentials  parameters. Save the result to the $oscreds variable.
  4. Run the Set-VBRReplicaApplicationProcessingOptions cmdlet. Set the $oscreds variable as the IndividualGuestOSCredentials parameter value.

Related Commands