< Back

Get-NsxDynamicMemberSet

Sat Jan 18, 2020 9:02 pm

NAME Get-NsxDynamicMemberSet



SYNOPSIS

Retrieves Dynamic Member Sets from the specified security group.





SYNTAX

Get-NsxDynamicMemberSet [-SecurityGroup] <Object> [-Index <String>] [-Connection <PSObject>] [<CommonParameters>]





DESCRIPTION

NSX Security Groups can have 3 types of membership configured, Dynamic

Criteria, Static Members and Exclude Members.



One or more Dynamic Criteria combine to make a Dynamic Member Set, and one

or more Dynamic Member Sets combine to define the Dynamic Membership of a

given security group.



In order to allow the configuration of a security groups Dynamic Membership

with an aritrary number of Dynamic Criteria Member Sets that contain an

arbitrary number of Dynamic Criteria in a flexible way, PowerNSX provides

the following abstractions.



Creation of individual Dynamic Criteria is accomplished with

New-NsxDynamicCriteriaSpec.



One or more Dynamic Criteria can be added to a Dynamic Member Set at creation

time with Add-NsxDynamicMemberSet and specifying the required Dynamic

Criteria Spec objects at creation time.



One or more Dynamic Criteria can be added to an existing Dynamic Member Set

after the fact with Add-NsxDynamicCriteria or removed with

Remove-NsxDynamicCriteria.



One or more Dynamic Member sets can be added to a security groups overall

Dynamic Membership definition using Add-NsxDynamicMemberSet or removed using

Remove-NsxDynamicMemberSet



A Security Groups Dynamic Member definition can include multiple Dynamic

Member Sets in an logical AND/OR arrangement, and for each of the Dynamic

Member Sets, a match operator of ALL or ANY can be specified that determines

how multiple Dynamic Criteria combine within the set to define a match.



This cmdlet returns the existing Dynamic Member Sets from the given security

group.





PARAMETERS

-SecurityGroup <Object>

SecurityGroup to retrieve Dynamic Sets from.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Index <String>

Get Member Set by index



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:\\>Get-NsxSecurityGroup Prod-WindowsServer | Get-NsxDynamicMemberSet



Retrieves the Dynamic Member Sets that make up the Dynamic Membership

specification of the security group Prod-WindowsServer









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



PS C:\\>Get-NsxSecurityGroup Prod-WindowsServer | Get-NsxDynamicMemberSet -Index 3



Retrieves the third Member Set from the Dynamic Membership specification of

the security group Prod-WindowsServer. This is primarly intended to return

an object suitable to pass to Get-NsxDynamicCriteria or

Add-NsxDynamicCriteria.











RELATED LINKS