This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRJobVssOptions
Short Description
Applies custom VSS settings to a selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobVssOptions [-Job] <CBackupJob[]> [-Options] <CGuestProcessingOptions> [<CommonParameters>] -OR- Set-VBRJobVssOptions [-Job] <CBackupJob[]> -Credentials <CCredentials> [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet applies a set of customized VSS settings to a selected job.
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.
This cmdlet provides two parameter sets:
- Applying changes to the job VSS settings.
To apply the set of customized settings you need to first create a CVssOptions object which unifies all the VSS options you want to apply to the job. The CVssOptions object is created with the help of the New-VBRJobVssOptions cmdlet.
- Set credentials for the guest OS.
To set the credentials, specify the credentials you want to use for the VMs in the job. The credentials will be used for all VMs in the job.
Run Set-VBRJobObjectVssOptions to apply VSS settings to specific VMs in job.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Job | Specifies the job you want to edit. | True | 1 | True (ByValue, | False |
Options | Specifies the set of parameters you want to apply to the job. Accepts the CVssOptions object. | True | 2 | False | False |
Credential | Specifies the credentials you want to use for authenticating with the guest VM. Accepts the CCredentials object. | 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 command applies custom VSS options to the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions and assigned to the $options variable beforehand.
Example 2
This command applies custom VSS options to the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions and assigned to the $options variable beforehand.
