salt.states.service

Starting or restarting of services and daemons

Services are defined as system daemons typically started with system init or rc scripts. Services can be defined as running or dead.

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, **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
salt.states.service.disabled(name, **kwargs)

Verify 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)

Verify 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.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
salt.states.service.running(name, enable=None, sig=None, init_delay=None, **kwargs)

Verify 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.