Stop-VBRCloudTenantNetworkAppliance

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] [-Confirm] [<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	Type	Required	Position	Accept Pipeline Input
Appliance	Specifies an array of network extension appliances that you want to disable.	Accepts the VBRCloudTenantNetworkAppliance object. To get this object, run the Get-VBRCloudTenantNetworkAppliance cmdlet.	True	Named	True (ByValue)
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines that the cmdlet will display a prompt that asks if you want to continue running the command. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Appliance

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

Accepts the VBRCloudTenantNetworkAppliance object. To get this object, run the Get-VBRCloudTenantNetworkAppliance cmdlet.

True

Named

True (ByValue)

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

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

Output Object

None.

Examples

Disabling Network Extension Appliances of Selected Tenant

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

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

$appliance = Get-VBRCloudTenantNetworkAppliance -Tenant $tenant

Stop-VBRCloudTenantNetworkAppliance -Appliance $appliance

Perform the following steps:

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

Related Commands