Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRJobVssOptions

Short Description

Modifies VSS settings for the selected job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides two parameter sets:

  • For modifying the job VSS settings

Set-VBRJobVssOptions [-Job] <CBackupJob[]> [-Options] <CGuestProcessingOptions>  [<CommonParameters>]

  • For modifying the guest OS credentials

Set-VBRJobVssOptions [-Job] <CBackupJob[]> -Credentials <CCredentials>  [<CommonParameters>]

Detailed Description

This cmdlet modifies VSS settings for the selected job.

Run Set-VBRJobObjectVssOptions to apply VSS settings to specific VMs in job.

To modify settings enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the job you want to edit.

True

1

True (ByValue,
ByProperty
Name)

False

Options

Specifies the set of parameters you want to apply to the job.

True

2

False

False

Credential

Specifies the credentials you want to use for authenticating with the guest VM.

True

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to apply new VSS settings for an existing backup job.

  1. Run Get-VBRJob to specify the job. Save the result to the $job variable.
  2. Run New-VBRJobVssOptions to specify the VSS options. Save the result to the $options variable.
  3. Run Set-VBRJobVssOptions with the $job and $options variables.

PS C:\PS> $job = Get-VBRJob -Name "Backup Job 01"

PS C:\PS> $options = New-VBRJobVssOptions -ForJob

PS C:\PS> Set-VBRJobVssOptions -Job $job -Options $options

Example 2

This example shows how to apply new guest OS credentials for an existing backup job.

  1. Run Get-VBRJob to specify the job. Save the result to the $job variable.
  2. Run Get-VBRCredentials to specify the new credentials you want to use for authenticating with the guest VMs. Save the result to the $ccreds variable.
  3. Run Set-VBRJobVssOptions with the $job and $options variables.

PS C:\PS> $job = Get-VBRJob -Name "Backup Job 01"

PS C:\PS> $ccreds = Get-VBRCredentials

PS C:\PS> Set-VBRJobVssOptions -Job $job -Credential $ccreds

Related Commands

Get-VBRJob

New-VBRJobVssOptions

Get-VBRCredentials

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation