< Back
Get-NsxSecurityGroupEffectiveVnic
Post
NAME Get-NsxSecurityGroupEffectiveVnic
SYNOPSIS
Determines the effective VNIC Address membership of a security group.
SYNTAX
Get-NsxSecurityGroupEffectiveVnic -SecurityGroup <XmlElement> [-Connection <PSObject>] [<CommonParameters>]
Get-NsxSecurityGroupEffectiveVnic [-SecurityGroupId] <String> [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
An NSX SecurityGroup can contain members (VMs, IP Addresses, MAC Addresses
or interfaces) by virtue of direct, or indirect membership (nested security
groups), and either by static or dynamic inclusion.
In addition, direct or indirect exclusions can also
modify membership.
This cmdlet uses the NSX 'Translation APIs' to determine the
'Effective VNIC Address Membership' of a given security group.
The membership output by this cmdlet is determined by NSX itself.
Note: The IPAddress listed against a vnic via the VNIC translation API may
NOT reflect true IPAddress membership of the group as exclusions are not
taken into account.
Use the Get-NsxSecurityGroupEffectiveIpAddress cmdlet for accurate IP
address determination.
PARAMETERS
-SecurityGroup <XmlElement>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-SecurityGroupId <String>
Required? true
Position? 2
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 testSG | Get-NsxSecurityGroupEffectiveVnic
Uuid IpAddresses
MacAddress
---- -----------
----------
{50005aa9-a365-5d39-5e73-ab1239eb997e.000, 50004328-f0f5-1115-eb45-1de4261748a1.001} {fe80::250:56ff:fe80:3e20,
10.0.1.11} {00:50:56:80:3e:20, 00:50:56:80:5f:d0}
Determine the effective VNIC membership of testSG.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxSecurityGroupEffectiveVnic -SecurityGroupId securitygroup-1234
Uuid IpAddresses
MacAddress
---- -----------
----------
{50005aa9-a365-5d39-5e73-ab1239eb997e.000, 50004328-f0f5-1115-eb45-1de4261748a1.001} {fe80::250:56ff:fe80:3e20,
10.0.1.11} {00:50:56:80:3e:20, 00:50:56:80:5f:d0}
Determine the effective VNIC membership of a security group by object id.
RELATED LINKS
SYNOPSIS
Determines the effective VNIC Address membership of a security group.
SYNTAX
Get-NsxSecurityGroupEffectiveVnic -SecurityGroup <XmlElement> [-Connection <PSObject>] [<CommonParameters>]
Get-NsxSecurityGroupEffectiveVnic [-SecurityGroupId] <String> [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
An NSX SecurityGroup can contain members (VMs, IP Addresses, MAC Addresses
or interfaces) by virtue of direct, or indirect membership (nested security
groups), and either by static or dynamic inclusion.
In addition, direct or indirect exclusions can also
modify membership.
This cmdlet uses the NSX 'Translation APIs' to determine the
'Effective VNIC Address Membership' of a given security group.
The membership output by this cmdlet is determined by NSX itself.
Note: The IPAddress listed against a vnic via the VNIC translation API may
NOT reflect true IPAddress membership of the group as exclusions are not
taken into account.
Use the Get-NsxSecurityGroupEffectiveIpAddress cmdlet for accurate IP
address determination.
PARAMETERS
-SecurityGroup <XmlElement>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-SecurityGroupId <String>
Required? true
Position? 2
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 testSG | Get-NsxSecurityGroupEffectiveVnic
Uuid IpAddresses
MacAddress
---- -----------
----------
{50005aa9-a365-5d39-5e73-ab1239eb997e.000, 50004328-f0f5-1115-eb45-1de4261748a1.001} {fe80::250:56ff:fe80:3e20,
10.0.1.11} {00:50:56:80:3e:20, 00:50:56:80:5f:d0}
Determine the effective VNIC membership of testSG.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxSecurityGroupEffectiveVnic -SecurityGroupId securitygroup-1234
Uuid IpAddresses
MacAddress
---- -----------
----------
{50005aa9-a365-5d39-5e73-ab1239eb997e.000, 50004328-f0f5-1115-eb45-1de4261748a1.001} {fe80::250:56ff:fe80:3e20,
10.0.1.11} {00:50:56:80:3e:20, 00:50:56:80:5f:d0}
Determine the effective VNIC membership of a security group by object id.
RELATED LINKS