< Back

Get-NsxIpPool

Sat Jan 18, 2020 9:06 pm

NAME Get-NsxIpPool



SYNOPSIS

Retrieves NSX Ip Pools.





SYNTAX

Get-NsxIpPool [[-Name] <String>] [-Connection <PSObject>] [<CommonParameters>]



Get-NsxIpPool [-ObjectId <String>] [-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.





PARAMETERS

-Name <String>

Name of the Pool to retrieve



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ObjectId <String>

ObjectID of the Pool to retrieve



Required? false

Position? named

Default value

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:\\>This example retrieves all NSX IP Pools



Get-NsxIpPool









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



PS C:\\>This example retrieves an NSX IP Pool by name



Get-NsxIpPool -name Controller_Pool











RELATED LINKS