Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Set-VBRComputerDestinationOptions

Short Description

Modifies the target location for Veeam Agent backup policies.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets:

  • To store backups in the following locations
  • on a removable storage device attached to the protected computer
  • on a local drive of the protected computer

Set-VBRComputerDestinationOptions -Options <VBRComputerDestinationOptions> -LocalPath <string>[<CommonParameters>]

  • To store backups in a network shared folder

Set-VBRComputerDestinationOptions -Options <VBRComputerDestinationOptions> [-NetworkFolderPath <string>] [-TargetShareType <VBRDestinationTargetShareType> {Smb | Nfs}] [-UseNetworkCredentials] [-NetworkCredentials<CCredentials>][<CommonParameters>]

  • To store backups on a backup repository managed by the Veeam backup server

Set-VBRComputerDestinationOptions -Options <VBRComputerDestinationOptions> [-BackupServerName <string>] [-BackupRepository <CBackupRepository>][<CommonParameters>]

Detailed Description

This cmdlet modifies the target location settings for the backup policy that Veeam Agent job applies to the protected computers.

To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Options

Specifies the target location settings that you want to modify.

Accepts the VBRComputerDestinationOptions type.

True

Named

True (ByValue)

 

LocalPath

Use this parameter if you want to keep backups on the following target locations:

  • On a removable storage device attached to a protected computer.
  • On a local drive of a protected computer.

True

Named

False

 

NetworkFolderPath

Use this option if you want to keep backups in a network shared folder.

False

Named

False

 

BackupRepository

Use this option if you want to save a backup on a backup repository managed by the Veeam backup server.

Accepts the BackupRepository type.

True

Named

False

 

TargetShareType

Specifies the protocol that you will use to keep backups on shared folders.

  • SMB
  • NFS

NOTE: The NFS protocol type does not work for Windows computers.

False

Named

False

 

UseNetworkCredentials

Indicates that the network shared folder requires authentication.

False

Named

False

 

NetworkCredentials

Specifies the credentials which Veeam Agent will use to authenticate to the network shared folder.

False

Named

False

 

BackupServerName

Specifies the DNS name or an external IP address of the Veeam backup server that manages the target backup repository.

NOTE: You can use only the Veeam backup server where the Veeam Agent backup job is configured.

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example

This example shows how to modify target location settings for the backup policy that Veeam Agent job applies to the protected computers. The job will save the backups to the backup repository managed by the Veeam backup server.

  1. Run Get-VBRJob to get the backup job that you want to modify. Save the result to the $job variable.
  2. Cast the $job variable to the VBRComputerBackupJob type. Use the [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob value.
  3. Get the DestinationOptions object. Save the result to the $destintation variable.
  4. Cast the $destination variable to the VBRComputerDestinationOptions type. Use the [Veeam.Backup.PowerShell.Infos.VBRComputerDestinationOptions]$ComputerDestinationOptions value. Save the result to the $copmuterdestination variable.
  5. Run Get-VBRBackupRepository to specify the repository. Save the result to the $repository variable.
  6. Run Set-VBRComputerDestinationOptions with the $destination and $repository variables.

$job = Get-VBRJob -Name "Backup_job"

[Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob = $job

$destination = $computerbackupjob.DestinationOptions

[Veeam.Backup.PowerShell.Infos.VBRComputerDestinationOptions]$copmuterdestination = $computerdestination

$repository = Get-VBRBackupRepository -Name "Repository"

Set-VBRComputerDestinationOptions -Options $destination -BackupRepository $repository -BackupServerName "VBR"

Related Commands

New-VBRComputerDestinationOptions

Get-VBRBackupRepository

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation