New-VBRSanIntegrationOptions

Short Description

Defines storage integration settings for the Veeam Agent backup job.

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

Syntax

New-VBRSanIntegrationOptions [-OsPlatform <VBRAgentType>] [-EnableSanSnapshots]

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

Detailed Description

This cmdlet defines Veeam Agent integration settings of the storage system. You can run this cmdlet to allow Veeam Backup & Replication to create Veeam Agent backups from the storage native snapshots.

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
EnableSanSnapshots	Enables the option to create Veeam Agent backups from native storage snapshots. Default: `False`.	`SwitchParameter`	False	Named	False
OsPlatform	Specifies the OS of protected computers. The cmdlet will define Veeam Agent integration settings of the storage system for these types of computers: `Windows`: for Windows computers. `Linux`: for Linux computers. `Mac`: for macOS computers. `Unix`: for Unix computers. Default: `Windows`. Note: Veeam Agent integration settings of the storage system are not supported for Linux and macOS computers in current version of Veeam PowerShell.	`VBRAgentType`	False	Named	False
Proxy	Specifies the server which will act as a general-purpose backup proxy. If not specified, Veeam Backup & Replication will select suitable general-purpose backup proxies from your Veeam Backup & Replication environment. Accepts the `VBRComputerFileProxyServer` object. To get this object, run the `Get-VBRComputerFileProxyServer`cmdlet.	`VBRComputerFileProxyServer[]`	False	Named	False

<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

New-VBRSanIntegrationOptions Example 1. Defining Veeam Agent Integration Settings with Automatic General-purpose Backup Proxy Selection

This command defines integration settings for the Veeam Agent backup job and allow Veeam Backup & Replication to select suitable backup proxies for data transfer.

New-VBRSanIntegrationOptions -EnableSanSnapshots

New-VBRSanIntegrationOptions Example 2. Defining Veeam Agent Integration Settings with Specific General-purpose Backup Proxy

This example shows how to define integration settings and specify a backup proxy server for data transfer. Veeam Backup & Replication will create Veeam Agent backups from the storage snapshots using the specified backup proxy.

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

New-VBRSanIntegrationOptions -Proxy $proxy -EnableSanSnapshots

Perform the following steps:

Run the Get-VBRComputerFileProxyServer cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
Run the New-VBRSanIntegrationOptions cmdlet. Set the $proxy variable as the Proxy parameter value. Provide the EnableSanSnapshots parameter.

Get-VBRComputerFileProxyServer