Start-VBRWindowsGuestItemRestore

Path

Specifies an array of file paths to files and folders that you want to restore.

Note: The parameter does not accept the mount server path.

String[]

True

Named

True (ByValue,
ByProperty
Name)

Item

Specifies an array of files and folders that you want to restore. The cmdlet will restore these files and folders.

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

True

Named

True (ByValue,
ByProperty
Name)

RestorePolicy

Specifies the file restore policy:

• Keep: Use this option if you want to restore the files with the _restored postfix next to the original file.
• Overwrite: Use this option if you want to replace the original files with the restored files.

VBRWindowsGuestItemRestorePolicy

True

Named

False

Session

Specifies a session of Microsoft Windows guest OS file restore. The cmdlet will use this session to restore guest OS files.

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

This parameter is required if the FileRestore parameter is not specified.

Accepts the CRestoreSession object. To create this object, run the Get-VBRRestoreSession cmdlet.

False

Named

False

FileRestore

Specifies a session of Microsoft Windows guest OS file restore. The cmdlet will use this session to restore guest OS files.

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

This parameter is required if the Session parameter is not specified.

Accepts the FileRestore object. To create this object, run the Start-VBRWindowsFileRestore cmdlet.

False

Named

False

GuestCredentials

Specifies credentials for the target machine.

Note: If you do not specify credentials, the cmdlet will try to use the credentials from the current PowerShell session.

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

False

Named

False

TargetViVm

For restoring files and folders from a backup of a VMware vSphere VM.

Specifies a VMware vSphere VM (target VM) to which you want to restore files and folders.

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

False

Named

False

TargetVcdVm

For restoring files and folders from a backup of a VMware Cloud Director VM.

Specifies a VMware Cloud Director VM (target VM) to which you want to restore files and folders.

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

False

Named

False

TargetHvVm

For restoring files and folders from a backup of a Microsoft Hyper-V VM.

Specifies a Microsoft Hyper-V VM (target VM) to which you want to restore files and folders.

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

False

Named

False

TargetAgentMachine

For performing restore to a Veeam Agent computer.

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

Accepts the VBRDiscoveredComputer object. To get this object, run the Get-VBRDiscoveredComputer 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

PermissionsOnly

Defines whether to restore only permissions of files and folders.

Note: This functionality is included in the Veeam Universal License. When using a legacy socket-based license, the Enterprise or Enterprise Plus editions of Veeam Backup & Replication are required.

SwitchParameter

False

Named

False

ChangedItemsOnly

Defines whether to restore changed files and folders only. Before restoring changes, you must launch Compare-VBRWindowsGuestItemsAttributes for files and folders that youplan to restore.

Note: This functionality is included in the Veeam Universal License. When using a legacy socket-based license, the Enterprise or Enterprise Plus editions of Veeam Backup & Replication are required.

SwitchParameter

False

Named

False

RunAsync

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

SwitchParameter

False

Named

False