This is an archive version of the document. To get the most up-to-date information, see the current version.

New-VBRJobVssOptions

On This Page

Short Description
Applies to
Syntax
Detailed Description
Parameters
Example

Short Description

Returns default set of VSS options for job or VM in job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets.

Default VSS settings for backup jobs (including vCloud backup jobs):

New-VBRJobVssOptions [-ForJob] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Default VSS settings for VMs in job:

New-VBRJobVssOptions [-ForObject] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Default VSS settings for replication jobs:

New-VBRJobVssOptions [-ForReplicaJob] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns the CVssOptions object containing default VSS settings for backup jobs, replication jobs or selected VMs. Use an appropriate parameter set for each case.

VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently.

You can modify the settings and use this object to change the VSS settings of a job or VM. Run Set-VBRJobVssOptions to apply the VSS settings to a job.

New-VBRJobVssOptions Tip:

Save the object to a variable when you customize settings: this variable can be used in several jobs.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
ForJob	Returns the list of the default VSS settings for backup, replication or copy job.	False	Named	False	False
ForObject	Returns the list of the default VSS settings for VMs.	False	Named	False	False
ForReplicaJob	Returns the list of the default VSS settings for replication job.	False	Named	False	False

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

Example

This example enables the VSS settings and the Copy only option.

Get the default settings:

PS C:\PS> New-VBRJobVssOptions -ForJob

VssSnapshotOptions : Enabled: [False], IgnoreErrors: [True], IsCopyOnly: [False]

WinGuestFSIndexingOptions : Type: [None]

LinGuestFSIndexingOptions : Type: [None]

SqlBackupOptions : TransactionLogsProcessing: [TruncateOnlyOnSuccessJob], BackupLogsFrequencyMin: [15],

UseDbBackupRetention: [True], RetainDays: [15], ProxyAutoSelect: [True]

GuestScriptsOptions : Veeam.Backup.Model.CGuestScriptsOptions

ExchangeBackupOptions : TransactionLogsProcessing: [TruncateOnlyOnSuccessJob]

WinCredsId : 00000000-0000-0000-0000-000000000000

LinCredsId : 00000000-0000-0000-0000-000000000000

Enabled : False

IgnoreErrors : True

AreWinCredsSet : False

AreLinCredsSet : False

GuestFSIndexingType : None

IncludedIndexingFolders : {}

ExcludedIndexingFolders : {}

LinGuestFSIndexingType : None

LinIncludedIndexingFolders : {}

LinExcludedIndexingFolders : {}

IsFirstUsage : True

m_isFirstUsage : True

Modify the VSS settings.

The output is saved to '$o' variable.

The Enabled setting is set to.
The VssSnapshotOptions for IsCopyOnly is set to.

PS C:\PS> $o = New-VBRJobVssOptions

PS C:\PS> $o.Enabled =

PS C:\Users\Administrator> $o.VssSnapshotOptions.IsCopyOnly =

PS C:\Users\Administrator> $o

VssSnapshotOptions : Enabled: [False], IgnoreErrors: [True], IsCopyOnly: [True]