windows_firewall_rule Resource
This page is generated from the Chef Infra Client source code.To suggest a change, edit the windows_firewall_rule.rb file and submit a pull request to the Chef Infra Client repository.
Use the windows_firewall_rule resource to create, change or remove Windows firewall rules.
New in Chef Infra Client 14.7.
Syntax
The full syntax for all of the properties that are available to the windows_firewall_rule resource is:
windows_firewall_rule 'name' do
description String
direction Symbol, String # default value: :inbound
displayname String # default value: The rule_name property value.
enabled true, false # default value: true
firewall_action Symbol, String # default value: :allow
group String
icmp_type String, Integer # default value: "Any"
interface_type Symbol, String # default value: :any
local_address String
local_port String, Integer, Array
profile Symbol, String, Array # default value: :any
program String
protocol String # default value: "TCP"
remote_address String, Array
remote_port String, Integer, Array
rule_name String # default value: 'name' unless specified
service String
action Symbol # defaults to :create if not specified
end
where:
windows_firewall_rule
is the resource.name
is the name given to the resource block.action
identifies which steps Chef Infra Client will take to bring the node into the desired state.description
,direction
,displayname
,enabled
,firewall_action
,group
,icmp_type
,interface_type
,local_address
,local_port
,profile
,program
,protocol
,remote_address
,remote_port
,rule_name
, andservice
are the properties available to this resource.
Actions
The windows_firewall_rule resource has the following actions:
:create
- Create a Windows firewall entry. (default)
:delete
- Delete an existing Windows firewall entry.
:nothing
- This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run.
Properties
The windows_firewall_rule resource has the following properties:
description
- Ruby Type: String
The description to assign to the firewall rule.
direction
- Ruby Type: Symbol, String | Default Value:
:inbound
Allowed Values::inbound, :outbound
The direction of the firewall rule. Direction means either inbound or outbound traffic.
displayname
- Ruby Type: String | Default Value:
The rule_name property value.
The displayname to assign to the firewall rule.
New in Chef Infra Client 16.0
enabled
- Ruby Type: true, false | Default Value:
true
Whether or not to enable the firewall rule.
firewall_action
- Ruby Type: Symbol, String | Default Value:
:allow
Allowed Values::allow, :block, :notconfigured
The action of the firewall rule.
group
- Ruby Type: String
Specifies that only matching firewall rules of the indicated group association are copied.
New in Chef Infra Client 16.0
icmp_type
- Ruby Type: String, Integer | Default Value:
Any
Specifies the ICMP Type parameter for using a protocol starting with ICMP
New in Chef Infra Client 16.0
interface_type
- Ruby Type: Symbol, String | Default Value:
:any
Allowed Values::any, :remoteaccess, :wired, :wireless
The interface type the firewall rule applies to.
local_address
- Ruby Type: String
The local address the firewall rule applies to.
local_port
- Ruby Type: String, Integer, Array
The local port the firewall rule applies to.
profile
- Ruby Type: Symbol, String, Array | Default Value:
:any
The profile the firewall rule applies to.
program
- Ruby Type: String
The program the firewall rule applies to.
protocol
- Ruby Type: String | Default Value:
TCP
The protocol the firewall rule applies to.
remote_address
- Ruby Type: String, Array
The remote address(es) the firewall rule applies to.
remote_port
- Ruby Type: String, Integer, Array
The remote port the firewall rule applies to.
rule_name
- Ruby Type: String | Default Value:
The resource block's name
An optional property to set the name of the firewall rule to assign if it differs from the resource block’s name.
service
- Ruby Type: String
The service the firewall rule applies to.
Common Resource Functionality
Chef resources include common properties, notifications, and resource guards.
Common Properties
The following properties are common to every resource:
compile_time
Ruby Type: true, false | Default Value:
false
Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the
compile phase
). Set to false to run while Chef Infra Client is configuring the node (theconverge phase
).ignore_failure
Ruby Type: true, false, :quiet | Default Value:
false
Continue running a recipe if a resource fails for any reason.
:quiet
will not display the full stack trace and the recipe will continue to run if a resource fails.retries
Ruby Type: Integer | Default Value:
0
The number of attempts to catch exceptions and retry the resource.
retry_delay
Ruby Type: Integer | Default Value:
2
The delay in seconds between retry attempts.
sensitive
Ruby Type: true, false | Default Value:
false
Ensure that sensitive resource data is not logged by Chef Infra Client.
Notifications
notifies
Ruby Type: Symbol, 'Chef::Resource[String]'
A resource may notify another resource to take action when its state changes. Specify a
'resource[name]'
, the:action
that resource should take, and then the:timer
for that action. A resource may notify more than one resource; use anotifies
statement for each resource to be notified.If the referenced resource does not exist, an error is raised. In contrast,
subscribes
will not fail if the source resource is not found.
A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:
:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.
:immediate
,:immediately
Specifies that a notification should be run immediately, for each resource notified.
The syntax for notifies
is:
notifies :action, 'resource[name]', :timer
subscribes
Ruby Type: Symbol, 'Chef::Resource[String]'
A resource may listen to another resource, and then take action if the
state of the resource being listened to changes. Specify a
'resource[name]'
, the :action
to be taken, and then the :timer
for
that action.
Note that subscribes
does not apply the specified action to the
resource that it listens to - for example:
file '/etc/nginx/ssl/example.crt' do
mode '0600'
owner 'root'
end
service 'nginx' do
subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end
In this case the subscribes
property reloads the nginx
service
whenever its certificate file, located under
/etc/nginx/ssl/example.crt
, is updated. subscribes
does not make any
changes to the certificate file itself, it merely listens for a change
to the file, and executes the :reload
action for its resource (in this
example nginx
) when a change is detected.
If the other resource does not exist, the subscription will not raise an
error. Contrast this with the stricter semantics of notifies
, which
will raise an error if the other resource does not exist.
A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:
:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.
:immediate
,:immediately
Specifies that a notification should be run immediately, for each resource notified.
The syntax for subscribes
is:
subscribes :action, 'resource[name]', :timer
Guards
A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:
- A string is executed as a shell command. If the command returns
0
, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a powershell_script run Windows PowerShell commands and may returntrue
in addition to0
. - A block is executed as Ruby code that must return either
true
orfalse
. If the block returnstrue
, the guard property is applied. If the block returnsfalse
, the guard property is not applied.
A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.
PropertiesThe following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:
not_if
Prevent a resource from executing when the condition returns
true
.only_if
Allow a resource to execute only if the condition returns
true
.
Examples
The following examples demonstrate various approaches for using the windows_firewall_rule resource in recipes:
Allowing port 80 access:
windows_firewall_rule 'IIS' do
local_port '80'
protocol 'TCP'
firewall_action :allow
end
Configuring multiple remote-address ports on a rule:
windows_firewall_rule 'MyRule' do
description 'Testing out remote address arrays'
enabled false
local_port 1434
remote_address %w(10.17.3.101 172.7.7.53)
protocol 'TCP'
action :create
end
Allow protocol ICMPv6 with ICMP Type:
windows_firewall_rule 'CoreNet-Rule' do
rule_name 'CoreNet-ICMP6-LR2-In'
display_name 'Core Networking - Multicast Listener Report v2 (ICMPv6-In)'
local_port 'RPC'
protocol 'ICMPv6'
icmp_type '8'
end
Blocking WinRM over HTTP on a particular IP:
windows_firewall_rule 'Disable WinRM over HTTP' do
local_port '5985'
protocol 'TCP'
firewall_action :block
local_address '192.168.1.1'
end
Deleting an existing rule
windows_firewall_rule 'Remove the SSH rule' do
rule_name 'ssh'
action :delete
end