salt.modules.rh_service

Service support for RHEL-based systems, including support for both upstart and sysvinit

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.rh_service.available(name, limit='')

Return True if the named service is available. Use the limit param to restrict results to services of that type.

CLI Examples:

salt '*' service.available sshd
salt '*' service.available sshd limit=upstart
salt '*' service.available sshd limit=sysvinit
salt.modules.rh_service.delete(name, **kwargs)

Delete the named service

New in version 2016.3.

CLI Example:

salt '*' service.delete <service name>
salt.modules.rh_service.disable(name, **kwargs)

Disable the named service to start at boot

CLI Example:

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

Check to see if the named service is disabled to start on boot

CLI Example:

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

Enable the named service to start at boot

CLI Example:

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

Check to see if the named service is enabled to start on boot

CLI Example:

salt '*' service.enabled <service name>
salt.modules.rh_service.get_all(limit='')

Return all installed services. Use the limit param to restrict results to services of that type.

CLI Example:

salt '*' service.get_all
salt '*' service.get_all limit=upstart
salt '*' service.get_all limit=sysvinit
salt.modules.rh_service.get_disabled(limit='')

Return the disabled services. Use the limit param to restrict results to services of that type.

CLI Example:

salt '*' service.get_disabled
salt '*' service.get_disabled limit=upstart
salt '*' service.get_disabled limit=sysvinit
salt.modules.rh_service.get_enabled(limit='')

Return the enabled services. Use the limit param to restrict results to services of that type.

CLI Examples:

salt '*' service.get_enabled
salt '*' service.get_enabled limit=upstart
salt '*' service.get_enabled limit=sysvinit
salt.modules.rh_service.missing(name, limit='')

The inverse of service.available. Return True if the named service is not available. Use the limit param to restrict results to services of that type.

CLI Examples:

salt '*' service.missing sshd
salt '*' service.missing sshd limit=upstart
salt '*' service.missing sshd limit=sysvinit
salt.modules.rh_service.reload(name)

Reload the named service

CLI Example:

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

Restart the named service

CLI Example:

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

Start the specified service

CLI Example:

salt '*' service.start <service name>
salt.modules.rh_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 Oxygen: 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.rh_service.stop(name)

Stop the specified service

CLI Example:

salt '*' service.stop <service name>