Add-VSBHvJob

In this article

    Short Description

    Creates a Hyper-V SureBackup job.

    Applies to

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Add-VSBHvJob [-Name <String>] -VirtualLab <CHvSbVirtualLab> [-AppGroup <CSbAppGroup>] [-LinkedJob <CBackupJob[]>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new Hyper-V SureBackup job.

    Note that when you create a SureBackup job, you need to run it manually unless you enable a job schedule.

    Run the Start-VSBJob cmdlet to start the created SureBackup job.

    Run the Set-VSBJobScheduleOptions cmdlet to set schedule for the SureBackup job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the name you want to assign to the SureBackup job.

    False

    Named

    False

    False

    VirtualLab

    Specifies the virtual lab you want to use for verification.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    AppGroup

    Specifies the application group you want to use to provide the copy of the production environment of the verified VM.

    If you do not use an application group, make sure that the -LinkedJob parameter is set.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    LinkedJob

    Specifies the array of backup, replication or copy jobs containing VMs you want to verify.

    If you do not use a linked backup job, make sure that the -AppGroup parameter is set.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Description

    Specifies the description of the new SureBackup job.

    False

    Named

    False

    False

    <CommonParameters>

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

    Example 1

    This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The VM to verify is obtained by searching for the backup job named "Exchange Backup Job" with Get-VBRJob, and piped down. The virtual lab and the application group objects are obtained with Get-VSBHvVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $ExchangeAppgroup variables accordingly beforehand.

    Get-VBRJob -Name "Exchange Backup Job" | Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $ExchangeAppgroup

    Example 2

    This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The virtual lab and application group objects are obtained with Get-VSBHvVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $ExchangeAppgroup variables accordingly beforehand.

    Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $ExchangeAppgroup

    Example 3

    This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and an application group. The virtual lab object is obtained with Get-VSBHvVirtualLab and piped down. The VM to verify is included into the application group, the application group object is obtained with Get-VSBApplicationGroup and assigned to the $ExchangeAppgroup variable beforehand.

    Get-VSBHvVirtualLab -Name "Exchange VLab 01" | Add-VSBHvJob -Name "Exchange SureJob" -AppGroup $ExchangeAppgroup

    Example 4

    This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and a linked job. The virtual lab object is obtained with Get-VSBHvVirtualLab and assigned to $VLab01 variable beforehand. The VM to verify is obtained with Get-VBRJob and assigned to the $ExchangeBackup variable beforehand.

    Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 -LinkedJob $ExchangeBackup

    Related Commands

    Get-VSBHvVirtualLab

    Get-VSBApplicationGroup

    Get-VBRJob