WinRM Cookbook

Installs and configures WinRM on a Windows System

Requirements

Platforms

• Windows 2008 R2
• Windows 2012 R2

If you would like support for your preferred platform. Please think about creating a Vagrant Box and adding test platforms

Chef

• Chef 13.0+

Known Limitations

• Does not install PowerShell, must be already installed.

Recipes

default

Installs and configures WinRM on the windows system. Ensures firewall rules allow traffic to WinRM.

The recipe does the following:

1. Search for thumbprint for the FQDN of the node, if found use it. Otherwise create a new self signed SSL certificate if SSL is enabled.
2. Install WinRM via quick configure
3. Configure listeners, HTTP and/or HTTPS
4. Configure additional options
5. Create firewall rules

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

Examples

winrm_listener_config 'default' do
  listen_http false
  allow_unencrypted false
end

License

Copyright 2014-2015, Webtrends Inc.
Copyright 2019, Chef Software, Inc.

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

    http://www.apache.org/licenses/LICENSE-2.0

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.