Get-NsxApplicableMember

NAME Get-NsxApplicableMember



SYNOPSIS

Retrieves a list of applicable members for either Security Groups or Service

Groups





SYNTAX

Get-NsxApplicableMember [-scopeId <String>] -SecurityGroupApplicableMembers -MemberType <String> [-Universal]

[-Connection <PSObject>] [<CommonParameters>]



Get-NsxApplicableMember [-scopeId <String>] -ServiceGroupApplicableMembers [-Universal] [-Connection <PSObject>]

[<CommonParameters>]





DESCRIPTION

Security Groups and Service Groups can contain members of specific types.

Basic information about all valid (applicable) members can be retrieved

using a simple API call which is typically much less expensive than the

alternative of retrieving the complete configuration from the API for a

specific type of object.



This cmdlet also exposes 'shortcut' functionality that lets you retrieve

object name to objectId mapping of many object types in NSX that can improve

the performance of scripts in high scale environments.



Hat tip to Dale Coghlan (sneauku.com) for pointing out the usefulness of

this API in large scale environments. See

http://www.sneaku.com/2016/07/13/how-to ... verything/

for more information.





PARAMETERS

-scopeId <String>



Required? false

Position? named

Default value globalroot-0

Accept pipeline input? false

Accept wildcard characters? false



-SecurityGroupApplicableMembers [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ServiceGroupApplicableMembers [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-MemberType <String>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Universal [<SwitchParameter>]



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-NsxApplicableMember -SecurityGroupApplicableMembers -MemberType VirtualMachine



Get the virtual machine applicable member list









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



PS C:\\>Get-NsxApplicableMember -ServiceGroupApplicableMembers



Get the applicable member list for ServiceGroup membership.









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



PS C:\\>Get-NsxApplicableMember -SecurityGroupApplicableMembers -MemberType IPSet -Universal



Get the Universal IP Set applicable member list









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



PS C:\\>Get-NsxApplicableMember -ServiceGroupApplicableMembers -Universal



Get the applicable member list for Universal ServiceGroup membership.











RELATED LINKS