ansible.builtin.service module – Manage services

Note

This module is part of ansible-core and included in all Ansible installations. In most cases, you can use the short module name service even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 0.1: of ansible.builtin

Synopsis

  • Controls services on remote hosts. Supported init systems include BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart.

  • This module acts as a proxy to the underlying service manager module. While all arguments will be passed to the underlying module, not all modules support the same arguments. This documentation only covers the minimum intersection of module arguments that all service manager modules support.

  • This module is a proxy for multiple more specific service manager modules (such as ansible.builtin.systemd and ansible.builtin.sysvinit). This allows management of a heterogeneous environment of machines without creating a specific task for each service manager. The module to be executed is determined by the use option, which defaults to the service manager discovered by ansible.builtin.setup. If setup was not yet run, this module may run it.

  • For Windows targets, use the ansible.windows.win_service module instead.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

arguments

aliases: args

string

Additional arguments provided on the command line.

While using remote hosts with systemd this setting will be ignored.

enabled

boolean

Whether the service should start on boot.

At least one of state and enabled are required.

Choices:

  • no

  • yes

name

string / required

Name of the service.

pattern

string

added in 0.7 of ansible.builtin

If the service does not respond to the status command, name a substring to look for as would be found in the output of the ps command as a stand-in for a status result.

If the string is found, the service will be assumed to be started.

While using remote hosts with systemd this setting will be ignored.

runlevel

string

For OpenRC init scripts (e.g. Gentoo) only.

The runlevel that this service belongs to.

While using remote hosts with systemd this setting will be ignored.

Default: “default”

sleep

integer

added in 1.3 of ansible.builtin

If the service is being restarted then sleep this many seconds between the stop and start command.

This helps to work around badly-behaving init scripts that exit immediately after signaling a process to stop.

Not all service managers support sleep, i.e when using systemd this setting will be ignored.

state

string

started/stopped are idempotent actions that will not run commands unless necessary.

restarted will always bounce the service.

reloaded will always reload.

At least one of state and enabled are required.

Note that reloaded will start the service if it is not already started, even if your chosen init system wouldn’t normally.

Choices:

  • reloaded

  • restarted

  • started

  • stopped

use

string

added in 2.2 of ansible.builtin

The service module actually uses system specific modules, normally through auto detection, this setting can force a specific module.

Normally it uses the value of the ‘ansible_service_mgr’ fact and falls back to the old ‘service’ module when none matching is found.

Default: “auto”

Attributes

Attribute

Support

Description

action

Support: full

Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller

async

Support: full

Supports being used with the async keyword

bypass_host_loop

Support: none

Forces a ‘global’ task that does not execute per host, this bypasses per host templating and serial, throttle and other loop considerations

Conditionals will work as if run_once is being used, variables used will be from the first available host

This action will not work normally outside of lockstep strategies

check_mode

Support: N/A

support depends on the underlying plugin invoked

Can run in check_mode and return changed status prediction without modifying target

diff_mode

Support: N/A

support depends on the underlying plugin invoked

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

The support depends on the availability for the specific plugin for each platform and if fact gathering is able to detect it

Target OS/families that can be operated against

Notes

Note

  • For AIX, group subsystem names can be used.

See Also

See also

ansible.windows.win_service

The official documentation on the ansible.windows.win_service module.

Examples

- name: Start service httpd, if not started
  ansible.builtin.service:
    name: httpd
    state: started

- name: Stop service httpd, if started
  ansible.builtin.service:
    name: httpd
    state: stopped

- name: Restart service httpd, in all cases
  ansible.builtin.service:
    name: httpd
    state: restarted

- name: Reload service httpd, in all cases
  ansible.builtin.service:
    name: httpd
    state: reloaded

- name: Enable service httpd, and not touch the state
  ansible.builtin.service:
    name: httpd
    enabled: yes

- name: Start service foo, based on running process /usr/bin/foo
  ansible.builtin.service:
    name: foo
    pattern: /usr/bin/foo
    state: started

- name: Restart network service for interface eth0
  ansible.builtin.service:
    name: network
    state: restarted
    args: eth0

Authors

  • Ansible Core Team

  • Michael DeHaan