Skip to main content

windows.firewall.rule

Description

Windows Firewall rule entry

Fields

IDTYPEDESCRIPTION
instanceIDstringA string that uniquely identifies this instance within the policy store
namestringName of the rule
displayNamestringLocalized name of this rule
descriptionstringBrief description of the rule
displayGroupstringThe group that this rule belongs to
enabledintIndicates whether this rule is administratively enabled or disabled, Values: enabled (1), disabled (2)
directionintSpecifies which direction of traffic to match with this rule, Values: inbound (1), outbound (2)
actionintSpecifies the action to take on traffic that matches this rule
edgeTraversalPolicyintSpecifies how this firewall rule will handle edge traversal cases, Values: block (0), allow (1), defer to user (2), defer to app (3)
looseSourceMappingboolWhether to group UDP packets into conversations based on the local address, local port, and remote port
localOnlyMappingboolWhether to group UDP packets into conversations based only on the local address and port
primaryStatusintPrimaryStatus provides a high level status value, Values: unknown (0), OK (1), degraded (2), error (3)
statusstringDetailed status of the rule
enforcementStatusstringWhether this object is retrieved from the ActiveStore
policyStoreSourcestringContains the path to the policy store where this rule originally came from
policyStoreSourceTypeintDescribes the type of policy store where this rule originally came from