Author: | Michael DeHaan |
---|
parameter | required | default | choices | comments |
---|---|---|---|---|
arguments | no | Additional arguments provided on the command line | ||
enabled | no |
|
Whether the service should start on boot. At least one of state and enabled are required. | |
name | yes | Name of the service. | ||
pattern | no | If the service does not respond to the status command, name a substring to look for as would be found in the output of the ps command as a stand-in for a status result. If the string is found, the service will be assumed to be running. (added in Ansible 0.7) | ||
runlevel | no | default | For OpenRC init scripts (ex: Gentoo) only. The runlevel that this service belongs to. | |
sleep | no | If the service is being restarted then sleep this many seconds between the stop and start command. This helps to workaround badly behaving init scripts that exit immediately after signaling a process to stop. (added in Ansible 1.3) |
||
state | no |
|
started /stopped are idempotent actions that will not run commands unless necessary. restarted will always bounce the service. reloaded will always reload. At least one of state and enabled are required. |
# Example action to start service httpd, if not running
- service: name=httpd state=started
# Example action to stop service httpd, if running
- service: name=httpd state=stopped
# Example action to restart service httpd, in all cases
- service: name=httpd state=restarted
# Example action to reload service httpd, in all cases
- service: name=httpd state=reloaded
# Example action to enable service httpd, and not touch the running state
- service: name=httpd enabled=yes
# Example action to start service foo, based on running process /usr/bin/foo
- service: name=foo pattern=/usr/bin/foo state=started
# Example action to restart network service for interface eth0
- service: name=network state=restarted args=eth0