This is an archive version of the document. To get the most up-to-date information, see the current version.

Publish-VBRBackupContent

Short Description

Mounts the content of backup files using the iSCSI or FUSE protocol.

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

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 or FUSE protocol. You can mount the following types of backed-up data:

VM backups
Computer backups
VM replicas

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	For the automatic mount session option. Specifies a name of the iSCSI target mount server. The cmdlet will mount the content of backup files to that server. Note: You must specify the TargetServerCredentials parameter to provide credentials that Veeam Backup & Replication will use to authenticate against the target mount server. For Linux-based VMs it is a host to which you publish the backup content.	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. Note: You must add this mount host as a mount server to any backup repository in your backup infrastructure.	Guid	False	Named	False
EnableFUSEProtocol	Enables the FUSE protocol. Note: This parameter is required if you want to mount Unix-based backups on a unix-based server, because iSCSI protocol is not supported in this case.	SwitchParameter	False	Named	False
Reason	Specifies a reason for mounting the backup files content.	String	False	Named	False

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-VBRBackupContent Example 1. Mounting Content of Backed-Up Files to iSCSI Target Server With Specific IP

This example shows how to allow the 198.51.100.0 host to access the mounted content of backed-up files.

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

$point = Get-VBRRestorePoint -Backup $backup -Name "Webserver03" | Sort-Object –Property CreationTime | Select -Last 1

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

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
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.
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-VBRBackupContent Example 2. Mounting Content of Backed-Up Files Automatically

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

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

$point = Get-VBRRestorePoint -Backup $backup -Name "Webserver03" | Sort-Object –Property CreationTime | Select -Last 1

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

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

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
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.
Run the Add-VBRCredentials cmdlet. Specify the User parameter value. Specify the Password parameter value.
Run the Publish-VBRBackupContent cmdlet. Specify the following settings:

Set the $point variable as the RestorePoint parameter value.

Specify the TargetServerName parameter value.
Specify the TargetServerCredentials parameter value.

Publish-VBRBackupContent Example 3. Mounting Content of Backed-Up Files to Linux Server

This example shows how to mount the content of backed-up files to the 192.0.8.1 Linux server.

$backup = Get-VBRBackup -Name "LinSrv2049"

$restorepoint = Get-VBRRestorePoint -Backup $backup | Sort-Object –Property CreationTime | Select -Last 1

$creds = Get-VBRCredentials -Name "LinAdministrator"

$session = Publish-VBRBackupContent -RestorePoint $restorepoint -TargetServerName 192.0.8.1 -TargetServerCredentials $creds -EnableFUSEProtocol

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Name parameter value. Save the result to the $restorepoint variable.
Run the Add-VBRCredentials cmdlet. Specify the Name parameter value. Specify the Password parameter value.
Run the Publish-VBRBackupContent cmdlet. Specify the following settings:

Set the $restorepoint variable as the RestorePoint parameter value.
Specify the TargetServerName parameter value.
Specify the TargetServerCredentials parameter value.
Provide the EnableFUSEProtocol parameter.

Publish-VBRBackupContent Example 4. Mounting Content of Backed-Up Files to iSCSI Target Mount Server with Specific Mount Host ID

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

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

$point = Get-VBRRestorePoint -Backup $backup -Name "Webserver03" | Sort-Object –Property CreationTime | Select -Last 1

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

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

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
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.
Run the Add-VBRCredentials cmdlet. Specify the User parameter value. Specify the Password parameter value.
Run the Publish-VBRBackupContent cmdlet. Specify the following settings:

Set the $point variable as the RestorePoint parameter value.
Specify the TargetServerName parameter.
Set the $creds variable as the TargetServerCredentials parameter value.
Specify the MountHostId parameter.

Related Commands