WinRM Cookbook

Installs and configures WinRM on a Windows System

Maintainers

This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.

Requirements

Platforms

• Windows 2008 R2
• Windows 2012 / 2012 R2
• Windows 2016

Chef

• Chef 13.0+

Additional Requirements

• PowerShell must already be installed

Resources

winrm_listener_config

Configure winrm listeners on a host. Previously this resource was named winrm and that legacy name will continue to function.

Actions

• :create - configure a listener

Properties

• hostname - Used for creating the listeners and finding the certificate thumbprint or creating a new one, default node['fqdn']
• trusted_hosts - Trusted hosts to allow connections from, default '*'
• max_shell_memory - Max memory allowed for each remote shell, default 1024
• thumbprint - Specify a certificate thumbprint to use, if nil will looks for certificate matching hostname, default nil
• listen_http - Enable HTTP listener, default true
• listen_https - Enable HTTPS listener, default true
• allow_unencrypted - Wether to allow unencrypted WinRM connections, default true
• allow_basic_auth - Enable Basic Authentication, default true
• generate_cert - Whether to generate a cert if none is found, default true
• add_firewall_rule - Whether to create a firewall rule which allows WinRM access, default true

Examples

winrm_listener_config 'default' do
  listen_http false
  allow_unencrypted false
end

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.