Get-NsxSecurityGroup

NAME Get-NsxSecurityGroup



SYNOPSIS

Retrieves NSX Security Groups





SYNTAX

Get-NsxSecurityGroup [-scopeId <String[]>] [-IncludeSystem] [-Connection <PSObject>] [<CommonParameters>]



Get-NsxSecurityGroup [-objectId <String>] [-scopeId <String[]>] [-IncludeSystem] [-Connection <PSObject>]

[<CommonParameters>]



Get-NsxSecurityGroup [[-name] <String>] [-scopeId <String[]>] -LocalOnly [-IncludeSystem] [-Connection <PSObject>]

[<CommonParameters>]



Get-NsxSecurityGroup [[-name] <String>] [-scopeId <String[]>] -UniversalOnly [-IncludeSystem] [-Connection

<PSObject>] [<CommonParameters>]



Get-NsxSecurityGroup [[-name] <String>] [-scopeId <String[]>] [-IncludeSystem] [-Connection <PSObject>]

[<CommonParameters>]



Get-NsxSecurityGroup [-scopeId <String[]>] -VirtualMachine <VirtualMachineInterop> [-IncludeSystem] [-Connection

<PSObject>] [<CommonParameters>]





DESCRIPTION

An NSX Security Group is a grouping construct that provides a powerful

grouping function that can be used in DFW Firewall Rules and the NSX

Service Composer.



This cmdlet returns Security Groups objects.





PARAMETERS

-objectId <String>

Get SecurityGroups by objectid



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-name <String>

Get SecurityGroups by name



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



-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



-VirtualMachine <VirtualMachineInterop>

Virtual Machine to check for group membership



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-IncludeSystem [<SwitchParameter>]

Include default system security group



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-NsxSecurityGroup TestSG















RELATED LINKS