Reference

systemd::coredump: This class manages the systemd-coredump configuration.
systemd::install: Install any systemd sub packages
systemd::journald: This class manages and configures journald.
systemd::logind: This class manages systemd's login manager configuration.
systemd::machine_info: This class manages systemd's machine-info file (hostnamectl)
systemd::modules_loads: Activate the modules contained in modules-loads.d
systemd::networkd: This class provides an abstract way to trigger systemd-networkd
systemd::oomd: This class manages and configures oomd.
systemd::resolved: This class provides an abstract way to trigger resolved.
systemd::system: This class provides a solution to enable accounting
systemd::timesyncd: This class provides an abstract way to trigger systemd-timesyncd
systemd::udevd: This class manages systemd's udev config

Defined types

systemd::daemon_reload: Run systemctl daemon-reload
systemd::dropin_file: Creates a drop-in file for a systemd unit
systemd::manage_dropin: Creates a drop-in file for a systemd unit from a template
systemd::manage_unit: Generate unit file from template
systemd::modules_load: Creates a modules-load.d drop file
systemd::network: Creates network config for systemd-networkd
systemd::service_limits: Adds a set of custom limits to the service
systemd::timer: Create a timer and optionally a service unit to execute with the timer unit
systemd::tmpfile: Creates a systemd tmpfile
systemd::udev::rule: Adds a custom udev rule
systemd::unit_file: Creates a systemd unit file

Resource types

loginctl_user: An arbitrary name used as the identity of the resource.

Functions

systemd::escape: Escape strings as systemd-escape does.
systemd::systemd_escape: Escape strings by call the systemd-escape command in the background.

Data types

Systemd::CoredumpSettings: Configurations for coredump.conf
Systemd::Dropin: custom datatype that validates filenames/paths for valid systemd dropin files
Systemd::JournaldSettings: Matches Systemd journald config Struct
Systemd::JournaldSettings::Ensure: defines allowed ensure states for systemd-journald settings
Systemd::LogindSettings: Matches Systemd Login Manager Struct
Systemd::LogindSettings::Ensure: defines allowed ensure states for systemd-logind settings
Systemd::MachineInfoSettings: Matches Systemd machine-info (hostnamectl) file Struct
Systemd::OomdSettings: Configurations for oomd.conf
Systemd::ServiceLimits: Matches Systemd Service Limit Struct
Systemd::Unit: custom datatype that validates different filenames for systemd units and unit templates
Systemd::Unit::Install: Possible keys for the [Install] section of a unit file
Systemd::Unit::Path: Possible keys for the [Path] section of a unit file
Systemd::Unit::Service: Possible keys for the [Service] section of a unit file
Systemd::Unit::Service::Exec: Possible strings for ExecStart, ExecStartPrep, ...
Systemd::Unit::Socket: Possible keys for the [Socket] section of a unit file
Systemd::Unit::Timer: Possible keys for the [Timer] section of a unit file
Systemd::Unit::Unit: Possible keys for the [Unit] section of a unit file

Classes

`systemd`

This module allows triggering systemd commands once for all modules

Parameters

The following parameters are available in the systemd class:

default_target
service_limits
networks
timers
tmpfiles
unit_files
manage_resolved
resolved_ensure
resolved_package
dns
fallback_dns
domains
llmnr
multicast_dns
dnssec
dnsovertls
cache
dns_stub_listener
manage_resolv_conf
use_stub_resolver
manage_networkd
networkd_ensure
manage_timesyncd
timesyncd_ensure
timesyncd_package
ntp_server
fallback_ntp_server
manage_journald
journald_settings
manage_udevd
udev_log
udev_children_max
udev_exec_delay
udev_event_timeout
udev_resolve_names
udev_timeout_signal
udev_rules
machine_info_settings
manage_logind
logind_settings
loginctl_users
dropin_files
manage_all_network_files
network_path
manage_accounting
accounting
purge_dropin_dirs
manage_coredump
coredump_settings
coredump_backtrace
manage_oomd
oomd_ensure
oomd_settings

`default_target`

Data type: Optional[Pattern['^.+\.target$']]

The default systemd boot target, unmanaged if set to undef.

Default value: undef

`service_limits`

Data type: Hash[String[1],Hash[String[1], Any]]

May be passed a resource hash suitable for passing directly into the create_resources() function as called on systemd::service_limits

Default value: {}

`networks`

Data type: Hash[String[1],Hash[String[1], Any]]

Hash of systemd::network resources

Default value: {}

`timers`

Data type: Hash[String[1],Hash[String[1], Any]]

Hash of systemd::timer resources

Default value: {}

`tmpfiles`

Data type: Hash[String[1],Hash[String[1], Any]]

Hash of systemd::tmpfile resources

Default value: {}

`unit_files`

Data type: Hash[String[1],Hash[String[1], Any]]

Hash of systemd::unit_file resources

Default value: {}

`manage_resolved`

Data type: Boolean

Manage the systemd resolver

Default value: false

`resolved_ensure`

Data type: Enum['stopped','running']

The state that the resolved service should be in. When migrating from 'running' to 'stopped' an attempt will be made to restore a working /etc/resolv.conf using /run/systemd/resolve/resolv.conf.

Default value: 'running'

`resolved_package`

Data type: Optional[Enum['systemd-resolved']]

The name of a systemd sub package needed for systemd-resolved if one needs to be installed.

Default value: undef

`dns`

Data type: Optional[Variant[Array[String],String]]

A space-separated list of IPv4 and IPv6 addresses to use as system DNS servers. DNS requests are sent to one of the listed DNS servers in parallel to suitable per-link DNS servers acquired from systemd-networkd.service(8) or set at runtime by external applications. requires puppetlabs-inifile

Default value: undef

`fallback_dns`

Data type: Optional[Variant[Array[String],String]]

A space-separated list of IPv4 and IPv6 addresses to use as the fallback DNS servers. Any per-link DNS servers obtained from systemd-networkd take precedence over this setting. requires puppetlabs-inifile

Default value: undef

`domains`

Data type: Optional[Variant[Array[String],String]]

A space-separated list of domains host names or IP addresses to be used systemd-resolved take precedence over this setting.

Default value: undef

`llmnr`

Data type: Optional[Variant[Boolean,Enum['resolve']]]

Takes a boolean argument or "resolve".

Default value: undef

`multicast_dns`

Data type: Optional[Variant[Boolean,Enum['resolve']]]

Takes a boolean argument or "resolve".

Default value: undef

`dnssec`

Data type: Optional[Variant[Boolean,Enum['allow-downgrade']]]

Takes a boolean argument or "allow-downgrade".

Default value: undef

`dnsovertls`

Data type: Variant[Boolean,Enum['yes', 'opportunistic', 'no']]

Takes a boolean argument or one of "yes", "opportunistic" or "no". "true" corresponds to "opportunistic" and "false" (default) to "no".

Default value: false

`cache`

Data type: Variant[Boolean,Enum['no-negative']]

Takes a boolean argument or "no-negative".

Default value: false

`dns_stub_listener`

Data type: Optional[Variant[Boolean,Enum['udp','tcp']]]

Takes a boolean argument or one of "udp" and "tcp".

Default value: undef

`manage_resolv_conf`

Data type: Boolean

For when manage_resolved is true should the file /etc/resolv.conf be managed.

Default value: true

`use_stub_resolver`

Data type: Boolean

Takes a boolean argument. When "false" (default) it uses /run/systemd/resolve/resolv.conf as /etc/resolv.conf. When "true", it uses /run/systemd/resolve/stub-resolv.conf When resolved_ensure is stopped this parameter is ignored.

Default value: false

`manage_networkd`

Data type: Boolean

Manage the systemd network daemon

Default value: false

`networkd_ensure`

Data type: Enum['stopped','running']

The state that the networkd service should be in

Default value: 'running'

`manage_timesyncd`

Data type: Boolean

Manage the systemd timesyncd daemon

Default value: false

`timesyncd_ensure`

Data type: Enum['stopped','running']

The state that the timesyncd service should be in

Default value: 'running'

`timesyncd_package`

Data type: Optional[String[1]]

Name of the package required for systemd-timesyncd, if any

Default value: undef

`ntp_server`

Data type: Optional[Variant[Array,String]]

comma separated list of ntp servers, will be combined with interface specific addresses from systemd-networkd. requires puppetlabs-inifile

Default value: undef

`fallback_ntp_server`

Data type: Optional[Variant[Array,String]]

A space-separated list of NTP server host names or IP addresses to be used as the fallback NTP servers. Any per-interface NTP servers obtained from systemd-networkd take precedence over this setting. requires puppetlabs-inifile

Default value: undef

`manage_journald`

Data type: Boolean

Manage the systemd journald

Default value: true

`journald_settings`

Data type: Systemd::JournaldSettings

Config Hash that is used to configure settings in journald.conf

Default value: {}

`manage_udevd`

Data type: Boolean

Manage the systemd udev daemon

Default value: false

`udev_log`

Data type: Optional[Variant[Integer,String]]

The value of /etc/udev/udev.conf udev_log

Default value: undef

`udev_children_max`

Data type: Optional[Integer]

The value of /etc/udev/udev.conf children_max

Default value: undef

`udev_exec_delay`

Data type: Optional[Integer]

The value of /etc/udev/udev.conf exec_delay

Default value: undef

`udev_event_timeout`

Data type: Optional[Integer]

The value of /etc/udev/udev.conf event_timeout

Default value: undef

`udev_resolve_names`

Data type: Optional[Enum['early', 'late', 'never']]

The value of /etc/udev/udev.conf resolve_names

Default value: undef

`udev_timeout_signal`

Data type: Optional[Variant[Integer,String]]

The value of /etc/udev/udev.conf timeout_signal

Default value: undef

`udev_rules`

Data type: Hash

Config Hash that is used to generate instances of our udev::rule define.

Default value: {}

`machine_info_settings`

Data type: Systemd::MachineInfoSettings

Settings to place into /etc/machine-info (hostnamectl)

Default value: {}

`manage_logind`

Data type: Boolean

Manage the systemd logind

Default value: false

`logind_settings`

Data type: Systemd::LogindSettings

Config Hash that is used to configure settings in logind.conf

Default value: {}

`loginctl_users`

Data type: Hash

Config Hash that is used to generate instances of our type loginctl_user.

Default value: {}

`dropin_files`

Data type: Hash

Configure dropin files via hiera with factory pattern

Default value: {}

`manage_all_network_files`

Data type: Boolean

Default value: false

`network_path`

Data type: Stdlib::Absolutepath

where all networkd files are placed in

Default value: '/etc/systemd/network'

`manage_accounting`

Data type: Boolean

when enabled, the different accounting options (network traffic, IO, CPU util...) are enabled for units

Default value: false

`accounting`

Data type: Hash[String,String]

Hash of the different accounting options. This highly depends on the used systemd version. The module provides sane defaults per operating system using Hiera.

Default value: {}

`purge_dropin_dirs`

Data type: Boolean

When enabled, unused directories for dropin files will be purged

Default value: true

`manage_coredump`

Data type: Boolean

Should systemd-coredump configuration be managed

Default value: false

`coredump_settings`

Data type: Systemd::CoredumpSettings

Hash of systemd-coredump configurations for coredump.conf

Default value: {}

`coredump_backtrace`

Data type: Boolean

Add --backtrace to systemd-coredump call systemd-coredump@.service unit

Default value: false

`manage_oomd`

Data type: Boolean

Should systemd-oomd configuration be managed

Default value: false

`oomd_ensure`

Data type: Enum['stopped','running']

The state that the oomd service should be in

Default value: 'running'

`oomd_settings`

Data type: Systemd::OomdSettings

Hash of systemd-oomd configurations for oomd.conf

Default value: {}

`systemd::tmpfiles`

Update the systemd temp files

See also
- systemd-tmpfiles(8)

Parameters

The following parameters are available in the systemd::tmpfiles class:

operations

`operations`

Data type: Array[Enum['create','clean','remove']]

The operations to perform on the systemd tempfiles

All operations may be combined but you'll probably only ever want to use create

Default value: ['create']

Defined types

`systemd::daemon_reload`

Run systemctl daemon-reload

Parameters

The following parameters are available in the systemd::daemon_reload defined type:

name
enable

`name`

A globally unique name for the resource

`enable`

Data type: Boolean

Enable the reload exec

Added in case users want to disable the reload globally using a resource collector

Default value: true

`systemd::dropin_file`

Creates a drop-in file for a systemd unit

See also
- systemd.unit(5)

Parameters

The following parameters are available in the systemd::dropin_file defined type:

unit
filename
ensure
path
selinux_ignore_defaults
content
source
target
owner
group
mode
show_diff
notify_service
daemon_reload

`unit`

Data type: Systemd::Unit

The target unit file to create

`filename`

Data type: Systemd::Dropin

The filename of the drop in. The full path is determined using the path, unit and this filename.

Default value: $name

`ensure`

Data type: Enum['present', 'absent', 'file']

the state of this dropin file

Default value: 'present'

`path`

Data type: Stdlib::Absolutepath

The main systemd configuration path

Default value: '/etc/systemd/system'

`selinux_ignore_defaults`

Data type: Boolean

If Puppet should ignore the default SELinux labels.

Default value: false

`content`

Data type: Optional[Variant[String,Sensitive[String]]]

The full content of the unit file (Mutually exclusive with $source)

Default value: undef

`source`

Data type: Optional[String]

The File resource compatible source Mutually exclusive with $content

Default value: undef

`target`

Data type: Optional[Stdlib::Absolutepath]

If set, will force the file to be a symlink to the given target (Mutually exclusive with both $source and $content

Default value: undef

`owner`

Data type: String

The owner to set on the dropin file

Default value: 'root'

`group`

Data type: String

The group to set on the dropin file

Default value: 'root'

`mode`

Data type: String

The mode to set on the dropin file

Default value: '0444'

`show_diff`

Data type: Boolean

Whether to show the diff when updating dropin file

Default value: true

`notify_service`

Data type: Boolean

Notify a service for the unit, if it exists

Default value: true

`daemon_reload`

Data type: Boolean

Call systemd::daemon_reload

Default value: true

`systemd::manage_dropin`

Creates a drop-in file for a systemd unit from a template

See also
- systemd.unit(5)

Examples

drop in file to change Type and override ExecStart

systemd::manage_dropin { 'myconf.conf':
  ensure        => present,
  unit          => 'myservice.service',
  service_entry => {
    'Type'      => 'oneshot',
    'ExecStart' => ['', '/usr/bin/doit.sh'],
  },
}

drop in file to change a path unit and override TriggerLimitBurst

systemd::manage_dropin { 'triggerlimit.conf':
  ensure     => present,
  unit       => 'passwd.path',
  path_entry => {
    'TriggerLimitBurst' => 100,
  },
}

drop in file to override the LimitCORE for a service

systemd::manage_dropin { 'corelimit.conf':
  ensure     => present,
  unit       => 'rsyslog.conf',
  path_entry => {
    'LimitCORE' => 'infinity',
  },
}

Parameters

The following parameters are available in the systemd::manage_dropin defined type:

unit
filename
ensure
path
selinux_ignore_defaults
owner
group
mode
show_diff
notify_service
daemon_reload
unit_entry
service_entry
install_entry
timer_entry
path_entry
socket_entry

`unit`

Data type: Systemd::Unit

The unit to create a dropfile for

`filename`

Data type: Systemd::Dropin

The target unit file to create. The filename of the drop in. The full path is determined using the path, unit and this filename.

Default value: $name

`ensure`

Data type: Enum['present', 'absent']

The state of this dropin file

Default value: 'present'

`path`

Data type: Stdlib::Absolutepath

The main systemd configuration path

Default value: '/etc/systemd/system'

`selinux_ignore_defaults`

Data type: Boolean

If Puppet should ignore the default SELinux labels

Default value: false

`owner`

Data type: String

The owner to set on the dropin file

Default value: 'root'

`group`

Data type: String

The group to set on the dropin file

Default value: 'root'

`mode`

Data type: Stdlib::Filemode

The mode to set on the dropin file

Default value: '0444'

`show_diff`

Data type: Boolean

Whether to show the diff when updating dropin file

Default value: true

`notify_service`

Data type: Boolean

Notify a service for the unit, if it exists

Default value: false

`daemon_reload`

Data type: Boolean

Call systemd::daemon_reload

Default value: true

`unit_entry`

Data type: Optional[Systemd::Unit::Unit]

key value pairs for [Unit] section of the unit file

Default value: undef

`service_entry`

Data type: Optional[Systemd::Unit::Service]

key value pairs for [Service] section of the unit file

Default value: undef

`install_entry`

Data type: Optional[Systemd::Unit::Install]

key value pairs for [Install] section of the unit file

Default value: undef

`timer_entry`

Data type: Optional[Systemd::Unit::Timer]

key value pairs for [Timer] section of the unit file

Default value: undef

`path_entry`

Data type: Optional[Systemd::Unit::Path]

key value pairs for [Path] section of the unit file

Default value: undef

`socket_entry`

Data type: Optional[Systemd::Unit::Socket]

key value pairs for the [Socket] section of the unit file

Default value: undef

`systemd::manage_unit`

Generate unit file from template

See also
- systemd.unit(5)

Examples

Generate a service

systemd::manage_unit { 'myrunner.service':
  unit_entry    => {
    'Description' => 'My great service',
  },
  service_entry => {
    'Type'      => 'oneshot',
    'ExecStart' => '/usr/bin/doit.sh',
  },
  install_entry => {
    WantedBy => 'multi-user.target',
  },
}

Genenerate a path unit

systemd::manage_unit { 'passwd-mon.path':
  ensure        => present,
  unit_entry    => {
    'Description' => 'Monitor the passwd file',
  },
  path_entry    => {
    'PathModified => '/etc/passwd',
    'Unit'        => 'passwd-mon.service',
  },
  install_entry => {
    'WantedBy' => 'multi-user.target',
  },
}

Generate a socket and service (xinetd style)

systemd::manage_unit {'arcd.socket':
  ensure        => 'present',
  unit_entry    => {
    'Description' => 'arcd.service',
  }
  socket_entry  => {
    'ListenStream' => 4241,
    'Accept'       => true,
    'BindIPv6Only' => 'both',
  install_entry => {
    'WantedBy' => 'sockets.target',
  }
}

systemd::manage_unit{'arcd@.service':
  ensure        => 'present',
  enable        => true,
  active        => true,
  unit_entry    => {
    'Description'   => 'arc sever for %i',
  },

  service_entry => {
    'Type'          => 'simple',
    'ExecStart'     => /usr/sbin/arcd /usr/libexec/arcd/arcd.pl,
    'StandardInput' => 'socket',
  }

Remove a unit file

systemd::manage_unit { 'my.service':
  ensure     => 'absent',
}

Parameters

The following parameters are available in the systemd::manage_unit defined type:

name
ensure
path
owner
group
mode
show_diff
enable
active
restart
selinux_ignore_defaults
service_parameters
daemon_reload
unit_entry
service_entry
install_entry
timer_entry
path_entry
socket_entry

`name`

The target unit file to create

`ensure`

Data type: Enum['present', 'absent']

The state of the unit file to ensure

Default value: 'present'

`path`

Data type: Stdlib::Absolutepath

The main systemd configuration path

Default value: '/etc/systemd/system'

`owner`

Data type: String

The owner to set on the unit file

Default value: 'root'

`group`

Data type: String

The group to set on the unit file

Default value: 'root'

`mode`

Data type: Stdlib::Filemode

The mode to set on the unit file

Default value: '0444'

`show_diff`

Data type: Boolean

Whether to show the diff when updating unit file

Default value: true

`enable`

Data type: Optional[Variant[Boolean, Enum['mask']]]

If set, manage the unit enablement status

Default value: undef

`active`

Data type: Optional[Boolean]

If set, will manage the state of the unit

Default value: undef

`restart`

Data type: Optional[String]

Specify a restart command manually. If left unspecified, a standard Puppet service restart happens

Default value: undef

`selinux_ignore_defaults`

Data type: Boolean

maps to the same param on the file resource for the unit. false in the module because it's false in the file resource type

Default value: false

`service_parameters`

Data type: Hash[String[1], Any]

hash that will be passed with the splat operator to the service resource

Default value: {}

`daemon_reload`

Data type: Boolean

call systemd::daemon-reload to ensure that the modified unit file is loaded

Default value: true

`unit_entry`

Data type: Optional[Systemd::Unit::Unit]

key value pairs for [Unit] section of the unit file.

Default value: undef

`service_entry`

Data type: Optional[Systemd::Unit::Service]

key value pairs for [Service] section of the unit file.

Default value: undef

`install_entry`

Data type: Optional[Systemd::Unit::Install]

key value pairs for [Install] section of the unit file.

Default value: undef

`timer_entry`

Data type: Optional[Systemd::Unit::Timer]

key value pairs for [Timer] section of the unit file

Default value: undef

`path_entry`

Data type: Optional[Systemd::Unit::Path]

key value pairs for [Path] section of the unit file.

Default value: undef

`socket_entry`

Data type: Optional[Systemd::Unit::Socket]

kev value paors for [Socket] section of the unit file.

Default value: undef

`systemd::modules_load`

Creates a modules-load.d drop file

See also
- modules-load.d(5)

Examples

load a module

systemd::modules_load { 'impi.conf':
   content => "ipmi\n",
}

override /lib/modules-load.d/myservice.conf in /etc/modules-load.d/myservice.conf

systemd::modules_load { 'myservice.conf':
   content => "# Cancel system version of the file\n",
}

Parameters

The following parameters are available in the systemd::modules_load defined type:

filename
ensure
path
content
source

`filename`

Data type: Systemd::Dropin

The name of the modules-load.d file to create

Default value: $name

`ensure`

Data type: Enum['present', 'absent', 'file']

Whether to drop a file or remove it

Default value: 'file'

`path`

Data type: Stdlib::Absolutepath

The path to the main systemd modules-load.d directory

Default value: '/etc/modules-load.d'

`content`

Data type: Optional[String[1]]

The literal content to write to the file

Mutually exclusive with $source

Default value: undef

`source`

Data type: Optional[String[1]]

A File resource compatible source

Mutually exclusive with $content

Default value: undef

`systemd::network`

Creates network config for systemd-networkd

Parameters

The following parameters are available in the systemd::network defined type:

ensure
path
content
source
target
owner
group
mode
show_diff
restart_service

`ensure`

Data type: Enum['file', 'absent']

configure if the file should be configured or deleted

Default value: file

`path`

Data type: Stdlib::Absolutepath

directory where the network configs are stored

Default value: '/etc/systemd/network'

`content`

Data type: Optional[String]

the content of the file

Default value: undef

`source`

Data type: Optional[String]

a path to a file that's used as source

Default value: undef

`target`

Data type: Optional[Stdlib::Absolutepath]

optional absolute path in case the file should be stored somewhere else

Default value: undef

`owner`

Data type: String

the user who owns the file

Default value: 'root'

`group`

Data type: String

the group that owns the file

Default value: 'root'

`mode`

Data type: String

the mode of the file

Default value: '0444'

`show_diff`

Data type: Boolean

whether the file diff should be shown on modifications

Default value: true

`restart_service`

Data type: Boolean

whether systemd-networkd should be restarted on changes, defaults to true. $systemd::manage_networkd needs to be true as well

Default value: true

`systemd::service_limits`

Adds a set of custom limits to the service

See also
- systemd.exec(5)

Parameters

The following parameters are available in the systemd::service_limits defined type:

name
ensure
path
selinux_ignore_defaults
limits
source
restart_service

`name`

Data type: Pattern['^.+\.(service|socket|mount|swap)$']

The name of the service that you will be modifying

`ensure`

Data type: Enum['present', 'absent', 'file']

Whether to drop a file or remove it

Default value: 'present'

`path`

Data type: Stdlib::Absolutepath

The path to the main systemd settings directory

Default value: '/etc/systemd/system'

`selinux_ignore_defaults`

Data type: Boolean

If Puppet should ignore the default SELinux labels.

Default value: false

`limits`

Data type: Optional[Systemd::ServiceLimits]

A Hash of service limits matching the settings in systemd.exec(5)

Mutually exclusive with $source

Default value: undef

`source`

Data type: Optional[String]

A File resource compatible source

Mutually exclusive with $limits

Default value: undef

`restart_service`

Data type: Boolean

Unused parameter for compatibility with older versions. Will fail if true is passed in.

Default value: false

`systemd::timer`

Create a timer and optionally a service unit to execute with the timer unit

See also
- https://www.freedesktop.org/software/systemd/man/systemd.timer.html
  - systemd.timer(5)

Parameters

The following parameters are available in the systemd::timer defined type:

name
path
timer_content
timer_source
service_content
service_source
owner
group
mode
show_diff
service_unit
active
enable
ensure
daemon_reload

`name`

Data type: Pattern['^.+\.timer$]

The target of the timer unit to create

`path`

Data type: Stdlib::Absolutepath

The main systemd configuration path

Default value: '/etc/systemd/system'

`timer_content`

Data type: Optional[String[1]]

The full content of the timer unit file

Mutually exclusive with $timer_source

Default value: undef

`timer_source`

Data type: Optional[String[1]]

The File resource compatible source

Mutually exclusive with $timer_content

Default value: undef

`service_content`

Data type: Optional[String[1]]

The full content of the service unit file

Mutually exclusive with $service_source

Default value: undef

`service_source`

Data type: Optional[String[1]]

The File resource compatible source

Mutually exclusive with $service_content

Default value: undef

`owner`

Data type: String[1]

The owner to set on the dropin file

Default value: 'root'

`group`

Data type: String[1]

The group to set on the dropin file

Default value: 'root'

`mode`

Data type: Stdlib::Filemode

The mode to set on the dropin file

Default value: '0444'

`show_diff`

Data type: Boolean

Whether to show the diff when updating dropin file

Default value: true

`service_unit`

Data type: Optional[Systemd::Unit]

If set then the service_unit will have this name. If not set the service unit has the same name as the timer unit with s/.timer/.service/

Default value: undef

`active`

Data type: Optional[Boolean]

If set to true or false the timer service will be maintained. If true the timer service will be running and enabled, if false it will explicitly stopped and disabled.

Default value: undef

`enable`

Data type: Optional[Variant[Boolean, Enum['mask']]]

If set, will manage the state of the unit.

Default value: undef

`ensure`

Data type: Enum['present', 'absent', 'file']

Defines the desired state of the timer

Default value: 'present'

`daemon_reload`

Data type: Boolean

Call systemd::daemon_reload

Default value: true

`systemd::tmpfile`

Creates a systemd tmpfile

See also
- systemd-tmpfiles(8)

Parameters

The following parameters are available in the systemd::tmpfile defined type:

filename
ensure
path
content
source

`filename`

Data type: Systemd::Dropin

The name of the tmpfile to create

Default value: $name

`ensure`

Data type: Enum['present', 'absent', 'file']

Whether to drop a file or remove it

Default value: 'file'

`path`

Data type: Stdlib::Absolutepath

The path to the main systemd tmpfiles directory

Default value: '/etc/tmpfiles.d'

`content`

Data type: Optional[String]

The literal content to write to the file

Mutually exclusive with $source

Default value: undef

`source`

Data type: Optional[String]

A File resource compatible source

Mutually exclusive with $limits

Default value: undef

`systemd::udev::rule`

Adds a custom udev rule

See also
- udev(7)

Parameters

The following parameters are available in the systemd::udev::rule defined type:

name
ensure
path
selinux_ignore_defaults
notify_services
rules

`name`

Data type: Pattern['^.+\.rules$']

The name of the udev rules to create

`ensure`

Data type: Enum['present', 'absent', 'file']

Whether to drop a file or remove it

Default value: 'file'

`path`

Data type: Stdlib::Absolutepath

The path to the main systemd settings directory

Default value: '/etc/udev/rules.d'

`selinux_ignore_defaults`

Data type: Boolean

If Puppet should ignore the default SELinux labels.

Default value: false

`notify_services`

Data type: Variant[Array[String[1]], String[1]]

List of services to notify when this rule is updated

Default value: []

`rules`

Data type: Array

The literal udev rules you want to deploy

Default value: []

`systemd::unit_file`

Creates a systemd unit file

See also
- systemd.unit(5)

Examples

manage unit file + service

systemd::unit_file { 'foo.service':
  content => file("${module_name}/foo.service"),
  enable  => true,
  active  => true,
}

Parameters

The following parameters are available in the systemd::unit_file defined type:

name
ensure
path
content
source
target
owner
group
mode
show_diff
enable
active
restart
selinux_ignore_defaults
service_parameters
daemon_reload

`name`

The target unit file to create

`ensure`

Data type: Enum['present', 'absent', 'file']

The state of the unit file to ensure

Default value: 'present'

`path`

Data type: Stdlib::Absolutepath

The main systemd configuration path

Default value: '/etc/systemd/system'

`content`

Data type: Optional[Variant[String, Sensitive[String], Deferred]]

The full content of the unit file

Mutually exclusive with $source

Default value: undef

`source`

Data type: Optional[String]

The File resource compatible source

Mutually exclusive with $content

Default value: undef

`target`

Data type: Optional[Stdlib::Absolutepath]

If set, will force the file to be a symlink to the given target

Mutually exclusive with both $source and $content

Default value: undef

`owner`

Data type: String

The owner to set on the unit file

Default value: 'root'

`group`

Data type: String

The group to set on the unit file

Default value: 'root'

`mode`

Data type: String

The mode to set on the unit file

Default value: '0444'

`show_diff`

Data type: Boolean

Whether to show the diff when updating unit file

Default value: true

`enable`

Data type: Optional[Variant[Boolean, Enum['mask']]]

If set, will manage the unit enablement status.

Default value: undef

`active`

Data type: Optional[Boolean]

If set, will manage the state of the unit.

Default value: undef

`restart`

Data type: Optional[String]

Specify a restart command manually. If left unspecified, a standard Puppet service restart happens.

Default value: undef

`selinux_ignore_defaults`

Data type: Boolean

maps to the same param on the file resource for the unit. false in the module because it's false in the file resource type

Default value: false

`service_parameters`

Data type: Hash[String[1], Any]

hash that will be passed with the splat operator to the service resource

Default value: {}

`daemon_reload`

Data type: Boolean

call systemd::daemon-reload to ensure that the modified unit file is loaded

Default value: true

Resource types

`loginctl_user`

An arbitrary name used as the identity of the resource.

Properties

The following properties are available in the loginctl_user type.

`linger`

Valid values: enabled, disabled

Whether linger is enabled for the user.

Default value: disabled

Parameters

The following parameters are available in the loginctl_user type.

name
provider

`name`

namevar

An arbitrary name used as the identity of the resource.

`provider`

The specific backend to use for this loginctl_user resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

Functions

`systemd::escape`

Type: Puppet Language

Escape strings as systemd-escape does.

Examples

Escaping a string

$result = systemd::escape('foo::bar')

Escaping a path

$result = systemd::escape('/mnt/foobar',true)

`systemd::escape(String[1] $input, Boolean $path = false)`

The systemd::escape function.

Returns: String String

Examples

Escaping a string

$result = systemd::escape('foo::bar')

Escaping a path

$result = systemd::escape('/mnt/foobar',true)

`input`

Data type: String[1]

Input string

`path`

Data type: Boolean

Use path (-p) ornon-path style escaping.

`systemd::systemd_escape`

Type: Ruby 4.x API

Escape strings by call the systemd-escape command in the background.

`systemd::systemd_escape(String $input, Optional[Optional[Boolean]] $path)`

The systemd::systemd_escape function.

Returns: String

`input`

Data type: String

Input string

`path`

Data type: Optional[Optional[Boolean]]

Use path (-p) ornon-path style escaping.

Data types

`Systemd::CoredumpSettings`

Configurations for coredump.conf

See also
- https://www.freedesktop.org/software/systemd/man/coredump.conf.html

Alias of

Struct[{
    Optional['Storage']         => Enum['none', 'external', 'journal'],
    Optional['Compress']        => Enum['yes','no'],
    Optional['ProcessSizeMax']  => Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],
    Optional['ExternalSizeMax'] => Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],
    Optional['JournalSizeMax']  => Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],
    Optional['MaxUse']          => Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],
    Optional['MaxFree']         => Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],
  }]

`Systemd::Dropin`

custom datatype that validates filenames/paths for valid systemd dropin files

Alias of Pattern['^[^/]+\.conf$']

`Systemd::JournaldSettings`

Matches Systemd journald config Struct

Alias of

Struct[{
    Optional['Storage']              => Variant[Enum['volatile','persistent','auto','none'],Systemd::JournaldSettings::Ensure],
    Optional['Compress']             => Variant[Enum['yes','no'], Pattern[/^[0-9]+(K|M|G)?$/],Systemd::JournaldSettings::Ensure],
    Optional['Seal']                 => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure],
    Optional['SplitMode']            => Variant[Enum['uid','none'],Systemd::JournaldSettings::Ensure],
    Optional['RateLimitInterval']    => Variant[Pattern[/^[0-9]+(s|min|h|ms|us)?$/],Systemd::JournaldSettings::Ensure],
    Optional['RateLimitIntervalSec'] => Variant[Pattern[/^[0-9]+(s|min|h|ms|us)?$/],Systemd::JournaldSettings::Ensure],
    Optional['RateLimitBurst']       => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure],
    Optional['SystemMaxUse']         => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure],
    Optional['SystemKeepFree']       => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure],
    Optional['SystemMaxFileSize']    => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure],
    Optional['SystemMaxFiles']       => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure],
    Optional['RuntimeMaxUse']        => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure],
    Optional['RuntimeKeepFree']      => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure],
    Optional['RuntimeMaxFileSize']   => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure],
    Optional['RuntimeMaxFiles']      => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure],
    Optional['MaxFileSec']           => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure],
    Optional['MaxRetentionSec']      => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure],
    Optional['SyncIntervalSec']      => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure],
    Optional['ForwardToSyslog']      => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure],
    Optional['ForwardToKMsg']        => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure],
    Optional['ForwardToConsole']     => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure],
    Optional['ForwardToWall']        => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure],
    Optional['MaxLevelStore']        => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure],
    Optional['MaxLevelSyslog']       => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure],
    Optional['MaxLevelKMsg']         => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure],
    Optional['MaxLevelConsole']      => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure],
    Optional['MaxLevelWall']         => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure],
    Optional['ReadKMsg']             => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure],
    Optional['TTYPath']              => Variant[Stdlib::Absolutepath,Systemd::JournaldSettings::Ensure],
    Optional['LineMax']              => Variant[Pattern[/^[0-9]+(K|M|G|T)?$/],Systemd::JournaldSettings::Ensure],
  }]

`Systemd::JournaldSettings::Ensure`

defines allowed ensure states for systemd-journald settings

Alias of Struct[{ 'ensure' => Enum['present','absent'] }]

`Systemd::LogindSettings`

Matches Systemd Login Manager Struct

Alias of

Struct[{
    Optional['HandleHibernateKey']           => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['HandleLidSwitch']              => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['HandleLidSwitchDocked']        => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['HandleLidSwitchExternalPower'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['HandlePowerKey']               => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['HandleSuspendKey']             => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['HibernateKeyIgnoreInhibited']  => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure],
    Optional['HoldoffTimeoutSec']            => Variant[Integer,Systemd::LogindSettings::Ensure],
    Optional['IdleAction']                   => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure],
    Optional['IdleActionSec']                => Variant[Integer,Systemd::LogindSettings::Ensure],
    Optional['InhibitDelayMaxSec']           => Variant[Integer,Systemd::LogindSettings::Ensure],
    Optional['InhibitorsMax']                => Variant[Integer,Systemd::LogindSettings::Ensure],
    Optional['KillExcludeUsers']             => Variant[Array[String],Systemd::LogindSettings::Ensure],
    Optional['KillOnlyUsers']                => Variant[Array[String],Systemd::LogindSettings::Ensure],
    Optional['KillUserProcesses']            => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure],
    Optional['LidSwitchIgnoreInhibited']     => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure],
    Optional['NAutoVTs']                     => Variant[Integer,Systemd::LogindSettings::Ensure],
    Optional['PowerKeyIgnoreInhibited']      => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure],
    Optional['RemoveIPC']                    => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure],
    Optional['ReserveVT']                    => Variant[Integer,Systemd::LogindSettings::Ensure],
    Optional['RuntimeDirectorySize']         => Variant[Integer,Pattern['^(\d+(K|M|G|T|P|E|%)?)$'],Systemd::LogindSettings::Ensure],
    Optional['SessionsMax']                  => Variant[Integer,Pattern['^(infinity|(\d+(K|M|G|T|P|E|%)?))$'],Systemd::LogindSettings::Ensure],
    Optional['SuspendKeyIgnoreInhibited']    => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure],
    Optional['UserTasksMax']                 => Variant[Integer,Pattern['^(infinity|(\d+(K|M|G|T|P|E|%)?))$'],Systemd::LogindSettings::Ensure]
  }]

`Systemd::LogindSettings::Ensure`

defines allowed ensure states for systemd-logind settings

Alias of Struct[{ 'ensure' => Enum['present','absent'] }]

`Systemd::MachineInfoSettings`

Matches Systemd machine-info (hostnamectl) file Struct

Alias of

Struct[{
    Optional['PRETTY_HOSTNAME'] => String[1],
    Optional['ICON_NAME']       => String[1],
    Optional['CHASSIS']         => String[1],
    Optional['DEPLOYMENT']      => String[1],
    Optional['LOCATION']        => String[1],
    Optional['HARDWARE_VENDOR'] => String[1],
    Optional['HARDWARE_MODEL']  => String[1],
  }]

`Systemd::OomdSettings`

Configurations for oomd.conf

See also
- https://www.freedesktop.org/software/systemd/man/oomd.conf.html

Alias of

Struct[{
    Optional['SwapUsedLimit']                    => Pattern[/^[0-9]+[%|‰|‱]$/],
    Optional['DefaultMemoryPressureLimit']       => Pattern[/^[0-9]+%$/],
    Optional['DefaultMemoryPressureDurationSec'] => Integer[0],
  }]

`Systemd::ServiceLimits`

Matches Systemd Service Limit Struct

Alias of

Struct[{
    Optional['LimitCPU']            => Pattern['^\d+(s|m|h|d|w|M|y)?(:\d+(s|m|h|d|w|M|y)?)?$'],
    Optional['LimitFSIZE']          => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitDATA']           => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitSTACK']          => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitCORE']           => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitRSS']            => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitNOFILE']         => Variant[Integer[-1],Pattern['^(infinity|\d+(:(infinity|\d+))?)$']],
    Optional['LimitAS']             => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitNPROC']          => Variant[Integer[-1],Pattern['^(infinity|\d+(:(infinity|\d+))?)$']],
    Optional['LimitMEMLOCK']        => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitLOCKS']          => Integer[1],
    Optional['LimitSIGPENDING']     => Integer[1],
    Optional['LimitMSGQUEUE']       => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['LimitNICE']           => Variant[Integer[0,40], Pattern['^(-\+([0-1]?[0-9]|20))|([0-3]?[0-9]|40)$']],
    Optional['LimitRTPRIO']         => Integer[0],
    Optional['LimitRTTIME']         => Pattern['^\d+(ms|s|m|h|d|w|M|y)?(:\d+(ms|s|m|h|d|w|M|y)?)?$'],
    Optional['CPUAccounting']       => Boolean,
    Optional['CPUShares']           => Integer[2,262144],
    Optional['StartupCPUShares']    => Integer[2,262144],
    Optional['CPUQuota']            => Pattern['^([1-9][0-9]*)%$'],
    Optional['MemoryAccounting']    => Boolean,
    Optional['MemoryLow']           => Pattern['\A(infinity|\d+(K|M|G|T|%)?(:\d+(K|M|G|T|%)?)?)\z'],
    Optional['MemoryMin']           => Pattern['\A(infinity|\d+(K|M|G|T|%)?(:\d+(K|M|G|T|%)?)?)\z'],
    Optional['MemoryHigh']          => Pattern['\A(infinity|\d+(K|M|G|T|%)?(:\d+(K|M|G|T|%)?)?)\z'],
    Optional['MemoryMax']           => Pattern['\A(infinity|\d+(K|M|G|T|%)?(:\d+(K|M|G|T|%)?)?)\z'],
    Optional['MemoryLimit']         => Pattern['\A(infinity|\d+(K|M|G|T|%)?(:\d+(K|M|G|T|%)?)?)\z'],
    Optional['MemorySwapMax']       => Pattern['\A(infinity|\d+(K|M|G|T|%)?(:\d+(K|M|G|T|%)?)?)\z'],
    Optional['TasksAccounting']     => Boolean,
    Optional['TasksMax']            => Variant[Integer[1],Pattern['^(infinity|([1-9][0-9]?$|^100)%)$']],
    Optional['IOAccounting']        => Boolean,
    Optional['IOWeight']            => Integer[1,10000],
    Optional['StartupIOWeight']     => Integer[1,10000],
    Optional['IODeviceWeight']      => Array[Hash[Stdlib::Absolutepath, Integer[1,10000], 1, 1]],
    Optional['IOReadBandwidthMax']  => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]],
    Optional['IOWriteBandwidthMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]],
    Optional['IOReadIOPSMax']       => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]],
    Optional['IOWriteIOPSMax']      => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]],
    Optional['DeviceAllow']         => String[1],
    Optional['DevicePolicy']        => Enum['auto','closed','strict'],
    Optional['Slice']               => String[1],
    Optional['Delegate']            => Boolean,
    Optional['OOMScoreAdjust']      => Integer[-1000,1000]
  }]

`Systemd::Unit`

custom datatype that validates different filenames for systemd units and unit templates

See also
- https://www.freedesktop.org/software/systemd/man/systemd.unit.html

`Systemd::Unit::Install`

Possible keys for the [Install] section of a unit file

See also
- https://www.freedesktop.org/software/systemd/man/systemd.unit.html

Alias of

Struct[{
    Optional['Alias']      => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['WantedBy']   => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['RequiredBy'] => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['Also']       => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
  }]

`Systemd::Unit::Path`

Possible keys for the [Path] section of a unit file

See also
- https://www.freedesktop.org/software/systemd/man/systemd.path.html

Alias of

Struct[{
    Optional['PathExists']              => Variant[Enum[''],Stdlib::Unixpath,Array[Variant[Enum[''],Stdlib::Unixpath],1]],
    Optional['PathExistsGlob']          => Variant[Enum[''],Stdlib::Unixpath,Array[Variant[Enum[''],Stdlib::Unixpath],1]],
    Optional['PathChanged']             => Variant[Enum[''],Stdlib::Unixpath,Array[Variant[Enum[''],Stdlib::Unixpath],1]],
    Optional['PathModified']            => Variant[Enum[''],Stdlib::Unixpath,Array[Variant[Enum[''],Stdlib::Unixpath],1]],
    Optional['DirectoryNotEmpty']       => Variant[Enum[''],Stdlib::Unixpath,Array[Variant[Enum[''],Stdlib::Unixpath],1]],
    Optional['Unit']                    => Systemd::Unit,
    Optional['MakeDirectory']           => Boolean,
    Optional['DirectoryMode']           => Pattern[/\A[0-7]{1,4}\z/],
    Optional['TriggerLimitIntervalSec'] => String,
    Optional['TriggerLimitBurst']       => Integer[0],
  }]

`Systemd::Unit::Service`

Possible keys for the [Service] section of a unit file

See also
- https://www.freedesktop.org/software/systemd/man/systemd.service.html
- https://www.freedesktop.org/software/systemd/man/systemd.exec.html

Alias of

Struct[{
    Optional['AmbientCapabilities']       => Variant[Pattern[/^CAP_[A-Z_]+$/],Array[Pattern[/^CAP_[A-Z_]+$/],1]],
    Optional['User']                      => String[1],
    Optional['Group']                     => String[1],
    Optional['Type']                      => Enum['simple', 'exec', 'forking', 'oneshot', 'dbus', 'notify', 'idle'],
    Optional['ExitType']                  => Enum['main', 'cgroup'],
    Optional['RemainAfterExit']           => Boolean,
    Optional['GuessMainPID']              => Boolean,
    Optional['PIDFile']                   => Stdlib::Unixpath,
    Optional['BusName']                   => String[1],
    Optional['ExecStart']                 => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStartPre']              => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStartPost']             => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecCondition']             => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecReload']                => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStop']                  => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStopPost']              => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['KillSignal']                => Pattern[/^SIG[A-Z]+$/],
    Optional['KillMode']                  => Enum['control-group', 'mixed', 'process', 'none'],
    Optional['SyslogIdentifier']          => String,
    Optional['LimitCORE']                 => Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'],
    Optional['RestartSec']                => String,
    Optional['TimeoutStartSec']           => String,
    Optional['TimeoutStopSec']            => String,
    Optional['TimeoutAbortSec']           => String,
    Optional['TimeoutAbortSec']           => String,
    Optional['TimeoutSec']                => String,
    Optional['TimeoutStartFailureMode']   => Enum['terminate', 'abort', 'kill'],
    Optional['TimeoutStopFailureMode']    => Enum['terminate', 'abort', 'kill'],
    Optional['RuntimeMaxSec']             => String,
    Optional['RuntimeRandomizedExtraSec'] => String,
    Optional['WatchdogSec']               => String,
    Optional['Restart']                   => Enum['no', 'on-success', 'on-failure', 'on-abnormal', 'on-watchdog', 'on-abort', 'always'],
    Optional['SuccessExitStatus']         => String,
    Optional['RestartPreventExitStatus']  => String,
    Optional['RestartForceExitStatus']    => String,
    Optional['RootDirectoryStartOnly']    => Boolean,
    Optional['NonBlocking']               => Boolean,
    Optional['NotifyAccess']              => Enum['none', 'default', 'main', 'exec',  'all'],
    Optional['OOMPolicy']                 => Enum['continue', 'stop','kill'],
    Optional['OOMScoreAdjust']            => Integer[-1000,1000],
    Optional['Environment']               => String,
    Optional['EnvironmentFile']           => Variant[
      Stdlib::Unixpath,Pattern[/-\/.+/],
      Array[Variant[Stdlib::Unixpath,Pattern[/-\/.+/]],1],
    ],
  }]

`Systemd::Unit::Service::Exec`

Possible strings for ExecStart, ExecStartPrep, ...

See also
- https://www.freedesktop.org/software/systemd/man/systemd.service.html
- https://www.freedesktop.org/software/systemd/man/systemd.exec.html

Alias of Variant[Enum[''], Pattern[/^[@\-:]*(\+|!|!!)?[@\-:]*\/.*/], Pattern[/^[@\-:]*(\+|!|!!)?[@\-:]*[^\/]*(\s.*)?$/]]

`Systemd::Unit::Socket`

Possible keys for the [Socket] section of a unit file

See also
- https://www.freedesktop.org/software/systemd/man/systemd.socket.html

Alias of

Struct[{
    Optional['ListenStream']            => Variant[Stdlib::Port,String[1]],
    Optional['ListenDatagram']          => Variant[Stdlib::Port,String[1]],
    Optional['ListenSequentialPacket']  => Variant[Stdlib::Port,String[1]],
    Optional['ListenFIFO']              => Stdlib::Unixpath,
    Optional['ListenSpecial']           => Stdlib::Unixpath,
    Optional['ListenNetlink']           => String[1],
    Optional['ListenMessageQueue']      => Pattern[/\A\/.*\z/],
    Optional['ListenUSBFunction']       => Stdlib::Unixpath,
    Optional['SocketProtocol']          => Enum['udplite', 'sctp'],
    Optional['BindIPv6Only']            => Enum['default', 'both', 'ipv6-only'],
    Optional['Backlog']                 => Integer[0],
    Optional['BindToDevice']            => String[1],
    Optional['SocketUser']              => String[1],
    Optional['SocketGroup']             => String[1],
    Optional['SocketMode']              => Stdlib::Filemode,
    Optional['DirectoryMode']           => Stdlib::Filemode,
    Optional['Accept']                  => Boolean,
    Optional['Writable']                => Boolean,
    Optional['FlushPending']            => Boolean,
    Optional['MaxConnections']          => Integer[0],
    Optional['MaxConnectionsPerSource'] => Integer[0],
    Optional['KeepAlive']               => Boolean,
    Optional['KeepAliveTimeSec']        => Integer[0],
    Optional['KeepAliveIntervalSec']    => Integer[0],
    Optional['KeepAliveProbes']         => Integer[0],
    Optional['NoDelay']                 => Boolean,
    Optional['Priority']                => Integer,
    Optional['DeferAcceptSec']          => Integer[0],
    Optional['ReceiveBuffer']           => Variant[Integer[0],String[1]],
    Optional['SendBuffer']              => Variant[Integer[0],String[1]],
    Optional['IPTOS']                   => Variant[Integer,Enum['low-delay', 'throughput', 'reliability', 'low-cost']],
    Optional['IPTTL']                   => Integer[0],
    Optional['Mark']                    => String[1],
    Optional['ReusePort']               => Boolean,
    Optional['SmackLabel']              => String[1],
    Optional['SmackLabelIPIn']          => String[1],
    Optional['SmackLabelIPOut']         => String[1],
    Optional['SELinuxContextFromNet']   => Boolean,
    Optional['PipeSize']                => Variant[Integer[0],String[1]],
    Optional['FreeBind']                => Boolean,
    Optional['Transparent']             => Boolean,
    Optional['Broadcast']               => Boolean,
    Optional['PassCredentials']         => Boolean,
    Optional['PassSecurity']            => Boolean,
    Optional['PassPacketInfo']          => Boolean,
    Optional['Timestamping']            => Enum['off', 'us', 'usec', 'ns'],
    Optional['TCPCongestion']           => Enum['westwood', 'veno', 'cubic', 'lp'],
    Optional['ExecStartPre']            => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStartPost']           => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStopPre']             => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['ExecStopPost']            => Variant[Systemd::Unit::Service::Exec,Array[Systemd::Unit::Service::Exec,1]],
    Optional['TimeoutSec']              => String[1],
    Optional['Service']                 => Systemd::Unit,
    Optional['RemoveOnStop']            => Boolean,
    Optional['Symlinks']                => Variant[Stdlib::Unixpath,Array[Stdlib::Unixpath,1]],
    Optional['FileDescriptorName']      => String[1,255],
    Optional['TriggerLimitIntervalSec'] => String[1],
    Optional['TriggerLimitBurst']       => Integer[0],
  }]

`Systemd::Unit::Timer`

Possible keys for the [Timer] section of a unit file

See also
- https://www.freedesktop.org/software/systemd/man/systemd.timer.html

Alias of

Struct[{
    Optional['OnActiveSec']        => Variant[Integer[0],String,Array[Variant[Integer[0],String]]],
    Optional['OnBootSec']          => Variant[Integer[0],String,Array[Variant[Integer[0],String]]],
    Optional['OnStartUpSec']       => Variant[Integer[0],String,Array[Variant[Integer[0],String]]],
    Optional['OnUnitActiveSec']    => Variant[Integer[0],String,Array[Variant[Integer[0],String]]],
    Optional['OnUnitInactiveSec']  => Variant[Integer[0],String,Array[Variant[Integer[0],String]]],
    Optional['OnCalendar']         => Variant[Integer[0],String,Array[Variant[Integer[0],String]]],
    Optional['AccuracySec']        => Variant[Integer[0],String],
    Optional['RandomizedDelaySec'] => Variant[Integer[0],String],
    Optional['FixedRandomDelay']   => Boolean,
    Optional['OnClockChange']      => Boolean,
    Optional['OnTimezoneChange']   => Boolean,
    Optional['Unit']               => Systemd::Unit,
    Optional['Persistent']         => Boolean,
    Optional['WakeSystem']         => Boolean,
    Optional['RemainAfterElapse']  => Boolean,
  }]

`Systemd::Unit::Unit`

Possible keys for the [Unit] section of a unit file

See also
- https://www.freedesktop.org/software/systemd/man/systemd.unit.html

Alias of

Struct[{
    Optional['Description']              => Variant[String,Array[String,1]],
    Optional['Documentation']            => Variant[String,Array[String,1]],
    Optional['DefaultDependencies']      => Boolean,
    Optional['Wants']                    => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['Requires']                 => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['Requisite']                => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['PartOf']                   => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['Upholds']                  => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['Conflicts']                => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['Before']                   => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['After']                    => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['OnFailure']                => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    Optional['OnSuccess']                => Variant[Enum[''],Systemd::Unit,Array[Variant[Enum[''],Systemd::Unit],1]],
    # Conditions and Asserts
    Optional['ConditionPathExists']      => Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/],Array[Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/]],1]],
    Optional['ConditionPathIsDirectory'] => Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/],Array[Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/]],1]],
    Optional['AssertPathExists']         => Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/],Array[Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/]],1]],
    Optional['AssertPathIsDirectory']    => Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/],Array[Variant[Enum[''],Stdlib::Unixpath,Pattern[/^!.*$/]],1]],
  }]

Files

REFERENCE.md

Latest commit

History

REFERENCE.md

File metadata and controls

Reference

Table of Contents

Classes

Public Classes

Private Classes

Defined types

Resource types

Functions

Data types

Classes

systemd

Parameters

default_target

service_limits

networks

timers

tmpfiles

unit_files

manage_resolved

resolved_ensure

resolved_package

dns

fallback_dns

domains

llmnr

multicast_dns

dnssec

dnsovertls

cache

dns_stub_listener

manage_resolv_conf

use_stub_resolver

manage_networkd

networkd_ensure

manage_timesyncd

timesyncd_ensure

timesyncd_package

ntp_server

fallback_ntp_server

manage_journald

journald_settings

manage_udevd

udev_log

udev_children_max

udev_exec_delay

udev_event_timeout

udev_resolve_names

udev_timeout_signal

udev_rules

machine_info_settings

manage_logind

logind_settings

loginctl_users

dropin_files

manage_all_network_files

network_path

manage_accounting

accounting

purge_dropin_dirs

manage_coredump

coredump_settings

coredump_backtrace

manage_oomd

oomd_ensure

oomd_settings

systemd::tmpfiles

Parameters

operations

Defined types

systemd::daemon_reload

Parameters

name

enable

systemd::dropin_file

`systemd`

`default_target`

`service_limits`

`networks`

`timers`

`tmpfiles`

`unit_files`

`manage_resolved`

`resolved_ensure`

`resolved_package`

`dns`

`fallback_dns`

`domains`

`llmnr`

`multicast_dns`

`dnssec`

`dnsovertls`

`cache`

`dns_stub_listener`

`manage_resolv_conf`

`use_stub_resolver`

`manage_networkd`

`networkd_ensure`

`manage_timesyncd`

`timesyncd_ensure`

`timesyncd_package`

`ntp_server`

`fallback_ntp_server`

`manage_journald`

`journald_settings`

`manage_udevd`

`udev_log`

`udev_children_max`

`udev_exec_delay`

`udev_event_timeout`

`udev_resolve_names`

`udev_timeout_signal`

`udev_rules`

`machine_info_settings`

`manage_logind`

`logind_settings`

`loginctl_users`

`dropin_files`

`manage_all_network_files`

`network_path`

`manage_accounting`

`accounting`

`purge_dropin_dirs`

`manage_coredump`

`coredump_settings`

`coredump_backtrace`

`manage_oomd`

`oomd_ensure`

`oomd_settings`

`systemd::tmpfiles`

`operations`

`systemd::daemon_reload`

`name`

`enable`

`systemd::dropin_file`

`unit`

`filename`

`ensure`

`path`

`selinux_ignore_defaults`

`content`

`source`

`target`

`owner`

`group`

`mode`

`show_diff`

`notify_service`

`daemon_reload`

`systemd::manage_dropin`

`unit`

`filename`

`ensure`

`path`

`selinux_ignore_defaults`