Publish-VBRBackupContent

Short Description

Mounts the content of backup files using the iSCSI protocol.

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Publish-VBRBackupContent [-RestorePoint] <COib> [-AllowedIps <string[]>] [-DiskNames <string[]>] [-RunAsync][-TargetServerName <string>] [-TargetServerCredentials <CCredentials>] [-MountHostId <guid>] [-Reason <string>][<CommonParameters>]

Detailed Description

This cmdlet mounts the content of backup files using the iSCSI protocol. You can mount the following types of backed-up data:

  • VM backups
  • VM replicas
  • VM disks

The following environments and backup solutions are supported:

  • Hyper-V
  • VMWare
  • Veeam Agent For Windows
  • Veeam Agent For Linux

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies a restore point. The cmdlet will mount the content of backup files from this restore point.

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

True

0

True (ByValue, ByPropertyName)

AllowedIps

Specifies an array of IP addresses for iSCSI target servers that are allowed to access the content of the backup.

Note: This parameter is required if you do not specify the TargetServerName parameter.

String[]

False

Named

False

DiskNames

Specifies a VM disk name. The cmdlet will mount that VM disk to the iSCSI target server.

String[]

False

Named

False

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

SwitchParameter

False

Named

False

TargetServerName

Specifies a name of the iSCSI target mount server. The cmdlet will mount the content of backup files to that server.

Note: Mind the following:

  • This parameter works for Windows VMs only.
  • You must specify the TargetServerCredentials parameter to provide credentials that Veeam Backup & Replication will use to authenticate against the target mount server.

String

False

Named

False

TargetServerCredentials

Specifies credentials that Veeam Backup & Replication will use to authenticate against the iSCSI target server.

CCredentials

False

Named

False

MountHostId

Specifies the mount host ID. Veeam Backup & Replication will use this ID to mount the content of a backup to the iSCSI target server.

Guid

False

Named

False

Reason

Specifies a reason for mounting the backup files content.

String

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.

Output Object

The cmdlet returns the VBRBackupContent object that contains settings of mounted backed-up files.

Examples

Publish-VBRBackupContentExample 1. Mounting Backed-up Files to iSCSI Target Server With Specific IP

This example shows how to mount backed-up files to the 198.51.100.0 iSCSI target server.

$backup = Get-VBRBackup -Name "Webservers Backup Job"

$point = Get-VBRRestorePoint -Backup $backup -Name "Webserver03"

Publish-VBRBackupContent -RestorePoint $point -AllowedIps "198.51.100.0" -RunAsync

Perform the following steps:

  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
  2. Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Name parameter value. Save the result to the $point variable.
  3. Run the Publish-VBRBackupContent cmdlet. Specify the following settings:
  • Set the $point variable as the RestorePoint parameter value.
  • Specify the AllowedIps parameter value.
  • Provide the RunAsync parameter.

Publish-VBRBackupContentExample 2. Mounting Backed-up Files to iSCSI Target Mount Server

This example shows how to mount backed-up files to the WinSrv2049 iSCSI target server.

$backup = Get-VBRBackup -Name "Webservers Backup Job"

$point = Get-VBRRestorePoint -Backup $backup -Name "Webserver03"

$creds = Add-VBRCredentials -User "WinSrv2049\Administrator" -Password "Pa$$w0rd"

Publish-VBRBackupContent -RestorePoint $point -TargetServerName "WinSrv2049" -TargetServerCredentials $creds

Perform the following steps:

  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
  2. Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Name parameter value. Save the result to the $point variable.
  3. Run the Add-VBRCredentials cmdlet. Specify the User parameter value. Specify the Password parameter value.
  4. Run the Publish-VBRBackupContent cmdlet. Specify the following settings:
  • Set the $point variable as the RestorePoint parameter value.
  • Specify the AllowedIps parameter value.
  • Provide the RunAsync parameter.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.