Publish-VBRBackupContent - Veeam Backup PowerShell Reference

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
RestorePoint	Specifies a restore point. The cmdlet will publish disks in the state stored in the specified restore point.	Accepts the COib object. To get this object, run the Get-VBRRestorePoint cmdlet.	True	0	True (ByValue, ByPropertyName)
AllowedIps	For Microsoft Windows-based file systems and the manual mount mode. Specifies an array of IP addresses of target servers (iSCSI initiators) that are allowed to access the iSCSI Target Server (mount server). Note: This parameter is required if you do not specify the TargetServerName parameter. After the cmdlet finishes its work, you need to manually start the iSCSI session from any server specified in this parameter to the iSCSI Target Server.	String[]	False	Named	False
DiskNames	Specifies disk names. The cmdlet will publish disks with the specified names. If you do not specify this parameter, the cmdlet will publish all disks from the backup or replica.	String[]	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False
TargetServerName	For the automatic mount mode. Specifies the name of the target server. The cmdlet will give the specified server access to the disk content. Note: You must specify the TargetServerCredentials parameter to provide credentials that Veeam Backup & Replication will use to authenticate against the target server.	String	False	Named	False
TargetServerCredentials	Specifies credentials that the cmdlet will use to authenticate against the target server.	Accepts the CCredentials object. To create this object, run the Add-VBRCredentials cmdlet.	False	Named	False
MountHostId	Specifies the ID of a server that has the mount server role. The mount server acts as an intermediary between the backup repository and the target server. If you specify the ID, the cmdlet will use the specified server as the mount server. If you do not specify the ID, the cmdlet will use the mount server associated with the backup repository where backups are stored. Note: You must add the server with this ID as the mount server to any backup repository in your backup infrastructure. For more information, see the Specify Mount Server Settings section in the Veeam Backup & Replication User Guide.	GUID	False	Named	False
EnableFUSEProtocol	Enables the FUSE protocol. Note: This parameter is required if you want to publish disks with Unix-based file systems.	SwitchParameter	False	Named	False
Reason	Specifies the reason for disk publishing.	String	False	Named	False

This example shows how to allow the 198.51.100.0 server to access the content of the published disks.

$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. Pipe the cmdlet output to the Sort-Object cmdlet and set the CreationTime value as the Property parameter value. Pipe the output to the Select cmdlet to select the last restore point. 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.

This example shows how to publish disks 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. Pipe the cmdlet output to the Sort-Object cmdlet and set the CreationTime value as the Property parameter value. Pipe the output to the Select cmdlet to select the last restore point. Save the result to the $point variable.
Run the Add-VBRCredentials cmdlet. Specify the User and the Password parameter values. Save the result to the $creds variable.
Run the Publish-VBRBackupContent cmdlet. Specify the following settings:

Set the $point variable as the RestorePoint parameter value.

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

This example shows how to publish disks 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. Pipe the cmdlet output to the Sort-Object cmdlet and set the CreationTime value as the Property parameter value. Pipe the output to the Select cmdlet to select the last restore point. Save the result to the $restorepoint variable.
Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $creds variable.
Run the Publish-VBRBackupContent cmdlet. Specify the following settings:

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

Set the $creds variable as the TargetServerCredentials parameter value.

Provide the EnableFUSEProtocol parameter.

This example shows how to publish disks to the WinSrv2049 target server and specify the mount server ID.

$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. Pipe the cmdlet output to the Sort-Object cmdlet and set the CreationTime value as the Property parameter value. Pipe the output to the Select cmdlet to select the last restore point. Save the result to the $point variable.
Run the Add-VBRCredentials cmdlet. Specify the User parameter value. Specify the Password parameter value. Save the result to the $creds variable.
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.