cookbook 'winrm', '= 4.0.0'
winrm (12) Versions 4.0.0 Follow8
Installs and configures WinRM
cookbook 'winrm', '= 4.0.0', :supermarket
knife supermarket install winrm
knife supermarket download winrm
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 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, ifnil
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.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
4.0.0 - 2024-05-06
- Update ci.yml to use sous-chef reusable workflow
- Add unified_mode flag
- Remove EOL'd OS version
- Remove deprecated windows_firewall cookbook dependency
- Update minimum Chef version to 15.4
- Add minimal unit tests
- Update spec test to use a supported OS version
- Update kitchen.yml and kitchen.appveyor.yml to remove EOL'd OS version
- Add kitchen-azure.yml with all currently supported OS versions.
- Update README with minimum Chf versions and supported windows versions
- Remove Appveyor.yml and kitchen.appveyor.yml
- Remove kitchen-azure.yml
3.0.5 - 2024-05-06
3.0.4 - 2023-11-01
- resolved cookstyle error: metadata.rb:13:1 refactor:
Chef/Modernize/DependsOnWindowsFirewallCookbook
- resolved cookstyle error: resources/listener_config.rb:1:1 refactor:
Chef/Deprecations/ResourceWithoutUnifiedTrue
- Update testing
3.0.3 - 2021-08-31
- Standardise files with files in sous-chefs/repo-management
3.0.2 - 2021-06-01
- resolved cookstyle error: test/smoke/default/default_test.rb:1:1 convention:
Style/Encoding
3.0.1
- refer to the correct certificate store for machine certs
- return the certificate thumbprint as an object attribute, not a substring search
- Migrate to actions
3.0.0 (2019-02-02)
- This cookbook now requires Chef 13 or later as Chef 12 has been end of life for nearly a year
- Rename the
winrm
resource towinrm_listener_config
with backwards compatibility for the old name - Renamed the resource properties to better align with other Chef resources while providing full compatibility with the previous names
2.0.0 (2017-10-19)
- BREAKING CHANGE, attributes no longer exist
- Convert to custom resource
- Update to work with newer chef versions
1.0.2
- Added configurable Everyone group attribute
1.0.1 (10-16-2015)
- Added Kitchen CI config
- Added rubocop config
- Added Berksfile
- Added gitignore and chefignore filex
- Moved Gemfile and add standard development dependencies
- Fixed the license in the metadata to be Apache 2.0
- Added modern Ruby releases to Travis and add rubocop and chefspec testing
- Added retina badges to the readme and added the cookbook version badge
1.0.0 (02-14-2014)
- Initial release of the WinRM cookbook
- Adding support for Travis-CI and foodcritic
Collaborator Number Metric
4.0.0 passed this metric
Contributing File Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
4.0.0 passed this metric
No Binaries Metric
4.0.0 passed this metric
Testing File Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
4.0.0 passed this metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
4.0.0 passed this metric
No Binaries Metric
4.0.0 passed this metric
Testing File Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
4.0.0 passed this metric
4.0.0 passed this metric
Testing File Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
4.0.0 failed this metric
4.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number