Start-VEPSQLRestoreSession

Short Description

Starts a restore session to explore backed-up PostgreSQL databases and to perform operations with PostgreSQL instances.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Start-VEPSQLRestoreSession [-RestorePoint] <IVBRApplicationRestorePoint>  [<CommonParameters>]

Detailed Description

This cmdlet starts a new restore session, establishes a connection to the Veeam Backup & Replication server and retrieves PostgreSQL databases backed up on this server. Within the restore session, you can get information about the backed-up PostgreSQL instances using the following cmdlets:

After you get backed-up PostgreSQL instances, you can restore or publish these instances.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies a restore point to start a new restore session. You will be able to use the session to perform operations with PostgreSQL instances that this restore point contains.

Accepts the IVBRApplicationRestorePoint object. To get this object, run the Get-VBRApplicationRestorePoint cmdlet.

True

0

True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.

Output Object

The cmdlet returns the VEPSQLRestoreSession object that contains settings of restore sessions started to explore backed-up PostgreSQL databases and to perform operations with PostgreSQL instances.

Example

Starting Restore Session

This example shows how to start a restore session to perform operations with a PostgreSQL instance.

$restorepoint = Get-VBRApplicationRestorePoint -PostgreSQL

Start-VEPSQLRestoreSession -RestorePoint $restorepoint[0]

Perform the following steps:

  1. Run the Get-VBRApplicationRestorePoint cmdlet. Specify the PostgreSQL parameter. Save the result to the $restorepoint variable.

The Get-VBRApplicationRestorePoint cmdlet will return an array of restore points. Note the ordinal number of the necessary restore point. In our example, it is the first restore point in the array.

  1. Run the Start-VEPSQLRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.

Related Commands

Get-VBRApplicationRestorePoint