salt.modules.rest_service
Provide the service module for the proxy-minion REST sample
-
Only the 'redbull' service is 'enabled' in the test
New in version 2015.8.1.
salt.modules.rest_service.enabled(name, sig=None)
-
Return a list of all available services
New in version 2015.8.0.
CLI Example:
salt '*' service.get_all
salt.modules.rest_service.get_all()
-
Return a list of all available services.
New in version 2015.8.1.
CLI Example:
salt '*' service.list
salt.modules.rest_service.list_()
-
Restart the specified service with rest_sample
New in version 2015.8.0.
CLI Example:
salt '*' service.restart <service name>
salt.modules.rest_service.restart(name, sig=None)
-
Return whether this service is running.
New in version 2015.8.0.
salt.modules.rest_service.running(name, sig=None)
-
Start the specified service on the rest_sample
New in version 2015.8.0.
CLI Example:
salt '*' service.start <service name>
salt.modules.rest_service.start(name, sig=None)
-
Return the status for a service via rest_sample. If the name contains globbing, a dict mapping service name to True/False values is returned.
New in version 2015.8.0.
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>
salt.modules.rest_service.status(name, sig=None)
-
Stop the specified service on the rest_sample
New in version 2015.8.0.
CLI Example:
salt '*' service.stop <service name>
salt.modules.rest_service.stop(name, sig=None)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.rest_service.html