Short Description

Modifies switchover settings for a specified PostgreSQL instance.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License


Set-VEPSQLInstanceInstantRecovery [-Instance] <VEPSQLInstanceInstantRecovery> [-SwitchOverOptions] <VEPSQLIRSwitchOverOptions> [<CommonParameters>]

Detailed Description

This cmdlet allows you to modify the switchover settings for a specified PostgreSQL instance.

Set-VEPSQLInstanceInstantRecovery Important!

You can only modify the switchover settings until the moment switchover is automatically triggered (if the Auto or Scheduled switchover options are selected).







Accept Pipeline Input


Specifies a published PostgreSQL instance within an instant recovery session.

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



True (ByValue)


Specifies a new switchover option for the specified PostgreSQL instance.

Accepts the VEPSQLIRSwitchOverOptions object. To create this object, run the New-VEPSQLIRSwitchOverOptions cmdlet.



True (ByValue)


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


Setting Scheduled Switchover for PostgreSQL Instance

This example shows how to modify the scheduled switchover for the rhel01:5433 instance. The switchover will be performed in the Scheduled mode — on 2023-7-24 at 13:00:00 in the time zone of the backup server.

$time = Get-Date -Date "2023-7-24 13:00:00"

$TimeUtc = $time.ToUniversalTime()

$ScheduledSwitch = New-VEPSQLIRSwitchOverOptions -Scheduled -SwitchingTimeUtc $TimeUtc

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

Set-VEPSQLInstanceInstantRecovery -Instance $IRInstance -SwitchOverOptions $ScheduledSwitch

Perform the following steps:

  1. Run the Get-Date cmdlet and specify the date and time when the switchover must be performed. Save the result to the $time variable.
  2. Use the ToUniversalTime() method to convert the date and time to the UTC format. Save the result to the $TimeUtc variable.
  3. Run the New-VEPSQLIRSwitchoverOptions cmdlet. Provide the Scheduled parameter. Set the $TimeUtc variable as the SwitchingTimeUtc parameter value. Save the result to the $ScheduledSwitch variable.
  4. Run the Get-VEPSQLInstanceInstantRecovery cmdlet. Specify the Instance parameter value. Save the result to the $IRInstance variable.
  5. Run the Set-VEPSQLInstanceInstantRecovery cmdlet. Set the $IRInstance as the Instance parameter value. Set the $ScheduledSwitch variable as the SwitchOverOptions parameter value.

Related Commands

Page updated 3/8/2024

Page content applies to build