Remove-NsxIpPool

NAME Remove-NsxIpPool



SYNOPSIS

Removes the specified NSX IPPool.





SYNTAX

Remove-NsxIpPool [-IPPool] <XmlElement> [-Confirm] [-force] [-Connection <PSObject>] [<CommonParameters>]





DESCRIPTION

An IP Pool is a simple IPAM construct in NSX that simplifies automated IP

address asignment for multiple NSX technologies including VTEP interfaces

NSX Controllers.



This cmdlet removes the specified IP Pool. If the object has current IP

Address allocations the api will return an error. Use -force to override.





PARAMETERS

-IPPool <XmlElement>

IPPool object to be removed.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

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



-force [<SwitchParameter>]

Force removal of the ippool, even if it has current allocations.



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-NsxIPPool TestIPPool | Remove-NsxIPPool















RELATED LINKS