Stop-VEPSQLRestoreSession

Short Description

Stops active restore sessions initiated to perform operations with PostgreSQL databases.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VEPSQLRestoreSession [-Session] <VEPSQLRestoreSession>  [<CommonParameters>]

Detailed Description

This cmdlet stops active restore sessions initiated to perform operations with PostgreSQL databases.

Stop-VEPSQLRestoreSession Note:

  • The cmdlet will unpublish the published PostgreSQL instances.
  • The cmdlet stops restore sessions initiated in the PowerShell console only.
  • Restore sessions will not stop automatically if you close the PowerShell console. To stop the restore session, you must run the Stop-VEPSQLRestoreSession cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Session

Specifies an PostgreSQL restore session that you want to stop.

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

True

0

True (ByValue)

False

<CommonParameters>

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

Example

This example shows how to stop a restore session initiated to perform operations with PostgreSQL databases.

$session = Get-VEPSQLRestoreSession

Stop-VEPSQLRestoreSession -Session $session[3]

Perform the following steps:

  1. Run the Get-VEPSQLRestoreSession cmdlet. Save the result to the $session variable.

The Get-VEPSQLRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Stop-VEPSQLRestoreSession cmdlet. Set the $session variable as the Session parameter value.

Related Commands

Get-VEPSQLRestoreSession