Get-NsxIpSet

NAME Get-NsxIpSet



SYNOPSIS

Retrieves NSX IPSets





SYNTAX

Get-NsxIpSet [-scopeId <String[]>] [-IncludeReadOnly] [-Connection <PSObject>] [<CommonParameters>]



Get-NsxIpSet -objectId <String> [-scopeId <String[]>] [-IncludeReadOnly] [-Connection <PSObject>]

[<CommonParameters>]



Get-NsxIpSet [[-Name] <String>] [-scopeId <String[]>] [-IncludeReadOnly] -LocalOnly [-Connection <PSObject>]

[<CommonParameters>]



Get-NsxIpSet [[-Name] <String>] [-scopeId <String[]>] [-IncludeReadOnly] -UniversalOnly [-Connection <PSObject>]

[<CommonParameters>]



Get-NsxIpSet [-Name] <String> [-scopeId <String[]>] [-IncludeReadOnly] [-Connection <PSObject>]

[<CommonParameters>]





DESCRIPTION

An NSX IPSet is a grouping construct that allows for grouping of

IP adresses, ranges and/or subnets in a sigle container that can

be used either in DFW Firewall Rules or as members of a security

group.



This cmdlet returns IP Set objects.





PARAMETERS

-objectId <String>

Objectid of IPSet



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Name of IPSet



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-scopeId <String[]>

ScopeId of IPSet. Can define multiple scopeIds in a list to iterate accross scopes.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IncludeReadOnly [<SwitchParameter>]

Return 'Readonly' (system) ipsets as well



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UniversalOnly [<SwitchParameter>]

Return only Universal objects



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-LocalOnly [<SwitchParameter>]

Return only Locally scoped objects



Required? true

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-NsxIpSet TestIPSet



Retrieves the IPSet named TestIPSet









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



PS C:\\>Get-NsxIpSet



Retrieves all ipsets. Includes locally and universally scoped ipsets.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-NsxIpSet -LocalOnly



Retrieves all locally scoped ipsets









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-NsxIpSet -UniversalOnly



Retrieves only Universally scoped IPSets.









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-NSXIpSet TestEsgeIPSet -scopeId edge-1



Returns all locally configured IP Sets on the specified edge.











RELATED LINKS