salt.states.service

Starting or restarting of services and daemons

Services are defined as system daemons typically started with system init or rc scripts. The service state uses whichever service module that is loaded on the minion with the virtualname of service. Services can be defined as running or dead.

If you need to know if your init system is supported, see the list of supported service modules for your desired init system (systemd, sysvinit, launchctl, etc.).

Note that Salt's service execution module, and therefore this service state, uses OS grains to ascertain which service module should be loaded and used to execute service functions. As existing distributions change init systems or new distributions are created, OS detection can sometimes be incomplete. If your service states are running into trouble with init system detection, please see the Overriding Virtual Module Providers section of Salt's module documentation to work around possible errors.

Note

The current status of a service is determined by the return code of the init/rc script status command. A status return code of 0 it is considered running. Any other return code is considered dead.

httpd:
  service.running: []

The service can also be set to be started at runtime via the enable option:

openvpn:
  service.running:
    - enable: True

By default if a service is triggered to refresh due to a watch statement the service is by default restarted. If the desired behavior is to reload the service, then set the reload value to True:

redis:
  service.running:
    - enable: True
    - reload: True
    - watch:
      - pkg: redis

Note

More details regarding watch can be found in the Requisites documentation.

salt.states.service.dead(name, enable=None, sig=None, init_delay=None, **kwargs)

Ensure that the named service is dead by stopping the service if it is running

name
The name of the init or rc script used to manage the service
enable
Set the service to be enabled at boot time, True sets the service to be enabled, False sets the named service to be disabled. The default is None, which does not enable or disable anything.
sig
The string to search for when looking for the service process with ps
init_delay

Add a sleep command (in seconds) before the check to make sure service is killed.

New in version 2017.7.0.

no_block
: False

For systemd minions only. Stops the service using --no-block.

New in version 2017.7.0.

salt.states.service.disabled(name, **kwargs)

Ensure that the service is disabled on boot, only use this state if you don't want to manage the running process, remember that if you want to disable a service to use the enable: False option for the running or dead function.

name
The name of the init or rc script used to manage the service
salt.states.service.enabled(name, **kwargs)

Ensure that the service is enabled on boot, only use this state if you don't want to manage the running process, remember that if you want to enable a running service to use the enable: True option for the running or dead function.

name
The name of the init or rc script used to manage the service
salt.states.service.masked(name, runtime=False)

New in version 2017.7.0.

Note

This state is only available on minions which use systemd.

Ensures that the named service is masked (i.e. prevented from being started).

name
Name of the service to mask
runtime
: False
By default, this state will manage an indefinite mask for the named service. Set this argument to True to runtime mask the service.

Note

It is possible for a service to have both indefinite and runtime masks set for it. Therefore, this state will manage a runtime or indefinite mask independently of each other. This means that if the service is already indefinitely masked, running this state with runtime set to True will _not_ remove the indefinite mask before setting a runtime mask. In these cases, if it is desirable to ensure that the service is runtime masked and not indefinitely masked, pair this state with a service.unmasked state, like so:

mask_runtime_foo:
  service.masked:
    - name: foo
    - runtime: True

unmask_indefinite_foo:
  service.unmasked:
    - name: foo
    - runtime: False
salt.states.service.mod_watch(name, sfun=None, sig=None, reload=False, full_restart=False, init_delay=None, force=False, **kwargs)

The service watcher, called to invoke the watch command.

name
The name of the init or rc script used to manage the service
sfun
The original function which triggered the mod_watch call (service.running, for example).
sig
The string to search for when looking for the service process with ps
reload
Use reload instead of the default restart (exclusive option with full_restart, defaults to reload if both are used)
full_restart
Use service.full_restart instead of restart (exclusive option with reload)
force
Use service.force_reload instead of reload (needs reload to be set to True)
init_delay
Add a sleep command (in seconds) before the service is restarted/reloaded
salt.states.service.running(name, enable=None, sig=None, init_delay=None, no_block=False, unmask=False, unmask_runtime=False, **kwargs)

Ensure that the service is running

name
The name of the init or rc script used to manage the service
enable
Set the service to be enabled at boot time, True sets the service to be enabled, False sets the named service to be disabled. The default is None, which does not enable or disable anything.
sig
The string to search for when looking for the service process with ps
init_delay
Some services may not be truly available for a short period after their startup script indicates to the system that they are. Provide an 'init_delay' to specify that this state should wait an additional given number of seconds after a service has started before returning. Useful for requisite states wherein a dependent state might assume a service has started but is not yet fully initialized.
no_block
: False

For systemd minions only. Starts the service using --no-block.

New in version 2017.7.0.

unmask
: False

For systemd minions only. Set to True to remove an indefinite mask before attempting to start the service.

New in version 2017.7.0: In previous releases, Salt would simply unmask a service before making any changes. This behavior is no longer the default.

unmask_runtime
: False

For systemd minions only. Set to True to remove a runtime mask before attempting to start the service.

New in version 2017.7.0: In previous releases, Salt would simply unmask a service before making any changes. This behavior is no longer the default.

Note

watch can be used with service.running to restart a service when
another state changes ( example: a file.managed state that creates the service's config file ). More details regarding watch can be found in the Requisites documentation.
salt.states.service.unmasked(name, runtime=False)

New in version 2017.7.0.

Note

This state is only available on minions which use systemd.

Ensures that the named service is unmasked

name
Name of the service to unmask
runtime
: False
By default, this state will manage an indefinite mask for the named service. Set this argument to True to ensure that the service is runtime masked.

Note

It is possible for a service to have both indefinite and runtime masks set for it. Therefore, this state will manage a runtime or indefinite mask independently of each other. This means that if the service is indefinitely masked, running this state with runtime set to True will _not_ remove the indefinite mask.