Puppet Class: winrm::config::listener::https

Defined in:
manifests/config/listener/https.pp

Summary

Configures the SSL (HTTPS) listener on the system. Also attaches a Certificate to the listen. Will either generate a self signed one or a hash can be passed in. https://docs.microsoft.com/en-us/powershell/module/microsoft.wsman.management/new-wsmaninstance?view=powershell-7 https://docs.microsoft.com/en-us/powershell/module/microsoft.wsman.management/remove-wsmaninstance?view=powershell-7

Overview

Examples:

Usage:

class { 'winrm::config::listener::https':
  cert_validity_days    => 1095,
  certificate_hash      => 'test cert hash',
  https_listener_enable => true,
  cert_common_name      => 'myhost.domain.tld',
}

Parameters:

  • certificate_hash (String) (defaults to: $winrm::certificate_hash) —

    If not using a Self Signed Certificate then this hash can be passed in and used for the HTTPs/SSL listener

  • cert_validity_days (Integer) (defaults to: $winrm::cert_validity_days) —

    Length of time in days the Self Signed certificate is good for. Default is 1095

  • https_listener_enable (Boolean) (defaults to: $winrm::https_listener_enable) —

    Should winrm be listening for https connections. Defialt is true

  • cert_common_name (String) (defaults to: $winrm::cert_common_name) —

    Common name of the self-signed or custom bound certificate. If you specify a custom certificate_hash, the CN (Common Name) in that certificate MUST match this value, otherwise the cert binding will not work.



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'manifests/config/listener/https.pp', line 29

class winrm::config::listener::https (
  Boolean $https_listener_enable = $winrm::https_listener_enable,
  String $certificate_hash       = $winrm::certificate_hash,
  Integer $cert_validity_days    = $winrm::cert_validity_days,
  String $cert_common_name       = $winrm::cert_common_name,
) {
  exec { 'Configure-HTTPS-Listener':
    command   => template('winrm/listener/https_listener.ps1.erb'),
    provider  => 'powershell',
    logoutput => true,
    unless    => template('winrm/listener/https_listener_unless.ps1.erb'),
  }
}