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.
-
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.available(name, limit='')
-
Delete the named service
New in version 2016.3.
CLI Example:
salt '*' service.delete <service name>
salt.modules.rh_service.delete(name, **kwargs)
-
Disable the named service to start at boot
CLI Example:
salt '*' service.disable <service name>
salt.modules.rh_service.disable(name, **kwargs)
-
Check to see if the named service is disabled to start on boot
CLI Example:
salt '*' service.disabled <service name>
salt.modules.rh_service.disabled(name)
-
Enable the named service to start at boot
CLI Example:
salt '*' service.enable <service name>
salt.modules.rh_service.enable(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.enabled(name, **kwargs)
-
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_all(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_disabled(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.get_enabled(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.missing(name, limit='')
-
Reload the named service
CLI Example:
salt '*' service.reload <service name>
salt.modules.rh_service.reload_(name)
-
Restart the named service
CLI Example:
salt '*' service.restart <service name>
salt.modules.rh_service.restart(name)
-
Start the specified service
CLI Example:
salt '*' service.start <service name>
salt.modules.rh_service.start(name)
-
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
- Returns
-
True if running, False otherwise dict: Maps service name to True if running, False otherwise
- Return type
CLI Example:
salt '*' service.status <service name> [service signature]
salt.modules.rh_service.status(name, sig=None)
-
Stop the specified service
CLI Example:
salt '*' service.stop <service name>
salt.modules.rh_service.stop(name)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.rh_service.html