mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 13:52:54 +00:00
Jumbo DOCUMENTATION patch
This commit is contained in:
@@ -22,34 +22,36 @@ DOCUMENTATION = '''
|
||||
---
|
||||
module: service
|
||||
author: Michael DeHaan
|
||||
version_added: 0.0.1
|
||||
version_added: 0.1
|
||||
short_description: Manage services.
|
||||
description:
|
||||
- Controls services on remote hosts.
|
||||
options:
|
||||
name:
|
||||
required: true
|
||||
description: Name of the service.
|
||||
description:
|
||||
- Name of the service.
|
||||
state:
|
||||
required: false
|
||||
choices: [ running, started, stopped, restarted, reloaded ]
|
||||
description: I(started), I(stopped), I(reloaded), I(restarted).
|
||||
I(Started)/I(stopped) are idempotent actions that will
|
||||
not run commands unless necessary. I(restarted) will
|
||||
always bounce the service. I(reloaded) will always
|
||||
reload.
|
||||
description:
|
||||
- I(started), I(stopped), I(reloaded), I(restarted).
|
||||
I(Started)/I(stopped) are idempotent actions that will not run
|
||||
commands unless necessary. I(restarted) will always bounce the
|
||||
service. I(reloaded) will always reload.
|
||||
pattern:
|
||||
required: false
|
||||
description: New in 0.7. 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 I(ps) command
|
||||
as a stand-in for a status result. If the string is
|
||||
found, the servie will be assumed to be running.
|
||||
version_added: "0.7"
|
||||
description:
|
||||
- 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 I(ps)
|
||||
command as a stand-in for a status result. If the string is found,
|
||||
the servie will be assumed to be running.
|
||||
enabled:
|
||||
required: false
|
||||
choices: [ yes, no ]
|
||||
description: Whether the service should start on boot. Either
|
||||
I(yes) or I(no).
|
||||
choices: [ "yes", "no" ]
|
||||
description:
|
||||
- Whether the service should start on boot.
|
||||
examples:
|
||||
- code: service name=httpd state=started
|
||||
description: Example action from Ansible Playbooks
|
||||
|
||||
Reference in New Issue
Block a user