Stop-VBRvCDReplicaJob

In this article

    Short Description

    Stops vCD replication jobs.

    Applies to

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

    Syntax

    Stop-VBRvCDReplicaJob -Job <VBRvCDReplicaJob[]> [-Gracefully] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet stops vCD replication jobs.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Job

    Specifies an array of vCD replication jobs that you want to stop.

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

    True

    Named

    True (ByValue, ByPropertyName)

    Gracefully

    Defines that the cmdlet will stop vCD replication jobs gracefully.

    SwitchParameter

    False

    Named

    False

    WhatIf

    Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

    SwitchParameter

    False

    Named

    False

    Confirm

    Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    None.

    Examples

    Stopping vCD Replication Jobs

    This example shows how to stop all vCD replication jobs that are added to the backup infrastructure.

    $replicavCD = Get-VBRvCDReplicaJob

    Stop-VBRvCDReplicaJob -Job $replicavCD

    Perform the following steps:

    1. Run the Get-VBRvCDReplicaJob cmdlet. Save the result to the $replicavCD variable.
    2. Run the Stop-VBRvCDReplicaJob cmdlet. Set the $replicavCD variable as the Job parameter value.

    Related Commands

    Get-VBRvCDReplicaJob