Get-VEPSQLRestoreSession

Short Description

Returns active restore sessions started to perform operations with backed-up PostgreSQL instances.

Product: Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VEPSQLRestoreSession [<CommonParameters>]

Detailed Description

This cmdlet returns an array of active restore sessions started to perform operations with backed-up PostgreSQL instances.

Note

  • You can only get an array of restore sessions that are started in PowerShell. The cmdlet does not return restore sessions started in the Veeam Backup & Replication console.
  • The cmdlet only returns an array of restore sessions started within the same PowerShell session.

Parameters

<CommonParameters>

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

Output Object

The cmdlet returns the VEPSQLRestoreSession[] array that contains settings of restore sessions started to explore and recover backed-up PostgreSQL data.

Examples

Get-VEPSQLRestoreSessionExample 1. Getting All Running Restore Sessions

This command gets all restore sessions started to perform operations with PostgreSQL instances. Save the result to the $session variable to be able to use it with other cmdlets.

$session = Get-VEPSQLRestoreSession

Get-VEPSQLRestoreSessionExample 2. Getting Specific Restore Session

This example shows how to get a specific restore session started to perform operations with PostgreSQL instances.

$session = Get-VEPSQLRestoreSession

$session[0]

Perform the following steps:

  1. Run the Get-VEPSQLRestoreSession cmdlet. Save the result to the $session variable. The cmdlet will return an array of active restore sessions.
  2. Specify the necessary ordinal number of the restore session for the $session variable. In this example, it is the first restore session in the array.
  • Start-VEPSQLRestoreSessionStarts a restore session to explore backed-up PostgreSQL instances and to perform operations with these instances.
  • Stop-VEPSQLRestoreSessionStops an active restore session initiated to perform operations with PostgreSQL instances.

Page updated 2026-08-20

Page content applies to build 13.1.1.18