New-VBRSanIntegrationOptions

Short Description

Defines storage integration for the Veeam Agent backup job.

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

Syntax

New-VBRSanIntegrationOptions [-OsPlatform {Windows | Linux | Mac}] [-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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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.

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.

SwitchParameter

False

Named

False

EnableSanSnapshots

Enables the SanSnapshotsEnabled option: Veeam Backup & Replication will create Veeam Agent backups from native storage snapshots.

Default: False.

SwitchParameter

False

Named

False

Proxy

Specifies the server which will act as a file proxy.

If not specified, Veeam Backup & Replication will select suitable file proxies from your Veeam Backup & Replication environment.

 

Accepts the VBRComputerFileProxyServer object. To get this object, run the Get-VBRComputerFileProxyServer cmdlet.

False

Named

False

EnableFailoverFromSan

Enables the FailoverFromSanEnabled option: Veeam Backup & Replication will failover to a backup operation with a software VSS provider.

Default: True.

SwitchParameter

False

Named

False

 

Output Object

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

Examples

New-VBRSanIntegrationOptionsExample 1. Defining Veeam Agent Integration Settings with Automatic File Proxy Selection

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

New-VBRSanIntegrationOptions -EnableSanSnapshots

New-VBRSanIntegrationOptionsExample 2. Defining Veeam Agent Integration Settings with Certain File Proxy Server

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

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

New-VBRSanIntegrationOptions -Proxy $proxy -EnableSanSnapshots

Perform the following steps:

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

Related Commands

Get-VBRComputerFileProxyServer