Get-VBRFailoverPlan

Short Description

Returns existing failover plans or cloud failover plans.

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

Name (Default)

Get-VBRFailoverPlan [-Name <String[]>] [<CommonParameters>]
Type

Get-VBRFailoverPlan [-Name <String[]>] -Type <VBRFailoverPlanType> [<CommonParameters>]
Tenant

Get-VBRFailoverPlan [-Name <String[]>] -Tenant <IVBRCloudTenant> [<CommonParameters>]
Id

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

Detailed Description

This cmdlet returns existing failover plans or cloud failover plans.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies the array of IDs of the `VBRFailoverPlan` object you want to add to the failover plan. Accepts GUID or string.	`Guid[]`	False	Named	True (ByPropertyName)
Name	Specifies the array of names of the failover plans you want to get or search conditions.	`String[]`	False	Named	True (ByPropertyName, ByValue)
Tenant	Specifies the cloud tenant. The cmdlet will return failover plans created by this tenant. Accepts the `VBRCloudTenant` object. To get this object, run the `Get-VBRCloudTenant` cmdlet.	`IVBRCloudTenant`	True	Named	True (ByPropertyName, ByValue)
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.	`VBRFailoverPlanType`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

Examples

Get-VBRFailoverPlan Example 1. Getting All Existing Failover Plans

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

Get-VBRFailoverPlan

Get-VBRFailoverPlan Example 2. Getting Failover Plan by Name

This command looks for the MS Exchange Group Failover failover plan.

Get-VBRFailoverPlan -Name "MS Exchange Group Failover"

Get-VBRFailoverPlan Example 3. Getting All Cloud Failover Plans

[Cloud] This command gets all cloud failover plans.

Get-VBRFailoverPlan -Type Cloud

Get-VBRFailoverPlan Example 4. Getting All Cloud Failover Plans

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

$tenant = Get-VBRCloudTenant -Name "ABC Company"

Get-VBRFailoverPlan -Tenant $tenant -Name "MS Exchange Group Failover"

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $tenant variable.
Run the Get-VBRFailoverPlan cmdlet. Set the $tenant variable as the Tenant parameter value. Specify the Name parameter value.