Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VBRFailoverPlan

Short Description

Returns existing failover plans or cloud failover plans.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

This cmdlet provides 4 parameter sets.

  • For looking for failover plans by name:

Get-VBRFailoverPlan [-Name <string[]>]  [<CommonParameters>]

  • For looking for failover plans by type (Local/Tenant/Cloud):

Get-VBRFailoverPlan -Type <VBRFailoverPlanType> {Local | Tenant | Cloud} [-Name <string[]>]  [<CommonParameters>]

  • [Cloud] For looking for failover plans by tenants:

Get-VBRFailoverPlan -Tenant <VBRCloudTenant> [-Name <string[]>]  [<CommonParameters>]

  • For looking for failover plans by ID:

Get-VBRFailoverPlan [-Id <guid[]>]  [<CommonParameters>]

Detailed Description

This cmdlet returns existing failover plans or cloud failover plans.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the array of names of the failover plans you want to get or search conditions.

False

Named

True (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

True

Tenant

Specifies the cloud tenant. The cmdlet will return failover plans created by this tenant.

Accepts VBRCloudTenant type.

True

Named

True (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

False

Type

Specifies the type of the failover plan:

  • Local: non-cloud failover plans.
  • Cloud: [for cloud user] cloud failover plans.
  • Tenant: [for cloud provider] cloud failover plans created by cloud user.

The cmdlet will return the failover plans of the selected type.

True

Named

False

False

Id

Specifies the array of IDs of the VBRFailoverPlan object you want to add to the failover plan.

Accepts GUID or string type.

False

Named

True (by
ValueFromPipeline
ByPropertyName)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRFailoverPlan[]

VBRCloudFailoverPlan[]

VBRTenantFailoverPlan[]

Example 1

This command looks for the list of all existing failover plans.

PS C:\PS> Get-VBRFailoverPlan

Example 2

This command looks for a failover plan named "MS Exchange Group Failover".

PS C:\PS> Get-VBRFailoverPlan -Name "MS Exchange Group Failover"

Example 3

[Cloud] This command gets all cloud failover plans.

PS C:\PS> Get-VBRFailoverPlan –Type Cloud

Example 4

[Cloud provider] This command gets failover plan named "MS Exchange Group Failover" created by the ABC Company tenant.

  1. Run Get-VBRCloudTenant to get the ABC Company tenant and save it to the $tenant variable.
  2. Run Get-VBRFailoverPlan with the $tenant variable.

PS C:\PS> $tenant = Get-VBRCloudTenant -Name "ABC Company"

PS C:\PS> Get-VBRFailoverPlan -Tenant $tenant -Name "MS Exchange Group Failover"

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation