a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

svc: adjustments to docs (#9470) 

* svc: adjustments to docs

* Update plugins/modules/svc.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
pull/9486/head
Alexei Znamensky 2024-12-31 07:53:43 +13:00 committed by GitHub
parent f8bfd5df0d
commit f55899d6ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
plugins/modules/svc.py
View File

@ -12,9 +12,9 @@ DOCUMENTATION = r"""
module: svc module: svc
author: author:
- Brian Coca (@bcoca) - Brian Coca (@bcoca)
short_description: Manage daemontools services short_description: Manage C(daemontools) services
description: description:
- Controls daemontools services on remote hosts using the svc utility. - Controls C(daemontools) services on remote hosts using the C(svc) utility.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -30,23 +30,24 @@ options:
required: true required: true
state: state:
description: description:
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the svc (svc - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary.
-t) and V(killed) will always bounce the svc (svc -k). V(reloaded) will send a sigusr1 (svc -1). V(once) will run a normally downed svc - V(restarted) will always bounce the svc (svc -t) and V(killed) will always bounce the svc (svc -k).
once (svc -o), not really an idempotent operation. - V(reloaded) will send a sigusr1 (svc -1).
- V(once) will run a normally downed svc once (svc -o), not really an idempotent operation.
type: str type: str
choices: [killed, once, reloaded, restarted, started, stopped] choices: [killed, once, reloaded, restarted, started, stopped]
downed: downed:
description: description:
- Should a 'down' file exist or not, if it exists it disables auto startup. Defaults to no. Downed does not imply stopped. - Should a C(down) file exist or not, if it exists it disables auto startup. Defaults to V(false). Downed does not imply stopped.
type: bool type: bool
enabled: enabled:
description: description:
- 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 - Whether the service is enabled or not, if disabled it also implies O(state=stopped). Take note that a service can be enabled and downed (no auto
restart). restart).
type: bool type: bool
service_dir: service_dir:
description: description:
- Directory svscan watches for services. - Directory C(svscan) watches for services.
type: str type: str
default: /service default: /service
service_src: service_src: