https://github.com/sous-chefs/winrm
Development repository for the winrm cookbook
https://github.com/sous-chefs/winrm
chef chef-cookbook chef-resource hacktoberfest managed-by-terraform winrm
Last synced: 8 months ago
JSON representation
Development repository for the winrm cookbook
- Host: GitHub
- URL: https://github.com/sous-chefs/winrm
- Owner: sous-chefs
- License: apache-2.0
- Created: 2014-02-14T18:27:06.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2025-09-16T04:48:02.000Z (9 months ago)
- Last Synced: 2025-09-16T19:27:58.772Z (9 months ago)
- Topics: chef, chef-cookbook, chef-resource, hacktoberfest, managed-by-terraform, winrm
- Language: Ruby
- Homepage: https://supermarket.chef.io/cookbooks/winrm
- Size: 164 KB
- Stars: 5
- Watchers: 37
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# WinRM Cookbook
[](https://supermarket.chef.io/cookbooks/winrm)
[](https://circleci.com/gh/sous-chefs/winrm)
[](#backers)
[](#sponsors)
[](https://opensource.org/licenses/Apache-2.0)
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](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).
## Requirements
### Platforms
- Windows 2012 / 2012 R2
- Windows 2016
- Windows 2019
- Windows 2022
### Chef
- Chef 15.4+
## 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
```ruby
winrm_listener_config 'default' do
listen_http false
allow_unencrypted false
end
```
## Contributors
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
### 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.
