PowerCLI Reference

Remove-HCXNetworkExtension

Synopsis

This cmdlet removes an HCX Network Extension.

Syntax

Remove-HCXNetworkExtension [-HCXNetworkExtension] <HCXNetworkExtension> [-ConnectToLocalRouter <Boolean>] [-Server <HcxServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet removes an HCX Network Extension (L2 extension) and you can reverse the stretch operation on the provided network. You can retrieve job details by running the Get-HCXJob cmdlet.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
HCXNetworkExtensionHCXNetworkExtensionSpecifies the HCX network extension that you want to remove.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
ConnectToLocalRouterBooleanSpecifies the option which connects the network to a local router after removing the network extension.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
WhatIfSwitchParameterShows what would happen if the cmdlet runs. The cmdlet is not run.falseFalse

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXJob

Notes

Examples

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

PS C:\> Remove-HCXNetworkExtension -HCXNetworkExtension $networkExtended

Removes the network extension.


Copyright © VMware, Inc. All rights reserved.