Get-VBRJobOptions

Short Description

Returns job settings.

Applies to

Platform: VMware, Hyper-V

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

Syntax

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

Detailed Description

This cmdlet returns job settings for a selected job.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Job

Specifies the job. The cmdlet will return settings of this job.

Accepts the CBackupJob[] object. To create this object, run the Get-VBRJob cmdlet.

True

0

True (ByProperty
Name, ByValue)

<CommonParameters>

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

Examples

Get-VBRJobOptionsExample 1. Looking for List of Options of the Specific Job [Using Pipeline]

This example shows how to look for the list of options of the Fileserver Replica job.

Get-VBRJob -Name "Fileserver Replica" | Get-VBRJobOptions

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Get-VBRJobOptions cmdlet.

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

This example shows how to look for the list of options of the Fileserver Replica job.

$fileserver_replica_job = Get-VBRJobObject -Name "Fileserver Replica"

Get-VBRJobOptions -Job $fileserver_replica_job

Perform the following steps:

  1. Run the Get-VBRJobObject cmdlet. Specify the Name parameter value. Save the result to the $fileserver_replica_job variable.
  2. Run the Get-VBRJobOptions cmdlet. Set the $fileserver_replica_job variable as the Job parameter value.

Related Commands

Page updated 2/29/2024

Page content applies to build 12.3.0.310