Remove-NsxController

NAME Remove-NsxController



SYNOPSIS

Removes a controller





SYNTAX

Remove-NsxController [-Controller] <XmlElement> [-Confirm] [-Wait] [-Force] [-Connection <PSObject>]

[<CommonParameters>]



Remove-NsxController -objectId <String> [-Confirm] [-Wait] [-Force] [-Connection <PSObject>] [<CommonParameters>]





DESCRIPTION

An NSX Controller is a member of the NSX Controller Cluster, and forms the

highly available distributed control plane for NSX Logical Switching and NSX

Logical Routing.



The Renove-NsxController cmdlet removes an existing NSX Controller.





PARAMETERS

-Controller <XmlElement>

PowerNSX Controller object obtained via Get-NsxController



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-objectId <String>

ObjectID of the controller to remove



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompt for confirmation. Specify as -confirm:$false to disable confirmation prompt



Required? false

Position? named

Default value True

Accept pipeline input? false

Accept wildcard characters? false



-Wait [<SwitchParameter>]

Block until Controller Removal job is COMPLETED (Will timeout with prompt after 720 seconds)

Useful if automating the removal of multiple controllers (first must be removed before removing second

controller)

so you dont have to write looping code to check status of controller before continuing.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Force the removal of the last controller. WARNING THIS WILL IMPACT LOGICAL SWITCHING AND ROUTING FUNCTIONALITY



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Connection <PSObject>

PowerNSX Connection object



Required? false

Position? named

Default value $defaultNSXConnection

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-NsxController "Controller1" | Remove-NsxController



Removes the controller named Controller1









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Remove-NsxController -objectId controller-3



Removes the controller with id controller-3











RELATED LINKS