Set-VBRJobObjectVssOptions

In this article

    Short Description

    Customizes job VSS settings.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRJobObjectVssOptions [-Object] <CObjectInJob> [-Options] <CVssOptions> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Set-VBRJobObjectVssOptions [-Object] <CObjectInJob> -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet applies a set of customized VSS settings to the specific objects in job or sets credentials to authenticate with a specific objects in job.

    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 object. The CVssOptions object is created with the help of the New-VBRJobVssOptions cmdlet.

    Run Set-VBRJobVssOptions to set the VSS options to the whole job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Object

    Specifies the VMs and VM containers for which you want to change VSS settings.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Options

    Specifies the option that you want to change.

    True

    2

    False

    False

    Credentials

    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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This command applies custom VSS options to the VM named "AD_01" included in the backup job named "Active Directory Backup". The job object and the VM object are obtained with Get-VBRJob and Get-VBRJobObject accordingly and piped down. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions ([-ForObject] option) and assigned to the $options variable beforehand.

    Get-VBRJob -Name "Active Directory Backup" | Get-VBRJobObject -Name "AD_01" | Set-VBRJobObjectVssOptions -Options $options

    Example 2

    This command applies custom VSS options to the VMs running Active Directory represented by the $AD_VMs variable. The VMs object is obtained with Get-VBRJobObject and assigned to the variable beforehand. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions ([-ForObject] option) and assigned to the $options variable beforehand.

    Set-VBRJobObjectVssOptions -Object $AD_VMs -Options $options

    Example 3

    This command sets credentials to authenticate with the SQL server included in the SharePoint backup job. The VM object is obtained with Get-VBRJobObject and piped down. The job object to look for the VM in is obtained with Get-VBRJob and assigned to the $SharePointBackup variable beforehand. The credentials record to apply to the VM is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand.

    Get-VBRJobObject -Job $SharePointBackup -Name "SharePoint_SQL" | Set-VBRJobObjectVssOptions -Credentials $Administrator

    Example 4

    This command sets credentials to authenticate with the VM represented by the $SharePoint_SQL variable. The VM object is obtained with Get-VBRJobObject and assigned to the variable beforehand. The credentials record to apply to the VM is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand.

    Set-VBRJobObjectVssOptions -Object $SharePoint_SQL -Credentials $Administrator

    Related Commands

    Get-VBRJobObject

    New-VBRJobVssOptions ([-ForObject])

    Get-VBRCredentials