Get-VBRJobObjectVssOptions

Short Description

Returns VSS settings of a specific VM in job.

Platform: VMware, Hyper-V

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

Syntax

Get-VBRJobObjectVssOptions [-ObjectInJob] <CObjectInJob> [<CommonParameters>]

Detailed Description

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

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ObjectInJob	Specifies the VMs or VM containers for which you want to get VSS options. Accepts the `CObjectInJob` object. To get this object, run the `Get-VBRJobObject` cmdlet.	`CObjectInJob`	True	0	True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Get-VBRJobObjectVssOptions Example 1. Looking for VSS Settings of VM Included in Specific Job [Using Pipeline]

This example shows how to look for the VSS settings of the first VM included in the Exchange Backup Copy job.

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

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Get-VBRJobObject cmdlet.
Pipe the cmdlet output to the Select. Set the 1 number as the First parameter value.
Pipe the cmdlet output to the Get-VBRJobObjectVssOptions cmdlet.

Get-VBRJobObjectVssOptions Example 2. Looking for VSS Settings of VM [Using Variable]

This example shows how to look for the VSS settings of the VM represented by the $vm variable.

$job = Get-VBRJob -Name "Exchange Backup Copy"

$vm = Get-VBRJobObject -Job $job

Get-VBRJobObjectVssOptions -ObjectInJob $vm

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-VBRJobObject cmdlet. Set the $job variable as the Job parameter value. Save the result to the $vm variable.
Run the Get-VBRJobObjectVssOptions cmdlet. Set the $vm variable as the ObjectInJob parameter value.