WinRM-config Cookbook

Configure WinRM service and client.

Requirements

This cookbook requires Chef 11.10.0+.

Platforms

This cookbook only supports the following platforms:

• Windows Server 2008 (R1, R2)
• Windows Server 2012 (R1, R2)

Usage

Place an explicit dependency on this cookbook (using depends in the cookbook's metadata.rb)
from any cookbook where you would like to use the winrm-config-specific resources/providers
that ship with this cookbook.

depends 'winrm-config'

Then include the recipes you want, or use one the LWRP provided.
The default recipe, should setup a working WinRM environment.

Providers & Resources

listener

Actions

Attributes

service_certmapping

This provider allows to configure or delete a WinRM user <-> certificate mapping.

NOTE: The user password cannot contain a double quote ", due to the usage of winrm.vbs (see #8)

Actions

Attributes

Recipes

winrm-config::client

Configures all WinRM client settings via registry keys, then performs a restart of the WinRM windows service.

Attributes

WinRM client settings are configurable via node['winrm_config']['client'] attributes, which follows the msdn documentation.

Default ports used for either HTTP or HTTPs can be configured via node['winrm_config']['client']['DefaultPorts']

winrm-config::default

A convenience recipe that include the following recipes to enable a default WinRM working service:

• winrm-config::windows_service
• winrm-config::protocol
• winrm-config::client
• winrm-config::listeners
• winrm-config::service
• winrm-config::winrs

winrm-config::listeners

A convenience recipe to defines WinRM listeners via registry keys, then
performs a restart of the WinRM windows service.

Attributes

You can define multiples listener via the node['winrm_config']['listeners']
hash, following the msdn documentation for each entry.

winrm-config::protocol

Configures WinRM protocol settings via registry key, then preforms a restart
of the WinRM windows service.

Attributes

WinRM protocol settings attributes are accessible via node['winrm_config']['protocol'],
following the msdn documentation.

winrm-config::service

Configures all WinRM service settings via registry keys, then performs a
restart of the WinRM windows service.

Attributes

WinRM service settings are configurable via node['winrm_config']['service']
attributes, which follows the msdn documentation.

winrm-config::windows_service

A simple recipe to enable and start the WinRM Windows service.

winrm-config::winrs

Configures the WinRS settings via registry keys, then performs a restart of
the WinRM windows service.

Attributes

WinRS settings are configurable via node['winrm_config']['winrs']

Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

License and Authors

Authors: Baptiste Courtois (b.courtois@criteo.com)

Copyright 2015, Criteo.

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.