Stop-VEPSQLInstanceInstantRecovery

Short Description

Stops an active instant recovery session for a PostgreSQL instance.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VEPSQLInstanceInstantRecovery [-Instance] <VEPSQLInstanceInstantRecovery> [-Force <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet stops an active instant recovery session for a PostgreSQL instance.

Stop-VEPSQLInstanceInstantRecovery Note:

  • The cmdlet stops instant recovery sessions initiated in the PowerShell console only.
  • Instant recovery sessions will not stop automatically if you close the PowerShell console. To stop the instant recovery session, you must run the Stop-VEPSQLInstanceInstantRecovery cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Instance

Specifies a PostgreSQL instance. The cmdlet will stop the instant recovery session of this instance.

Accepts the VEPSQLInstanceInstantRecovery object. To get this object, run the Get-VEPSQLInstanceInstantRecovery 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 Instant Recovery Session for a Specific PostgreSQL Instance

This example shows how to stop an instant recovery session of the rhel01:5433 instance.

$IRInstance = Get-VEPSQLInstanceInstantRecovery -InstanceName "rhel01:5433"

Stop-VEPSQLInstanceInstantRecovery -Instance $IRInstance

Perform the following steps:

  1. Run the Get-VEPSQLInstanceInstantRecovery cmdlet. Specify the InstanceName parameter value. Save the result to the $IRInstance variable.
  2. Run the Stop-VEPSQLInstanceInstantRecovery cmdlet. Set the $IRInstance variable as the Instance parameter value.

Related Commands