This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRComputerDestinationOptions
Short Description
Modifies the target location for Veeam Agent backup policies.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
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 in 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 | Accept |
|---|---|---|---|---|---|
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:
| 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 either of the following types of a backup repository:
Accepts the BackupRepository type. | True | Named | False |
|
TargetShareType | Specifies the protocol that you will use to keep backups on shared folders.
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 on common parameters, see the About CommonParameters section of Microsoft Docs.
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.
- Run Get-VBRComputerBackupJob to get the backup job that you want to modify. Save the result to the $job variable.
- Get the DestinationOptions property of the $job variable. Save the result to the $destintation variable.
- Run Get-VBRBackupRepository to specify the repository. Save the result to the $repository variable.
- Run the Set-VBRComputerDestinationOptions cmdlet. Set the $destination variable as the Options parameter value. Set the $repository variable as the BackupRepository parameter value.
$job = Get-VBRComputerBackupJob -Name "WinPolicy" $destination = $job.DestinationOptions $repository = Get-VBRBackupRepository -Name "Repository" Set-VBRComputerDestinationOptions -Options $destination -BackupRepository $repository |
Related Commands
