PowerCLI Reference

Remove-HCXAppliance

Synopsis

This cmdlet removes an HCX (Hybrid Cloud Extension) Appliance.

Syntax

Remove-HCXAppliance [-Appliance] <HCXAppliance> [-Confirm] -DestinationSite <HCXSite> [-Force] [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet removes an HCX Appliance which can be of type Interconnect, L2Concentrator, and WANOptimization. You can use the HCXJob output to retrieve job details by running the Get-HCXJob cmdlet.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ApplianceHCXApplianceSpecifies the appliance you want to remove. The supported types are Interconnect, L2Concentrator, and WANOptimization.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
DestinationSiteHCXSiteSpecifies the destination site.trueTrue (ByValue)
ForceSwitchParameterIndicates that you want to remove the appliance. If the Force parameter is not set and the resource is busy, the appliance removal job will not be initiated.falseFalse
ServerHcxServer[]Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXJob

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> Remove-HCXAppliance -Appliance $myAppliance -DestinationSite $myDestination -Force

Removes the appliance.


Copyright © VMware, Inc. All rights reserved.