Set-VBRSanIntegrationOptions

Short Description

Modifies storage integration settings for the Veeam Agent backup job.

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

Syntax

Set-VBRSanIntegrationOptions -SanIntegrationOptions <VBRSanIntegrationOptions> [-EnableSanSnapshots]

[-Proxy <VBRComputerFileProxyServer[]>] [-EnableSanProxyAutodetect] [-EnableFailoverFromSan] [<CommonParameters>]

Detailed Description

This cmdlet modifies storage integration settings for the Veeam Agent backup job.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
EnableFailoverFromSan	Enables the option for Veeam Backup & Replication to failover to a backup operation with a software VSS provider. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
EnableSanProxyAutodetect	Enables the option to use all backup proxies that are added to your Veeam Backup & Replication environment.	`SwitchParameter`	False	Named	False
EnableSanSnapshots	Enables the option to create Veeam Agent backups from native storage snapshots. Default: `False`.	`SwitchParameter`	False	Named	False
Proxy	Specifies the server which will act as a general-purpose backup proxy. If not specified, the `SanProxyAutodetectEnabled` option must have the `True` value. Accepts the `VBRComputerFileProxyServer` object. To get this object, run the `Get-VBRComputerFileProxyServer` cmdlet.	`VBRComputerFileProxyServer[]`	False	Named	False
SanIntegrationOptions	Specifies the set of storage integration settings which Veeam Backup & Replication will modify. Accepts the `VBRSanIntegrationOptions` object. To get this object, run the `New-VBRSanIntegrationOptions` cmdlet.	`VBRSanIntegrationOptions`	True	Named	True (ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the VBRSanIntegrationOptions object that contains storage integration settings.

Examples

Set-VBRSanIntegrationOptions Example 1. Replacing General-purpose Backup Proxy

This command shows how to replace a general-purpose backup proxy. Veeam Backup & Replication will create Veeam Agent backups from the storage snapshots using a new general-purpose backup proxy.

$job = Get-VBRComputerBackupJob -Name "Daily Backup"

$currentSanIntOpt = $job.SanIntegrationOptions

$proxy = Get-VBRComputerFileProxyServer -Name "File Proxy 02"

Set-VBRSanIntegrationOptions -SanIntegrationOptions $currentSanIntOpt -Proxy $proxy

Perform the following steps:

Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Get the current storage integration settings of the Veeam Agent backup job. Use the VBRSanIntegrationOptions parameter of the $job variable. Save it to the $currentSanIntOpt variable.
Run the Get-VBRComputerFileProxyServer cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
Run the Set-VBRSanIntegrationOptions cmdlet. Set the $currentSanIntOpt variable as the SanIntegrationOptions parameter value. Set the $proxy variable as the Proxy parameter value.

Set-VBRSanIntegrationOptions Example 2. Disabling Storage Integration for Veeam Agent Backup Job

This example shows how to disable storage integration for the Veeam Agent backup job. Veeam Backup & Replication will create Veeam Agent backups using a software VSS provider.

$job = Get-VBRComputerBackupJob -Name "Daily Backup"

$currentSanIntOpt = $job.SanIntegrationOptions

$NewSanIntOpt = Set-VBRSanIntegrationOptions -SanIntegrationOptions $currentSanIntOpt -EnableSanSnapshots:$false

Set-VBRComputerBackupJob -Job $job -SanIntegrationOptions $NewSanIntOpt

Perform the following steps:

Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Get the current storage integration settings of the Veeam Agent backup job. Use the VBRSanIntegrationOptions parameter of the $job variable. Save it to the $currentSanIntOpt variable.
Run the Set-VBRSanIntegrationOptions cmdlet. Set the $currentSanIntOpt variable as the SanIntegrationOptions parameter value. Specify the EnableSanSnapshots parameter value. Save the result to the $NewSanIntOpt variable.
Run the Set-VBRComputerBackupJob cmdlet. Specify the $job variable as the Job parameter value. Set the $NewSanIntOpt variable as the SanIntegrationOptions parameter value.