Veeam Backup & Replication 12
Veeam PowerShell Reference
Related documents
Search

Start-VBRLinuxGuestItemRestore

Short Description

Restores Linux-based or Unix-based guest OS files.

Important

This cmdlet is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

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

Syntax

Start-VBRLinuxGuestItemRestore [-GuestCredentials <CCredentials>] -Item <VBRFLRFsItem[]> -LinuxFlrObject <VBRLinuxFlrObject> -Overwrite [-RunAsync] [-TargetDirectory <String>] [-TargetHvVm <CHvVmItem>] [-TargetVcdVm <CVcdVmItem>] [-TargetViVm <CViVmItem>] [<CommonParameters>]

Detailed Description

This cmdlet restores Linux-based or Unix-based guest OS files to the source machine. If the source machine is no longer available (for example, it is corrupted or deleted), you can restore guest OS files to a new machine.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

LinuxFlrObject

Specifies a restore session of Linux-based or Unix-based guest OS files. The cmdlet will use this session to restore guest OS files.

Note: The restore session must be started within the current PowerShell session.

Accepts the VBRLinuxFlrObject object. To create this object, run the Start-VBRLinuxFileRestore cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Item

Specifies an array of files and folders that are available on disks of Linux-based or Unix-based machines. The cmdlet will restore these files and folders.

Accepts the VBRFLRFsItem[] object. To create this object, run the Get-VBRLinuxGuestItem cmdlet.

True

Named

False

Overwrite

Defines that the cmdlet will overwrite existing files and folders with files and folders from a backup.

If you set this parameter to the $false value, the cmdlet will not replace exiting files and folders. It will add the restored files and folders with the _restored postfix to the target machine.

SwitchParameter

True

Named

False

GuestCredentials

Specifies the credentials to authenticate against the target machine.

Accepts the CCredentials object. To create this object, run the Get-VBRCredentials cmdlet.

False

Named

False

TargetViVm

For performing restore the VMware platform.

Specifies a target machine to which the cmdlet will restore guest OS files.

Note: This parameter will work only if source machine is restored or deleted.

Accepts the CViVmItem object. To create this object, run the Find-VBRViEntity cmdlet.

False

Named

False

TargetVcdVm

For performing restore to the vCloud Director platform.

Specifies a target machine to which the cmdlet will restore guest OS files.

Note: This parameter will work only if source machine is restored or deleted.

Accepts the CVcdVmItem object. To create this object, run the Find-VBRvCloudEntity cmdlet.

False

Named

False

TargetHvVm

For performing restore to the Hyper-V platform.

Specifies a target machine to which the cmdlet will restore guest OS files.

Note: This parameter will work only if source machine is restored or deleted.

Accepts the CHvVmItem object. To create this object, run the Find-VBRHvEntity cmdlet.

False

Named

False

TargetDirectory

Specifies the path to a folder on the target VM to which you want to restore files.

String

False

Named

False

RunAsync

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

SwitchParameter

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 CRestoreTaskSession object that contains setting of an operation that you perform to restore Linux-based or Unix-based guest OS files to the source machine.

Examples

Start-VBRLinuxGuestItemRestoreExample 1. Restoring Linux-Based or Unix-Based Guest OS Files to Original Location

This example shows how to restore Linux-based or Unix-based guest OS files of the UbuntuSrv VM to the original host with the following settings:

  • The cmdlet will overwrite existing files and folders.
  • The cmdlet will use the LinSrv05 machine as a helper appliance.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$server = Get-VBRServer -Name "LinSrv05"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -MountServer $server

$root = Get-VBRLinuxGuestItem -LinuxFlrObject $session

$child = Get-VBRLinuxGuestItem -LinuxFlrObject $session -ParentItem $root

$creds = Get-VBRCredentials

Start-VBRLinuxGuestItemRestore -LinuxFlrObject $session -Item $child[5] -GuestCredentials $creds -Overwrite

Perform the following steps:

  1. Mount the disk and get the OS files:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  3. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  4. Run the Start-VBRLinuxFileRestore cmdlet. Specify the RestorePoint and MountServer parameter values. Save the result to the $session variable.
  5. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject parameter value. Save the result to the $root variable.
  6. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject and ParentItem parameter values. Save the result to the $child variable.

The Get-VBRLinuxGuestItem cmdlet will return an array of files and folders. Mind the ordinal number of the necessary item (in our example, it is the fourth item in the array).

  1. Run the Get-VBRCredentials cmdlet. Save the result to the $creds variable.
  1. Run the Start-VBRLinuxGuestItemRestore cmdlet. Specify the following settings:
  • Set the $session variable as the LinuxFlrObject parameter value.
  • Set the $child variable as the Item parameter value.
  • Set the $creds variable as the GuestCredentials parameter value.
  • Provide the Overwrite parameter.

Start-VBRLinuxGuestItemRestoreExample 2. Restoring Linux-Based or Unix-Based Guest OS Files to VMware Platform

This example shows how to restore Linux-based or Unix-based guest OS files of the UbuntuSrv VM to the UbuntuSrv07 that is located on the VMware platform with the following settings:

  • The cmdlet will add the restored files and folders with the _restored postfix to the UbuntuSrv VM.
  • The cmdlet will use the LinSrv05 machine as a helper appliance.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$server = Get-VBRServer -Name "LinSrv05"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -MountServer $server

$root = Get-VBRLinuxGuestItem -LinuxFlrObject $session

$child = Get-VBRLinuxGuestItem -LinuxFlrObject $session -ParentItem $root

$targetvm = Find-VBRViEntity -Name UbuntuSrv07

Start-VBRLinuxGuestItemRestore -LinuxFlrObject $session -Item $child[5] -TargetViVm $targetvm -Overwrite

Perform the following steps:

  1. Mount the disk and get the OS files:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  3. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  4. Run the Start-VBRLinuxFileRestore cmdlet. Specify the RestorePoint and MountServer parameter values. Save the result to the $session variable.
  5. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject parameter value. Save the result to the $root variable.
  6. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject and ParentItem parameter values. Save the result to the $child variable.

The Get-VBRLinuxGuestItem cmdlet will return an array of files and folders. Mind the ordinal number of the necessary item (in our example, it is the fourth item in the array).

  1. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $targetvm variable.
  1. Run the Start-VBRLinuxGuestItemRestore cmdlet. Specify the following settings:
  • Set the $session variable as the LinuxFlrObject parameter value.
  • Set the $child variable as the Item parameter value.
  • Set the $targetvm variable as the TargetViVm parameter value.
  • Provide the Overwrite parameter.

Start-VBRLinuxGuestItemRestoreExample 3. Restoring Linux-Based or Unix-Based Guest OS Files to vCloud Director Platform

This example shows how to restore Linux-based or Unix-based guest OS files of the UbuntuSrv VM to the UbuntuSrv04 that is located on the vCloud Director platform. The cmdlet will add the restored files and folders with the _restored postfix to the UbuntuSrv04 VM.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$mountserver = Get-VBRServer -Name "LinSrv05"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -MountServer $mountserver

$root = Get-VBRLinuxGuestItem -LinuxFlrObject $session

$child = Get-VBRLinuxGuestItem -LinuxFlrObject $session -ParentItem $root

$targetvm = Find-VBRvCloudEntity -Name "UbuntuSrv04"

Start-VBRLinuxGuestItemRestore -LinuxFlrObject $session -Item $child[5] -TargetVcdVm $targetvm -Overwrite:$false

Perform the following steps:

  1. Start the restore session and get the OS files:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  3. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $mountserver variable.
  4. Run the Start-VBRLinuxFileRestore cmdlet. Specify the RestorePoint and MountServer parameter values. Save the result to the $session variable.
  5. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject parameter value. Save the result to the $root variable.
  6. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject and ParentItem parameter values. Save the result to the $child variable.

The Get-VBRLinuxGuestItem cmdlet will return an array of files and folders. Mind the ordinal number of the necessary item (in our example, it is the fourth item in the

  1. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $targetvm variable.
  1. Run the Start-VBRLinuxGuestItemRestore cmdlet. Specify the following settings:
  • Set the $session variable as the LinuxFlrObject parameter value.
  • Set the $items variable as the Item parameter value.
  • Set the $targetvm variable as the TargetVcdVm parameter value.
  • Set :$false as the Overwrite parameter value.

Start-VBRLinuxGuestItemRestoreExample 4. Restoring Linux-Based or Unix-Based Guest OS Files to Hyper-V Platform

This example shows how to restore Linux-based or Unix-based guest OS files of the UbuntuSrv VM to the UbuntuSrv07 that is located on the Hyper-V platform. The cmdlet will add the restored files and folders with the _restored postfix to the UbuntuSrv VM.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$server = Get-VBRServer -Name "LinSrv05"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -MountServer $server

$root = Get-VBRLinuxGuestItem -LinuxFlrObject $session

$child = Get-VBRLinuxGuestItem -LinuxFlrObject $session -ParentItem $root

$targetvm = Find-VBRHvEntity -HostsAndVMs -Name "UbuntuSrv07"

Start-VBRLinuxGuestItemRestore -LinuxFlrObject $session -Item $items[5] -TargetHvVm $targetvm -Overwrite:$false

Perform the following steps:

  1. Start the restore session and get the OS files:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  3. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  4. Run the Start-VBRLinuxFileRestore cmdlet. Specify the RestorePoint and MountServer parameter values. Save the result to the $session variable.
  5. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject parameter value. Save the result to the $root variable.

The Get-VBRLinuxGuestItem cmdlet will return an array of files and folders. Mind the ordinal number of the necessary item (in our example, it is the fourth item in the array).

  1. Run the Get-VBRLinuxGuestItem cmdlet. Specify the LinuxFlrObject and ParentItem parameter values. Save the result to the $child variable
  1. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $targetvm variable.
  1. Run the Start-VBRLinuxGuestItemRestore cmdlet. Specify the following settings:
  • Set the $session variable as the LinuxFlrObject parameter value.
  • Set the $items variable as the Item parameter value.
  • Set the $targetvm variable as the TargetHvVm parameter value.
  • Set :$false as the Overwrite parameter value.

Related Commands

View all results across Veeam
Back to document search