Stop-VBRCloudTenantNetworkAppliance

In this article

    Short Description

    Disables network extension appliances on the tenant side.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Stop-VBRCloudTenantNetworkAppliance -Appliance <VBRCloudTenantNetworkAppliance[]> [-WhatIf [<SwitchParameter>]][-Confirm [<SwitchParameter>]] [<CommonParameters>]

    Detailed Description

    This cmdlet allows the Service Provider to disable network extension appliances configured on the tenant side after a permanent failover.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Appliance

    Specifies an array of network extension appliances that you want to disable.

    Accepts the VBRCloudTenantNetworkAppliance type.

    True

    Named

    True (ByValue)

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    False

    Named

    False

    False

    <CommonParameters>

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

    Example

    This example shows how to disable network extension appliances of the ABC Company tenant.

    1. Run Get-VBRCloudTenant to get the tenant which network appliance you want to stop. Save the result to the $tenant variable.
    2. Run Get-VBRCloudTenantNetworkAppliance using the $tenant variable. Save the result to the $appliance variable.
    3. Run Stop-VBRCloudTenantNetworkAppliance with the $appliance variable.

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

    $appliance = Get-VBRCloudTenantNetworkAppliance -Tenant $tenant

    Stop-VBRCloudTenantNetworkAppliance Appliance $appliance

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.