Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.svc
.
Parameter | Choices/Defaults | Comments |
---|---|---|
downed boolean |
| Should a 'down' file exist or not, if it exists it disables auto startup. Defaults to no. Downed does not imply stopped. |
enabled boolean |
| Whether the service is enabled or not, if disabled it also implies stopped. Take note that a service can be enabled and downed (no auto restart). |
name string / required | Name of the service to manage. | |
service_dir string | Default: "/service" | Directory svscan watches for services |
service_src string | Default: "/etc/service" | Directory where services are defined, the source of symlinks to service_dir. |
state string |
| Started /stopped are idempotent actions that will not run commands unless necessary. restarted will always bounce the svc (svc -t) and killed will always bounce the svc (svc -k). reloaded will send a sigusr1 (svc -1). once will run a normally downed svc once (svc -o), not really an idempotent operation. |
- name: Start svc dnscache, if not running community.general.svc: name: dnscache state: started - name: Stop svc dnscache, if running community.general.svc: name: dnscache state: stopped - name: Kill svc dnscache, in all cases community.general.svc: name: dnscache state: killed - name: Restart svc dnscache, in all cases community.general.svc: name: dnscache state: restarted - name: Reload svc dnscache, in all cases community.general.svc: name: dnscache state: reloaded - name: Using alternative svc directory location community.general.svc: name: dnscache state: reloaded service_dir: /var/service
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/svc_module.html