Connect-VBRWindowsGuestProductionMachine

Short Description

Connects to the machine where original files and folders reside.

Applies to

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Connect-VBRWindowsGuestProductionMachine -FileRestore <FileRestore> [-GuestCredentials <CCredentials>] [<CommonParameters>]

Detailed Description

Connects to the machine where original files and folders reside. You must launch this cmdlet before comparing files and folders using Compare-VBRWindowsGuestItemsAttributes.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
FileRestore	Specifies a restore session of Microsoft Windows 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 FileRestore object. To create this object, run the Start-VBRWindowsFileRestore cmdlet.	True	Named	False
GuestCredentials	Specifies credentials for the original machine. Note: If you do not specify credentials, the cmdlet will try to use the credentials specified in the backup job that created the backup.	Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

FileRestore

Specifies a restore session of Microsoft Windows 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 FileRestore object. To create this object, run the Start-VBRWindowsFileRestore cmdlet.

True

Named

False

GuestCredentials

Specifies credentials for the original machine.

Note: If you do not specify credentials, the cmdlet will try to use the credentials specified in the backup job that created the backup.

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

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

None.

Examples

This example shows how to connect to a machine whose files you restore.

$backup = Get-VBRBackup -Name "WinSrv25"

$restorepoint = Get-VBRRestorePoint -Backup $backup -Name "Production VM"

$session = Start-VBRWindowsFileRestore -RestorePoint $restorepoint[1]

Connect-VBRWindowsGuestProductionMachine -FileRestore $session

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. Specify the Backup and Name parameter values. Save the result to the $restorepoint variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the second restore session in the array).

Run the Start-VBRWindowsFileRestore cmdlet. Set the $restorepoint as the RestorePoint parameter value. Save the result to the $session variable.
Run the Connect-VBRWindowsGuestProductionMachine cmdlet. Set the session as the FileRestore parameter value.