DSCResources/DSC_FirewallProfile/en-US/about_FirewallProfile.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
.NAME
    FirewallProfile
 
.DESCRIPTION
    This resource is used to enable or disable and configure Windows Firewall with
    Advanced Security profiles.
 
.PARAMETER Name
    Key - String
    Allowed values: Domain, Public, Private
    The name of the firewall profile to configure.
 
.PARAMETER AllowInboundRules
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies that the firewall blocks inbound traffic.
 
.PARAMETER AllowLocalFirewallRules
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies that the local firewall rules should be merged into the effective policy along with Group Policy settings.
 
.PARAMETER AllowLocalIPsecRules
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies that the local IPsec rules should be merged into the effective policy along with Group Policy settings.
 
.PARAMETER AllowUnicastResponseToMulticast
    Write - String
    Allowed values: True, False, NotConfigured
    Allows unicast responses to multi-cast traffic.
 
.PARAMETER AllowUserApps
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies that traffic from local user applications is allowed through the firewall.
 
.PARAMETER AllowUserPorts
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies that traffic is allowed through local user ports.
 
.PARAMETER DefaultInboundAction
    Write - String
    Allowed values: Block, Allow, NotConfigured
    Specifies how to filter inbound traffic.
 
.PARAMETER DefaultOutboundAction
    Write - String
    Allowed values: Block, Allow, NotConfigured
    Specifies how to filter outbound traffic.
 
.PARAMETER DisabledInterfaceAliases
    Write - StringArray
    Specifies a list of interfaces on which firewall settings are excluded.
 
.PARAMETER Enabled
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies that devolution is activated.
 
.PARAMETER EnableStealthModeForIPsec
    Write - String
    Allowed values: True, False, NotConfigured
    Enables stealth mode for IPsec traffic.
 
.PARAMETER LogAllowed
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies how to log the allowed packets in the location specified by the LogFileName parameter.
 
.PARAMETER LogBlocked
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies how to log the dropped packets in the location specified by the LogFileName parameter.
 
.PARAMETER LogFileName
    Write - String
    Specifies the path and filename of the file to which Windows Server writes log entries.
 
.PARAMETER LogIgnored
    Write - String
    Allowed values: True, False, NotConfigured
    Specifies how to log the ignored packets in the location specified by the LogFileName parameter.
 
.PARAMETER LogMaxSizeKilobytes
    Write - UInt64
    Specifies the maximum file size of the log, in kilobytes. The acceptable values for this parameter are: 1 through 32767.
 
.PARAMETER NotifyOnListen
    Write - String
    Allowed values: True, False, NotConfigured
    Allows the notification of listening for inbound connections by a service.
 
.EXAMPLE 1
 
Configure the Private Firewall Profile.
 
Configuration FirewallProfile_ConfigurePrivateFirewallProfile_Config
{
    Import-DscResource -Module NetworkingDsc
 
    Node localhost
    {
        FirewallProfile ConfigurePrivateFirewallProfile
        {
            Name = 'Private'
            Enabled = 'True'
            DefaultInboundAction = 'Block'
            DefaultOutboundAction = 'Allow'
            AllowInboundRules = 'True'
            AllowLocalFirewallRules = 'False'
            AllowLocalIPsecRules = 'False'
            NotifyOnListen = 'True'
            LogFileName = '%systemroot%\system32\LogFiles\Firewall\pfirewall.log'
            LogMaxSizeKilobytes = 16384
            LogAllowed = 'False'
            LogBlocked = 'True'
            LogIgnored = 'NotConfigured'
        }
    }
}