Skip to content

Commit

Permalink
Update REFERENCE
Browse files Browse the repository at this point in the history
  • Loading branch information
jay7x committed Oct 28, 2024
1 parent 07b5ab8 commit 18afc68
Showing 1 changed file with 42 additions and 19 deletions.
61 changes: 42 additions & 19 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@

### Data types

* [`Systemd::Boolean`](#Systemd--Boolean): Defines systemd boolean type representation
* [`Systemd::Boolean::False`](#Systemd--Boolean--False): Defines systemd boolean "false" type representation
* [`Systemd::Boolean::True`](#Systemd--Boolean--True): Defines systemd boolean "true" type representation
* [`Systemd::Capabilities`](#Systemd--Capabilities): Defines allowed capabilities
* [`Systemd::CoredumpSettings`](#Systemd--CoredumpSettings): Configurations for coredump.conf
* [`Systemd::Dropin`](#Systemd--Dropin): custom datatype that validates filenames/paths for valid systemd dropin files
Expand Down Expand Up @@ -630,7 +633,9 @@ Default value: `false`

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.
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: `{}`

Expand Down Expand Up @@ -712,7 +717,7 @@ Data type: `Boolean`

Should system service manager configurations be managed

Default value: `true`
Default value: `false`

##### <a name="-systemd--system_settings"></a>`system_settings`

Expand All @@ -730,7 +735,7 @@ Data type: `Boolean`

Should user service manager configurations be managed

Default value: `true`
Default value: `false`

##### <a name="-systemd--user_settings"></a>`user_settings`

Expand Down Expand Up @@ -2633,6 +2638,24 @@ Use path (-p) ornon-path style escaping.

## Data types

### <a name="Systemd--Boolean"></a>`Systemd::Boolean`

Defines systemd boolean type representation

Alias of `Variant[Systemd::Boolean::True, Systemd::Boolean::False]`

### <a name="Systemd--Boolean--False"></a>`Systemd::Boolean::False`

Defines systemd boolean "false" type representation

Alias of `Variant[Integer[0,0], Enum['no', 'false'], Boolean[false]]`

### <a name="Systemd--Boolean--True"></a>`Systemd::Boolean::True`

Defines systemd boolean "true" type representation

Alias of `Variant[Integer[1], Enum['yes', 'true'], Boolean[true]]`

### <a name="Systemd--Capabilities"></a>`Systemd::Capabilities`

Defines allowed capabilities
Expand Down Expand Up @@ -2868,14 +2891,14 @@ Alias of
Struct[{
Optional['LogLevel'] => Variant[Systemd::LogLevel, Systemd::SettingEnsure],
Optional['LogTarget'] => Variant[Enum['console','console-prefixed','kmsg','journal','journal-or-kmsg','auto','null'], Systemd::SettingEnsure],
Optional['LogColor'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['LogLocation'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['LogTime'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['DumpCore'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['ShowStatus'] => Variant[Boolean, Enum['auto','error'], Systemd::SettingEnsure],
Optional['CrashChangeVT'] => Variant[Boolean, Integer[1,63], Systemd::SettingEnsure],
Optional['CrashShell'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['CrashReboot'] => Variant[Boolean, Systemd::SettingEnsure], # Obsoleted by CrashAction in v256, delete after Debian 12 EOL
Optional['LogColor'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['LogLocation'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['LogTime'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['DumpCore'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['ShowStatus'] => Variant[Systemd::Boolean, Enum['auto','error'], Systemd::SettingEnsure],
Optional['CrashChangeVT'] => Variant[Systemd::Boolean, Integer[1,63], Systemd::SettingEnsure],
Optional['CrashShell'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['CrashReboot'] => Variant[Systemd::Boolean, Systemd::SettingEnsure], # Obsoleted by CrashAction in v256, delete after Debian 12 EOL
Optional['CrashAction'] => Variant[Enum['freeze', 'reboot', 'poweroff'], Systemd::SettingEnsure],
Optional['CtrlAltDelBurstAction'] => Variant[Enum['reboot-force','poweroff-force','reboot-immediate','poweroff-immediate','none'], Systemd::SettingEnsure],
Optional['CPUAffinity'] => Variant[Enum['numa'], Pattern['^[0-9, -]+$'], Systemd::SettingEnsure],
Expand All @@ -2888,8 +2911,8 @@ Struct[{
Optional['KExecWatchdogSec'] => Variant[Enum['off','default'], Systemd::Timespan, Systemd::SettingEnsure],
Optional['WatchdogDevice'] => Variant[Stdlib::Absolutepath, Systemd::SettingEnsure],
Optional['CapabilityBoundingSet'] => Variant[Systemd::Capabilities, Systemd::SettingEnsure],
Optional['NoNewPrivileges'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['ProtectSystem'] => Variant[Enum['auto'], Boolean, Systemd::SettingEnsure],
Optional['NoNewPrivileges'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['ProtectSystem'] => Variant[Enum['auto'], Systemd::Boolean, Systemd::SettingEnsure],
Optional['SystemCallArchitectures'] => Variant[String[1], Systemd::SettingEnsure],
Optional['TimerSlackNSec'] => Variant[Systemd::Timespan, Systemd::SettingEnsure],
Optional['StatusUnitFormat'] => Variant[Enum['combined','description','name'], Systemd::SettingEnsure],
Expand All @@ -2905,12 +2928,12 @@ Struct[{
Optional['DefaultStartLimitBurst'] => Variant[Integer[0], Systemd::SettingEnsure],
Optional['DefaultEnvironment'] => Variant[String, Systemd::SettingEnsure],
Optional['ManagerEnvironment'] => Variant[String, Systemd::SettingEnsure],
Optional['DefaultCPUAccounting'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['DefaultBlockIOAccounting'] => Variant[Boolean, Systemd::SettingEnsure], # Deprecated in v252. Delete after Debian 11 EOL
Optional['DefaultIOAccounting'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['DefaultIPAccounting'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['DefaultMemoryAccounting'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['DefaultTasksAccounting'] => Variant[Boolean, Systemd::SettingEnsure],
Optional['DefaultCPUAccounting'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['DefaultBlockIOAccounting'] => Variant[Systemd::Boolean, Systemd::SettingEnsure], # Deprecated in v252. Delete after Debian 11 EOL
Optional['DefaultIOAccounting'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['DefaultIPAccounting'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['DefaultMemoryAccounting'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['DefaultTasksAccounting'] => Variant[Systemd::Boolean, Systemd::SettingEnsure],
Optional['DefaultTasksMax'] => Variant[Enum[infinity], Integer[0], Systemd::Unit::Percent, Systemd::SettingEnsure],
Optional['DefaultLimitCPU'] => Variant[Pattern['^\d+(s|m|h|d|w|M|y)?(:\d+(s|m|h|d|w|M|y)?)?$'], Systemd::SettingEnsure],
Optional['DefaultLimitFSIZE'] => Variant[Pattern['^(infinity|((\d+(K|M|G|T|P|E)?(:\d+(K|M|G|T|P|E)?)?)))$'], Systemd::SettingEnsure],
Expand Down

0 comments on commit 18afc68

Please sign in to comment.