Documentation

systemd – Manage services

New in version 2.2.

Synopsis

  • Controls systemd services on remote hosts.

Requirements

The below requirements are needed on the host that executes this module.

  • A system managed by systemd.

Parameters

Parameter Choices/Defaults Comments
daemon_reexec
boolean
added in 2.8
    Choices:
  • no ←
  • yes
Run daemon_reexec command before doing any other operations, the systemd manager will serialize the manager state.

aliases: daemon-reexec
daemon_reload
boolean
    Choices:
  • no ←
  • yes
Run daemon-reload before doing any other operations, to make sure systemd has read any changes.
When set to yes, runs daemon-reload even if the module does not start or stop anything.

aliases: daemon-reload
enabled
boolean
    Choices:
  • no
  • yes
Whether the service should start on boot. At least one of state and enabled are required.
force
boolean
added in 2.6
    Choices:
  • no
  • yes
Whether to override existing symlinks.
masked
boolean
    Choices:
  • no
  • yes
Whether the unit should be masked or not, a masked unit is impossible to start.
name
-
Name of the service. When using in a chroot environment you always need to specify the full name i.e. (crond.service).

aliases: service, unit
no_block
boolean
added in 2.3
    Choices:
  • no ←
  • yes
Do not synchronously wait for the requested operation to finish. Enqueued job will continue without Ansible blocking on its completion.
scope
-
added in 2.7
    Choices:
  • system
  • user
  • global
run systemctl within a given service manager scope, either as the default system scope (system), the current user's scope (user), or the scope of all users (global).
For systemd to work with 'user', the executing user must have its own instance of dbus started (systemd requirement). The user dbus process is normally started during normal login, but not during the run of Ansible tasks. Otherwise you will probably get a 'Failed to connect to bus: no such file or directory' error.
state
-
    Choices:
  • reloaded
  • restarted
  • started
  • stopped
started/stopped are idempotent actions that will not run commands unless necessary. restarted will always bounce the service. reloaded will always reload.
user
boolean
    Choices:
  • no ←
  • yes
(deprecated) run ``systemctl`` talking to the service manager of the calling user, rather than the service manager of the system.
This option is deprecated and will eventually be removed in 2.11. The ``scope`` option should be used instead.

Notes

Note

  • Since 2.4, one of the following options is required ‘state’, ‘enabled’, ‘masked’, ‘daemon_reload’, (‘daemon_reexec’ since 2.8), and all except ‘daemon_reload’ (and ‘daemon_reexec’ since 2.8) also require ‘name’.
  • Before 2.4 you always required ‘name’.

Examples

- name: Make sure a service is running
  systemd:
    state: started
    name: httpd

- name: stop service cron on debian, if running
  systemd:
    name: cron
    state: stopped

- name: restart service cron on centos, in all cases, also issue daemon-reload to pick up config changes
  systemd:
    state: restarted
    daemon_reload: yes
    name: crond

- name: reload service httpd, in all cases
  systemd:
    name: httpd
    state: reloaded

- name: enable service httpd and ensure it is not masked
  systemd:
    name: httpd
    enabled: yes
    masked: no

- name: enable a timer for dnf-automatic
  systemd:
    name: dnf-automatic.timer
    state: started
    enabled: yes

- name: just force systemd to reread configs (2.4 and above)
  systemd:
    daemon_reload: yes

- name: just force systemd to re-execute itself (2.8 and above)
  systemd:
    daemon_reexec: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
status
complex
success
A dictionary with the key=value pairs returned from `systemctl show`

  ActiveEnterTimestamp
-

  ActiveEnterTimestampMonotonic
-

  ActiveExitTimestampMonotonic
-

  ActiveState
-

  After
-

  AllowIsolate
-

  Before
-

  BlockIOAccounting
-

  BlockIOWeight
-

  CanIsolate
-

  CanReload
-

  CanStart
-

  CanStop
-

  CapabilityBoundingSet
-

  ConditionResult
-

  ConditionTimestamp
-

  ConditionTimestampMonotonic
-

  Conflicts
-

  ControlGroup
-

  ControlPID
-

  CPUAccounting
-

  CPUSchedulingPolicy
-

  CPUSchedulingPriority
-

  CPUSchedulingResetOnFork
-

  CPUShares
-

  DefaultDependencies
-

  Delegate
-

  Description
-

  DevicePolicy
-

  EnvironmentFile
-

  ExecMainCode
-

  ExecMainExitTimestampMonotonic
-

  ExecMainPID
-

  ExecMainStartTimestamp
-

  ExecMainStartTimestampMonotonic
-

  ExecMainStatus
-

  ExecReload
-

  ExecStart
-

  FragmentPath
-

  GuessMainPID
-

  Id
-

  IgnoreOnIsolate
-

  IgnoreOnSnapshot
-

  IgnoreSIGPIPE
-

  InactiveEnterTimestampMonotonic
-

  InactiveExitTimestamp
-

  InactiveExitTimestampMonotonic
-

  IOScheduling
-

  JobTimeoutUSec
-

  KillMode
-

  KillSignal
-

  LimitAS
-

  LimitCORE
-

  LimitCPU
-

  LimitDATA
-

  LimitFSIZE
-

  LimitLOCKS
-

  LimitMEMLOCK
-

  LimitMSGQUEUE
-

  LimitNICE
-

  LimitNOFILE
-

  LimitNPROC
-

  LimitRSS
-

  LimitRTPRIO
-

  LimitRTTIME
-

  LimitSIGPENDING
-

  LimitSTACK
-

  LoadState
-

  MainPID
-

  MemoryAccounting
-

  MemoryLimit
-

  MountFlags
-

  Names
-

  NeedDaemonReload
-

  Nice
-

  NonBlocking
-

  NoNewPrivileges
-

  NotifyAccess
-

  OnFailureIsolate
-

  OOMScoreAdjust
-

  PermissionsStartOnly
-

  PrivateNetwork
-

  PrivateTmp
-

  RefuseManualStart
-

  RefuseManualStop
-

  RemainAfterExit
-

  Requires
-

  Restart
-

  RestartUSec
-

  Result
-

  RootDirectoryStartOnly
-

  SameProcessGroup
-

  SecureBits
-

  SendSIGHUP
-

  SendSIGKILL
-

  Slice
-

  StandardError
-

  StandardInput
-

  StandardOutput
-

  StartLimitAction
-

  StartLimitBurst
-

  StartLimitInterval
-

  StatusErrno
-

  StopWhenUnneeded
-

  SubState
-

  SyslogLevelPrefix
-

  SyslogPriority
-

  TimeoutStartUSec
-

  TimeoutStopUSec
-

  TimerSlackNSec
-

  Transient
-

  TTYReset
-

  TTYVHangup
-

  TTYVTDisallocate
-

  Type
-

  UMask
-

  UnitFileState
-

  WantedBy
-

  Wants
-

  WatchdogTimestampMonotonic
-

  WatchdogUSec
-



Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Ansible Core Team

Hint

If you notice any issues in this documentation you can edit this document to improve it.