FirewallProfiles.adoc

DSC Resource 'FirewallProfiles'

FirewallProfiles configures a node’s private, public or domain firewall profile.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/FirewallProfiles
DSC Resource	xPSDesiredStateConfiguration NetworkingDsc
Documentation	FirewallProfiles

Table 1. Attributes of category 'FirewallProfiles'

Parameter	Attribute	DataType	Description	Allowed Values
Profile	Mandatory	hashtable

Table 2. Attributes of category 'FirewallProfiles/Profile'

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the firewall profile to configure.	Domain Public Private
AllowInboundRules		String	Specifies that the firewall blocks inbound traffic.	True False NotConfigured
AllowLocalFirewallRules		String	Specifies that the local firewall rules should be merged into the effective policy along with Group Policy settings.	True False NotConfigured
AllowLocalIPsecRules		String	Specifies that the local IPsec rules should be merged into the effective policy along with Group Policy settings.	True False NotConfigured
AllowUnicastResponseToMulticast		String	Allows unicast responses to multi-cast traffic.	True False NotConfigured
AllowUserApps		String	Specifies that traffic from local user applications is allowed through the firewall.	True False NotConfigured
AllowUserPorts		String	Specifies that traffic is allowed through local user ports.	True False NotConfigured
DefaultInboundAction		String	Specifies how to filter inbound traffic.	Block Allow NotConfigured
DefaultOutboundAction		String	Specifies how to filter outbound traffic.	Block Allow NotConfigured
DisabledInterfaceAliases		String[]	Specifies a list of interfaces on which firewall settings are excluded.
Enabled		String	Specifies that devolution is activated.	True False NotConfigured
EnableStealthModeForIPsec		String	Enables stealth mode for IPsec traffic.	True False NotConfigured
LogAllowed		String	Specifies how to log the allowed packets in the location specified by the LogFileName parameter.	True False NotConfigured
LogBlocked		String	Specifies how to log the dropped packets in the location specified by the LogFileName parameter.	True False NotConfigured
LogFileName		String	Specifies the path and filename of the file to which Windows Server writes log entries.
LogIgnored		String	Specifies how to log the ignored packets in the location specified by the LogFileName parameter.	True False NotConfigured
LogMaxSizeKilobytes		UInt64	Specifies the maximum file size of the log, in kilobytes.	1 - 32767
NotifyOnListen		String	Allows the notification of listening for inbound connections by a service.	True False NotConfigured

Example

FirewallProfiles:
  Profile:
    - Name: Private
      Enabled: True
      DefaultInboundAction: Block
      DefaultOutboundAction: Allow
      AllowInboundRules: True
      AllowLocalFirewallRules: False
    - Name: Domain
      Enabled: false