firewall rule

The <firewall rule> inspectors are implemented as a wrapper of the firewall APIs of Windows and macOS. On unsupported systems, they return no results. For more information on the Windows implementation, see the Microsoft documentation for the INetFwRule interface.

Creation
Properties

Version	Platforms
8.0.584.0	Windows

Creation

rule of <firewall service restriction> : firewall rule

Retrieves the collection of Windows Service Hardening network rules for the specified firewall service restriction. For more information, see the MSDN Library section on INetFwServiceRestriction.

Plural: rules

Version	Platforms
8.0.584.0	Windows

permalink source

rule of <firewall> : firewall rule

Retrieves the collection of rules for the specified firewall. For more information on Windows, see the Microsoft documentation for the INetFwPolicy2 interface.

Example running the QnA on a Windows computer showing names of firewall rules based on a specific action. Only the first 3 answers are shown.

Q: names of rules whose (action of it = firewall action 1) of firewall
A: Google Chrome (mDNS-In)
A: BES Client (ICMPv6)
A:

Example running the QnA on a Mac computer showing rules of firwall. Only the first 3 answers are shown.

Q: (application name of it, service name of it, action of it) of rules of firewall
A: com.apple.iBooksX, , Allow
A: com.apple.WebKit.Networking, , Allow
A: , Screen Sharing, Allow

Plural: rules

Version	Platforms
8.0.584.0	Windows
11.0.4.0	Mac

permalink source

Properties

action of <firewall rule> : firewall action

Retrieves the type of action that the specified firewall rule is set to perform (e.g. blocking network traffic). On Windows, this property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface and the NET_FW_ACTION enumeration.

Example running the QnA on a Windows computer showing the target application of each firewall rule that allows network traffic. Only the first 3 answers are shown.

Q: names of rules whose (action of it = firewall action 1) of firewall
A: Google Chrome (mDNS-In)
A: BES Client (ICMPv6)
A: BES Client (ICMPv4)

Example running the QnA on a Mac computer showing the target application of each firewall rule that allows network traffic. Only the first 3 answers are shown.

Q: (application name of it) of rules whose (action of it = firewall action 1) of firewall
A: com.apple.iBooksX
A:
A:

Plural: actions

Version	Platforms
8.0.584.0	Windows
11.0.4.0	Mac

permalink source

application name of <firewall rule> : string

Retrieves the application name property for the specified firewall rule. On Windows, this property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

This property returns an empty string if the firewall rule does not specify an application name.

Example running the QnA on a Windows computer showing application names of a rule. Only the first 3 answers are shown.

Q: (application name of it) of rules whose (action of it = firewall action 1) of firewall
A: C:\Program Files (x86)\BigFix Enterprise\BES Client\BESClient.exe
A: C:\Program Files (x86)\BigFix Enterprise\BES Client\BESClient.exe
A:

Example running the QnA on a Mac computer showing application names of a rule. Only the first 3 answers are shown.

Q: application names of rules of firewall
A: com.apple.screensharing.daemon
A: com.apple.iBooksX
A:

Plural: application names

Version	Platforms
8.0.584.0	Windows
11.0.4.0	Mac

permalink source

currently active of <firewall rule> : boolean

Currently active is true if and only if the specified firewall rule is enabled (the Enabled property is true) AND the currently active profile type (as defined by the CurrentProfileTypes property of INetFwPolicy2) is one of the profiles for which the rule applies (as defined by the Profiles property). For more information see the MSDN Library articles for INetFwRule, including the CurrentProfileTypes and Profiles properties.

Plural: currently actives

Version	Platforms
8.0.584.0	Windows

permalink source

description of <firewall rule> : string

Retrieves the Description property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: descriptions

Version	Platforms
8.0.584.0	Windows

permalink source

edge traversal allowed of <firewall rule> : boolean

Retrieves the EdgeTraversal property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: edge traversal alloweds

Version	Platforms
8.0.584.0	Windows

permalink source

enabled of <firewall rule> : boolean

Retrieves the Enabled property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: enableds

Version	Platforms
8.0.584.0	Windows

permalink source

grouping of <firewall rule> : string

Retrieves the Grouping property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: groupings

Version	Platforms
8.0.584.0	Windows

permalink source

icmp types_and_codes string of <firewall rule> : string

Retrieves the IcmpTypesAndCodes property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: icmp types_and_codes strings

Version	Platforms
8.0.584.0	Windows

permalink source

inbound of <firewall rule> : boolean

Retrieves the inbound direction property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: inbounds

Version	Platforms
8.0.584.0	Windows

permalink source

interface of <firewall rule> : string

Retrieves the Interfaces property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: interfaces

Version	Platforms
8.0.584.0	Windows

permalink source

interface types string of <firewall rule> : string

Retrieves the Interface types property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: interface types strings

Version	Platforms
8.0.584.0	Windows

permalink source

local addresses string of <firewall rule> : string

Plural: local addresses strings

Version	Platforms
8.0.584.0	Windows

permalink source

local ports string of <firewall rule> : string

Retrieves the LocalPorts property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: local ports strings

Version	Platforms
8.0.584.0	Windows

permalink source

name of <firewall rule> : string

Retrieves the Name property for the specified firewall rule. On Windows, this property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

This property returns an empty string if the firewall rule does not have a name.

Example running the QnA on a Window computer showing names of a rules. Only the first 3 answers are shown.

Q: names of rules of firewall
A: BES Client (ICMPv6)
A: BES Client (ICMPv4)
A:

Plural: names

Version	Platforms
8.0.584.0	Windows

permalink source

outbound of <firewall rule> : boolean

Retrieves the outbound direction property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: outbounds

Version	Platforms
8.0.584.0	Windows

permalink source

profile <firewall profile type> of <firewall rule> : boolean

Retrieves the given profile property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: profiles

Version	Platforms
8.0.584.0	Windows

permalink source

protocol of <firewall rule> : internet protocol

Retrieves the Protocol property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: protocols

Version	Platforms
8.0.584.0	Windows

permalink source

remote addresses string of <firewall rule> : string

Retrieves the RemoteAddresses property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: remote addresses strings

Version	Platforms
8.0.584.0	Windows

permalink source

remote ports string of <firewall rule> : string

Retrieves the RemotePorts property for the specified firewall rule. This property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

Plural: remote ports strings

Version	Platforms
8.0.584.0	Windows

permalink source

service name of <firewall rule> : string

Retrieves the ServiceName property for the specified firewall rule. On Windows, this property is implemented as a wrapper around the Windows Firewall API. For more information, see the Microsoft documentation for the INetFwRule interface.

This property returns an empty string if the firewall rule does not specify a service name.

Example running the QnA on a Window computer showing service names associated with the firewall rules. Only the first 4 answers are shown.

Q: service names of rules of firewall
A:
A:
A: Ssdpsrv
A: Ssdpsrv

Example running the QnA on a Mac computer showing service names associated with the firewall rules. Only the first 4 answers are shown.

Q: service names of rules of firewall
A:
A:
A: Screen Sharing
A: Remote Login - SSH

Plural: service names

Version	Platforms
8.0.584.0	Windows
11.0.4.0	Mac

permalink source