salt.modules.debian_service#

Service support for Debian systems (uses update-rc.d and /sbin/service)

Important

If you feel that Salt should be using this module to manage services on a minion, and it is using a different module (or gives an error similar to 'service.start' is not available), see here.

salt.modules.debian_service.available(name)#

Returns True if the specified service is available, otherwise returns False.

CLI Example:

salt '*' service.available sshd
salt.modules.debian_service.disable(name, **kwargs)#

Disable the named service to start at boot

CLI Example:

salt '*' service.disable <service name>
salt.modules.debian_service.disabled(name)#

Return True if the named service is disabled, false otherwise

CLI Example:

salt '*' service.disabled <service name>
salt.modules.debian_service.enable(name, **kwargs)#

Enable the named service to start at boot

CLI Example:

salt '*' service.enable <service name>
salt.modules.debian_service.enabled(name, **kwargs)#

Return True if the named service is enabled, false otherwise

CLI Example:

salt '*' service.enabled <service name>
salt.modules.debian_service.force_reload(name)#

Force-reload the named service

CLI Example:

salt '*' service.force_reload <service name>
salt.modules.debian_service.get_all()#

Return all available boot services

CLI Example:

salt '*' service.get_all
salt.modules.debian_service.get_disabled()#

Return a set of services that are installed but disabled

CLI Example:

salt '*' service.get_disabled
salt.modules.debian_service.get_enabled()#

Return a list of service that are enabled on boot

CLI Example:

salt '*' service.get_enabled
salt.modules.debian_service.missing(name)#

The inverse of service.available. Returns True if the specified service is not available, otherwise returns False.

CLI Example:

salt '*' service.missing sshd
salt.modules.debian_service.reload_(name)#

Reload the named service

CLI Example:

salt '*' service.reload <service name>
salt.modules.debian_service.restart(name)#

Restart the named service

CLI Example:

salt '*' service.restart <service name>
salt.modules.debian_service.start(name)#

Start the specified service

CLI Example:

salt '*' service.start <service name>
salt.modules.debian_service.status(name, sig=None)#

Return the status for a service. If the name contains globbing, a dict mapping service name to True/False values is returned.

Changed in version 2018.3.0: The service name can now be a glob (e.g. salt*)

Parameters:

  • name (str) -- The name of the service to check

  • sig (str) -- Signature to use to find the service via ps

Returns:

True if running, False otherwise dict: Maps service name to True if running, False otherwise

Return type:

bool

CLI Example:

salt '*' service.status <service name> [service signature]
salt.modules.debian_service.stop(name)#

Stop the specified service

CLI Example:

salt '*' service.stop <service name>