Get-VBRJobObjectVssOptions

In this article

    Short Description

    Returns VSS settings of a specific VM in job.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRJobObjectVssOptions [-ObjectInJob] <CObjectInJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns VSS settings set for a specific VM in job.

    Run  Get-VBRJobVssOptions to get the list of VSS options of a specific job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    ObjectInJob

    Specifies the VMs or VM containers for which you want to get VSS options.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    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 looks for the VSS settings of the first VM included in job named "Exchange Backup Copy". The job to look for the VM in is obtained with Get-VBRJob and piped down. The VM is obtained with Get-VBRJobObject by selecting the first VM in the job object list and piped down.

    Get-VBRJob -Name "Exchange Backup Copy" | Get-VBRJobObject | Select -First 1 | Get-VBRJobObjectVssOptions

    Example 2

    This command looks for the VSS settings of the VM represented by the $vm variable. The VM is obtained with Get-VBRJobObject and assigned to the variable beforehand.

    Get-VBRJobObjectVssOptions -ObjectInJob $vm

    Related Commands

    Get-VBRJobObject