Get-VBRFailoverPlan
Short Description
Returns existing failover plans or cloud failover plans.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Look for failover plans by name.
Get-VBRFailoverPlan [-Name <string[]>] [<CommonParameters>] |
- Look for failover plans by type (Local/Tenant/Cloud).
Get-VBRFailoverPlan -Type <VBRFailoverPlanType> {Local | Tenant | Cloud} [-Name <string[]>] [<CommonParameters>] |
- [Cloud] Look for failover plans by tenants.
Get-VBRFailoverPlan -Tenant <VBRCloudTenant> [-Name <string[]>] [<CommonParameters>] |
- Look 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 | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Name | Specifies the array of names of the failover plans you want to get or search conditions. | String[] | False | Named | True (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. | True | Named | True (ByValue, |
Type | Specifies the type of the failover plan:
The cmdlet will return the failover plans of the selected type. | VBRFailoverPlanType | True | Named | False |
Id | Specifies the array of IDs of the VBRFailoverPlan object you want to add to the failover plan. | Accepts GUID or string. | False | Named | True (ByProperty |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
Examples
Example 1. Getting All Existing Failover Plans
This command looks for the list of all existing failover plans.
|
Example 2. Getting Failover Plan by Name
This command looks for the MS Exchange Group Failover failover plan.
|
Example 3. Getting All Cloud Failover Plans
[Cloud] This command gets all cloud failover plans.
|
Example 4. Getting All Cloud Failover Plans
[Cloud provider] This command gets MS Exchange Group Failover failover plan created by the ABC Company tenant.
Perform the following steps:
|