Start-VBRLinuxFileRestore

RestorePoint

Specifies the restore point to start a restore session. You will be able to use the session to perform operations with VM guest OS files.

Accepts the COib object. To create this object, run the Get-VBRRestorePoint cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Server

Specifies the ESXi or Microsoft Hyper-V host on which the helper appliance must be registered.

Note: If you specify a host for the Novell file system proxy appliance, make sure that it can run VMs with 64-bit guest OSes.

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

False

Named

True (ByProperty
Name)

ResourcePool

To start a restore session using the VMware platform.

Specifies the resource pool to which the helper appliance must be placed.

Accepts the CViResourcePoolItem object. To get this object, run the Find-VBRViResourcePool cmdlet.

False

Named

True (ByProperty
Name)

MountServer

Specifies an existing Linux-based machine. The cmdlet will mount disks from a backup or replica to this machine and will use it as a helper host.

Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.

False

Named

True (ByValue,
ByProperty
Name)

MountToOriginalHost

Specifies whether to mount disks to the original server and use it as a helper host.

Default: False.

Note: You can set this parameter to $true only if the Server and MountServer parameters are not specified.

SwitchParameter

False

Named

True (ByProperty
Name)

Reason

Specifies the reason for starting restore.

The information you provide will be saved in the session history so that you can reference it later.

String

False

Named

False

NetworkInfo

Specifies the network settings for the helper appliance.

Note:

• The helper appliance must be placed in the same network where the backup server resides.
• If you do not provide this parameter, the cmdlet will apply the VM network settings for the helper appliance.

Accepts the IVBRServerNetworkInfo[] object. To get this object, run the Get-VBRViServerNetworkInfo cmdlet.

False

Named

False

IP

Specifies the IPv4 address that you want to assign to the helper appliance.

Note: The helper appliance must be placed in the same network where the backup server resides.

IPAddress

False

Named

False

NetworkMask

For the IP parameter specified.

Specifies the network mask that you want to assign to the helper appliance.

Note: The helper appliance must be placed in the same network where the backup server resides.

String

False

Named

False

PreferredDNSServer

Specifies the IPv4 address of the DNS server in the network where the helper appliance resides.

IPAddress

False

Named

False

AlternateDNSServer

Specifies the IPv4 address of the alternate DNS server in the network where the helper appliance resides.

IPAddress

False

Named

False

Gateway

Specifies the IPv4 address of the default gateway in the network where the helper appliance resides.

IPAddress

False

Named

False

IPv6

Specifies the IPv6 address that you want to assign to the helper appliance.

Note: The helper appliance must be placed in the same network where the backup server resides.

IPAddress

False

Named

False

IPv6PrefixLength

For the IPv6 addresses specified.

Specifies the length of the IPv6 prefix.

Int32

False

Named

False

IPv6PreferredDNSServer

Specifies the IPv6 address of the DNS server in the network where the helper appliance resides.

IPAddress

False

Named

False

IPv6AlternateDNSServer

Specifies the IPv6 address of the alternate DNS server in the network where the appliance resides.

IPAddress

False

Named

False

IPv6Gateway

Specifies the IPv6 address of the default gateway in the network where the appliance resides.

IPAddress

False

Named

False

VLanId

To start a restore session using the Hyper-V platform.

Specifies the VLAN ID where the helper appliance must reside.

Int

False

Named

False

FromNSS

Defines that the cmdlet will start a restore session of a VM guest OS using the Novell Storage Services file system.

If you provide this parameter, the cmdlet will deploy a specific appliance that supports the Novell Storage Services file system.

Default: False.

SwitchParameter

False

Named

False

EnableFTP

Enables the FTP access to the restored file system.

If you provide this parameter, users will be able to access the helper appliance over FTP, browse the file system of the restored VM and download necessary files on their own.

Default: False.

SwitchParameter

False

Named

False

ShareCredentials

Specifies the credentials to authenticate against a backup repository where the backup from which you restore is stored.

Note: This parameter is required if you restore files using a helper appliance from a backup imported from an SMB share. This applies if the server where the share is located and the share itself is not added to the backup infrastructure.

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

False

Named

False

Credentials

Specifies the credentials to authenticate against the original Linux-based machine that will be used as a helper host.

Note: This parameter can be used only when MountToOriginalHost is true.

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

False

Named

False

HelperHost

Specifies the temporary Linux helper host.

Accepts the VBRLinuxFileRestoreHelperHost object. To get this object, run the New-VBRLinuxFileRestoreHelperHost cmdlet.

True

Named

False