Stop-VEPSQLInstanceRestore

Short Description

Stops the restore process for a backed-up PostgreSQL instance.

Applies to

Veeam Backup & Replication

Product Edition: Community, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VEPSQLInstanceRestore [-InstanceRestore] <VEPSQLInstanceRestore> [-Force <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet stops an active restore process started for a PostgreSQL instance.

Stop-VEPSQLInstanceRestore Note:

  • The cmdlet stops restore processes initiated in the PowerShell console only.
  • Restore processes will not stop automatically if you close the PowerShell console. To stop a restore process, you must run the Stop-VEPSQLInstanceRestore cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

InstanceRestore

Specifies the PostgreSQL instance restore process. The cmdlet will stop this restore process.

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

True

0

True (ByValue)

Force

Defines that the cmdlet will show no prompt before executing the command.

SwitchParameter

False

Named

False

<CommonParameters>

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

Example

Stopping Restore Process for PostgreSQL Instance

This example shows how to stop the restore process for a PostgreSQL instance.

$restore = Get-VEPSQLInstanceRestore -InstanceName "rhel01:5433"

Stop-VEPSQLInstanceRestore -InstanceRestore $restore

Perform the following steps:

  1. Run the Get-VEPSQLInstanceRestore cmdlet. Specify the InstanceName parameter value and save the result to the $restore variable.
  2. Run the Stop-VEPSQLInstanceRestore cmdlet. Set the $restore variable as the InstanceRestore parameter value.

Related Commands

Get-VEPSQLInstanceRestore