Get-NsxFirewallRule

NAME Get-NsxFirewallRule



SYNOPSIS

Retrieves the specified NSX Distributed Firewall Rule.





SYNTAX

Get-NsxFirewallRule [[-Name] <String>] [-ScopeId <String>] [-Source <Object>] [-Destination <Object>] [-Connection

<PSObject>] [<CommonParameters>]



Get-NsxFirewallRule -Section <XmlElement> [[-Name] <String>] [-ScopeId <String>] [-RuleType <String>] [-Connection

<PSObject>] [<CommonParameters>]



Get-NsxFirewallRule -RuleId <String> [-ScopeId <String>] [-RuleType <String>] [-Connection <PSObject>]

[<CommonParameters>]





DESCRIPTION

An NSX Distributed Firewall Rule defines a typical 5 tuple rule and is

enforced on each hypervisor at the point where the VMs NIC connects to the

portgroup or logical switch.



Additionally, the 'applied to' field allow additional flexibility about

where (as in VMs, networks, hosts etc) the rule is actually applied.



This cmdlet retrieves the specified NSX Distributed Firewall Rule. It is

also effective used in conjunction with an NSX firewall section as

returned by Get-NsxFirewallSection being passed on the pipeline to retrieve

all the rules defined within the given section.





PARAMETERS

-Section <XmlElement>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RuleId <String>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ScopeId <String>



Required? false

Position? named

Default value globalroot-0

Accept pipeline input? false

Accept wildcard characters? false



-RuleType <String>



Required? false

Position? named

Default value layer3sections

Accept pipeline input? false

Accept wildcard characters? false



-Source <Object>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Destination <Object>



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-NsxFirewallSection TestSection | Get-NsxFirewallRule















RELATED LINKS