Defined Type: registry::service

Defined in:
manifests/service.pp

Summary

Defined resource type that manages service entries

Overview

Manages the values in the key HKLMSystemCurrentControlSetServices$name\

Note:

This defined resource type manages service entries in the Microsoft service control framework by managing the appropriate registry keys and values.

This is an alternative approach to using INSTSRV.EXE [1].

1

support.microsoft.com/kb/137890

Examples:

Sample Usage:

registry::service { puppet:
  ensure       => present,
  display_name => 'Puppet Agent',
  description  => 'Periodically fetches and applies
                   configurations from a Puppet Server.',
  command      => 'C:\PuppetLabs\Puppet\service\daemon.bat',
}

Parameters:

  • ensure (Enum['present', 'absent', 'UNSET']) (defaults to: 'UNSET') —

    Ensures the presence or absence of a registry key. Valid values: ‘present’, ‘absent’, ‘UNSET’.

  • display_name (String[1]) (defaults to: 'UNSET') —

    The Display Name of the service. Defaults to the title of the resource.

  • description (String[1]) (defaults to: 'UNSET') —

    A description of the service. String value set to ‘UNSET’ by default.

  • command (String[1]) (defaults to: 'UNSET') —

    The command to execute. Set to ‘UNSET’ by default.

  • start (Enum['automatic', 'manual', 'disabled', 'UNSET']) (defaults to: 'UNSET') —

    The starting mode of the service. (Note, the native service resource can also be used to manage this setting.) Valid values: ‘automatic’, ‘manual’, ‘disabled’



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'manifests/service.pp', line 39

define registry::service (
  Enum['present', 'absent', 'UNSET'] $ensure              = 'UNSET',
  String[1] $display_name                                 = 'UNSET',
  String[1] $description                                  = 'UNSET',
  String[1] $command                                      = 'UNSET',
  Enum['automatic', 'manual', 'disabled', 'UNSET'] $start = 'UNSET'
) {
  $ensure_real = $ensure ? {
    'UNSET'  => present,
    'present' => present,
    'absent'  => absent,
  }

  $display_name_real = $display_name ? {
    'UNSET' => $name,
    default => $display_name,
  }

  $description_real = $description ? {
    'UNSET' => $display_name_real,
    default => $description,
  }

  # FIXME Better validation of the command parameter.
  # (Fully qualified path?  Though, it will be a REG_EXPAND_SZ.)
  $command_real = $command ? {
    default => $command,
  }

  # Map descriptive names to flags.
  $start_real = $start ? {
    'automatic' => 2,
    'manual'    => 3,
    'disabled'  => 4,
  }

  # Variable to hold the base key path.
  $service_key = "HKLM\\System\\CurrentControlSet\\Services\\${name}"

  # Manage the key
  if $ensure_real == present {
    registry_key { $service_key:
      ensure => present,
    }
  } else {
    registry_key { $service_key:
      ensure => absent,
      # REVISIT: purge_values => true,
    }
  }

  # Manage the values
  if $ensure_real == present {
    registry_value { "${service_key}\\Description":
      ensure => present,
      type   => string,
      data   => $description_real,
    }
    registry_value { "${service_key}\\DisplayName":
      ensure => present,
      type   => string,
      data   => $display_name_real,
    }
    registry_value { "${service_key}\\ErrorControl":
      ensure => present,
      type   => dword,
      data   => 0x00000001,
    }
    registry_value { "${service_key}\\ImagePath":
      ensure => present,
      type   => expand,
      data   => $command_real,
    }
    registry_value { "${service_key}\\ObjectName":
      ensure => present,
      type   => string,
      data   => 'LocalSystem',
    }
    registry_value { "${service_key}\\Start":
      ensure => present,
      type   => dword,
      data   => $start_real,
    }
    registry_value { "${service_key}\\Type":
      ensure => present,
      type   => dword,
      data   => 0x00000010, # (16)
    }
  }
}