Get-VBRJobVssOptions

Short Description

Returns VSS settings for a selected job.

Platform: VMware, Hyper-V

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

Syntax

Get-VBRJobVSSOptions [-Job] <CBackupJob[]> [<CommonParameters>]

Detailed Description

This cmdlet returns VSS settings for a selected job.

Run the Get-VBRJobObjectVssOptionsReturns VSS settings of a specific VM in job. cmdlet to get the list of VSS options set for specific objects in a job.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies the job you want to get the VSS options of.

Accepts the CBackupJob object. To create this object, run the Get-VBRJobReturns existing jobs. cmdlet.

CBackupJob[]

True

0

True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Get-VBRJobVssOptionsExample 1. Looking for List of VSS Options of Specific Job [Using Pipeline]

This example shows how to look for the list of VSS options of the ActiveDirectory Backup job.

Get-VBRJob -Name "ActiveDirectory Backup" | Get-VBRJobVSSOptions

Perform the following steps:

  1. Run the Get-VBRJobReturns existing jobs. cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Get-VBRJobVSSOptions cmdlet.

Get-VBRJobVssOptionsExample 2. Looking for List of Options of Job [Using Variable]

This example shows how to look for the list of options of the job represented by the $ad_backup variable.

$ad_backup = Get-VBRJob -Name "ActiveDirectory Backup"

Get-VBRJobVSSOptions -Job $ad_backup

Perform the following steps:

  1. Run the Get-VBRJobReturns existing jobs. cmdlet. Specify the Name parameter value. Save the result to the $ad_backup variable.
  2. Run the Get-VBRJobVSSOptions cmdlet. Set the $ad_backup variable as the Job parameter value.

Page updated 2026-08-19

Page content applies to build 13.1.1.18