---
title: "Set-VBRFailoverPlan"
description: "This cmdlet modifies settings of an existing failover plan or cloud failover plan. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrfailoverplan.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Replication > Failover Plans > Set-VBRFailoverPlan"
dateModified: "2026-08-19"
---

# Set-VBRFailoverPlan

## Short Description
Modifies a selected failover plan or cloud failover plan.

**Platform**: VMware, Hyper-V

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

## Syntax
```
Set-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan> [-Name <String>] [-Description <String>]
 [-FailoverPlanObject <VBRFailoverPlanObject[]>] [-EnablePreFailoverScript] [-PrefailoverCommand <String>]
 [-EnablePostFailoverScript] [-PostfailoverCommand <String>] [-EnablePublicIpRule] [-PassThru] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings of an existing failover plan or cloud failover plan.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies the new description you want to apply to the failover plan.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnablePostFailoverScript</span></p>
        </td>
        <td>
          <p>Enables the option to run a script after failing over to replicas is complete.</p><p>Use the <code>PostfailoverCommand</code> parameter to set the path to the script.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnablePreFailoverScript</span></p>
        </td>
        <td>
          <p>Enables the option to run a script before failing over to replicas.</p><p>Use the <code>PrefailoverCommand</code> parameter to set the path to the script.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnablePublicIpRule</span></p>
        </td>
        <td>
          <p>Enables the failover plan to use the public IP rules configured in the <a href="vbrfailoverplanobject.md"><code>VBRFailoverPlanObject</code></a> or <a href="vbrcloudfailoverplanobject.md"><code>VBRCloudFailoverPlanObject</code></a> objects.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">FailoverPlan</span></p>
        </td>
        <td>
          <p>Specifies the failover plan or cloud failover plan you want to modify.</p><p>Accepts the <a href="vbrfailoverplan.md"><code>VBRFailoverPlan</code></a> or <a href="vbrcloudfailoverplan.md"><code>VBRCloudFailoverPlan</code></a> objects. To get these objects, run the <a href="get-vbrfailoverplan.md"><code>Get-VBRFailoverPlan</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrfailoverplan.md"><code>VBRFailoverPlan</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">FailoverPlanObject</span></p>
        </td>
        <td>
          <p>Specifies the array of VMs or cloud VMs you want to add to the failover plan.</p><p>Accepts the <a href="vbrfailoverplanobject.md"><code>VBRFailoverPlanObject</code></a> or <a href="vbrcloudfailoverplanobject.md"><code>VBRCloudFailoverPlanObject</code></a> objects. To get the object, run the <a href="new-vbrfailoverplanobject.md"><code>New-VBRFailoverPlanObject</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrfailoverplanobject.md"><code>VBRFailoverPlanObject[]</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies the new name you want to assign to the failover plan.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PassThru</span></p>
        </td>
        <td>
          <p>Defines that the command returns the output object to the Windows PowerShell console.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PostfailoverCommand</span></p>
        </td>
        <td>
          <p>Specifies the path to the script you want to automatically run after failing over to replicas is complete.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PrefailoverCommand</span></p>
        </td>
        <td>
          <p>Specifies the path to the script you want to automatically run before failing over to replicas.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
- [`VBRFailoverPlan`](vbrfailoverplan.md)
- [`VBRCloudFailoverPlan`](vbrcloudfailoverplan.md)
- [`VBRTenantFailoverPlan`](vbrtenantfailoverplan.md)

## Examples

::: example
### Example 1. Adding Server to Failover Plan

This example shows how to add one more server to the `MS Exchange Group Failover` failover plan.

```
$MSExchangeServer03 = Find-VBRViEntity -Name "MS Exchange Server 03"
$MSExchangePlan = Get-VBRFailoverPlan -Name "MS Exchange Group Failover"
$MSExchangeGroup = $MSExchangePlan.FailoverObject
$MSExchangeGroup += $MSExchangeServer03
Set-VBRFailoverPlan -FailoverPlan $MSExchangePlan -FailoverPlanObject $MSExchangeGroup -Description "Failover plan for the mail servers group: UPDATED"
```

Perform the following steps:

1. Run the [`Find-VBRViEntity`](find-vbrvientity.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$MSExchangeServer03` variable.
2. Run the [`Get-VBRFailoverPlan`](get-vbrfailoverplan.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$MSExchangePlan` variable.
3. Get the `FailoverObject` parameter of the `$MSExchangePlan` variable. Save the array to the `$MSExchangeGroup` variable.
4. Add the new failover plan object to the array.
5. Run the `Set-VBRFailoverPlan` cmdlet. Set the `$MSExchangePlan` variable as the `FailoverPlan` parameter value. Set the `$MSExchangeGroup` variable as the `FailoverPlanObject` parameter value. Specify the `Description` parameter value.

:::

::: example
### Example 2. Adding Server to Failover Plan

[Cloud provider] This example shows how to add a pre-failover script to the `ABC Company Failover Plan` tenant failover plan.

```
$tenant = Get-VBRCloudTenant -Name "ABC Company"
$failoverplan = Get-VBRFailoverPlan -Tenant $tenant -Name "ABC Company Failover Plan"
Set-VBRFailoverPlan -FailoverPlan $failoverplan -PrefailoverCommand "C:\Users\Administrator\TriggerEmailNotification.cmd"
```

Perform the following steps:

1. Run the [`Get-VBRCloudTenant`](get-vbrcloudtenant.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$tenant` variable.
2. Run the [`Get-VBRFailoverPlan`](get-vbrfailoverplan.md) cmdlet. Set the `$tenant` variable as the `Tenant` parameter value. Specify the `Name` parameter value. Save the failover plan to the `$failoverplan` variable.
3. Run the `Set-VBRFailoverPlan` cmdlet. Set the `$failoverplan` variable as the `FailoverPlan` parameter value. Specify the `PrefailoverCommand` parameter value.

:::

## Related Commands

[`New-VBRFailoverPlanObject`](new-vbrfailoverplanobject.md)