Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms


windows_firewall (5) Versions 3.0.0

Configures firewall rules on Windows

cookbook 'windows_firewall', '= 3.0.0'
cookbook 'windows_firewall', '= 3.0.0', :supermarket
knife cookbook site install windows_firewall
knife cookbook site download windows_firewall

windows_firewall Cookbook

This cookbook configures Windows firewall rules.

3.0 Breaking Changes

The protocol attribute was changed from a symbol to a string. If you were explicitly referencing this attribute in your recipes, you will need to update all usages to a string, or remove each usage to rely on the default value ('TCP'):

    windows_firewall_rule 'Apache' do
          protocol 'TCP' # was protocol :TCP


Version 2.0.0+ of this cookbook requires Chef 11+


  • Windows Vista
  • Windows 7
  • Windows 8
  • Windows Server 2008
  • Windows Server 2008R2
  • Windows Server 2012
  • Windows Server 2012R2


In your recipe, you can use the windows_firewall_rule resource. Currently, the only supported action is :create. Attribute defaults match the netsh advfirewall defaults if they are required by netsh advfirewall, otherwise they are set to 'nil'.

This is a resource-only cookbook, and adding the default recipe to a node's runlist will have no effect.




:create - creates a firewall rule with the parameters supplied

Attribute Parameters

  • name Name attribute. The name of the firewall rule name to create.
  • description The firewall rule description. Optional.
  • localip Can be 'any', a specific address, a subnet in CIDR or ip/mask notation, or a range separated by '-'
  • localport Can be 'any', an integer or one of { rpc | rpc-epmap | iphttps | teredo | [ ,... ] }
  • remoteip Can be 'any', a specific address, a subnet in CIDR or ip/mask notation, or a range separated by '-''
  • remoteport Can be 'any', an integer or one of { rpc | rpc-epmap | iphttps | teredo | [ ,... ] }
  • dir Direction of the rule. Can be in or out. Default is in.
  • protocol Can by 'any', an integer, or one of { | icmpv4 | icmpv6 | icmpv4:type,code | icmpv6:type,code | tcp | udp }
  • firewall_action Can be allow, block, or bypass. Default is 'allow'
  • profile Can be public, private, domain, or any
  • program The path to the program.
  • service The short name of the service, or 'any'
  • interface_type Can be any, wireless, lan, or ras


    windows_firewall_rule 'Apache' do
          localport '8080'
          protocol 'TCP'
          firewall_action :allow

License & Authors

Author:: Matt Clifton ( Copyright:: 2013-2015 Matt Clifton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

CHANGELOG for windows_firewall

This file is used to list changes made in each version of windows_firewall.


BREAKING CHANGES * Change default action :open to :create

MAJOR CHANGE * Test-kitchen support (only for Windows 2012R2 currently, but tests version 11 and 12 of chef-client) * Update metadata with proper attribution as well as Apache license * Add more attributes (including remoteip, program, service, etc) * Most attributes are set to nil by default and only added to the command if present * Style cleanup from rubocop and foodcritic * Use batchresource instead of windows_batch * Bumps cookbook version to 2.0


Added remoteip and localip attributes. Added Berksfile and preliminary test-kitchen harness. Several bits of cleanup that should not introduce any breaking changes, but a version bump seemed prudent.


  • Initial release of windows_firewall

Check the Markdown Syntax Guide for help with Markdown.

The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.

Foodcritic Metric

3.0.0 failed this metric

FC031: Cookbook without metadata file: /tmp/cook/8af7433bcee4e1ca484659a8/windows_firewall/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/8af7433bcee4e1ca484659a8/windows_firewall/metadata.rb:1