Get-VBRFailoverPlan

In this article

    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 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 (ByValue,
    ByProperty
    Name)

    True

    Tenant

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

    Accepts VBRCloudTenant type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    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 (ByProperty
    Name)

    False

    <CommonParameters>

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

    Return Type

    VBRFailoverPlan[]

    VBRCloudFailoverPlan[]

    VBRTenantFailoverPlan[]

    Example 1

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

    Get-VBRFailoverPlan

    Example 2

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

    Get-VBRFailoverPlan -Name "MS Exchange Group Failover"

    Example 3

    [Cloud] This command gets all cloud failover plans.

    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.

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

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