summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorAbhijeet Kasurde <akasurde@redhat.com>2020-06-02 17:07:02 +0200
committerGitHub <noreply@github.com>2020-06-02 17:07:02 +0200
commitd757995bb62dfa3f8022b5bf7a1a3082c7a93ce8 (patch)
treeaf5d275d5e116c33bf14b2d61f832ac337266bd4 /lib
parentDiscover Flatcar Linux properly for hostname (#69627) (diff)
downloadansible-d757995bb62dfa3f8022b5bf7a1a3082c7a93ce8.tar.xz
ansible-d757995bb62dfa3f8022b5bf7a1a3082c7a93ce8.zip
service_facts: Update documentation about service status (#69757)
Update documentation about undocumented service status provided by systemd Fixes: #69752 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/ansible/modules/service_facts.py20
1 files changed, 13 insertions, 7 deletions
diff --git a/lib/ansible/modules/service_facts.py b/lib/ansible/modules/service_facts.py
index 79556baeb3..c890163139 100644
--- a/lib/ansible/modules/service_facts.py
+++ b/lib/ansible/modules/service_facts.py
@@ -1,5 +1,5 @@
#!/usr/bin/python
-# (c) 2017, Ansible Project
+# Copyright: (c) 2017, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# originally copied from AWX's scan_services module to bring this functionality
@@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'core'}
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
---
module: service_facts
short_description: Return service state information as fact data
@@ -34,7 +34,7 @@ author:
- Adam Miller (@maxamillion)
'''
-EXAMPLES = '''
+EXAMPLES = r'''
- name: Populate service facts
service_facts:
@@ -43,7 +43,7 @@ EXAMPLES = '''
'''
-RETURN = '''
+RETURN = r'''
ansible_facts:
description: Facts to add to ansible_facts about the services on the system
returned: always
@@ -55,17 +55,23 @@ ansible_facts:
type: complex
contains:
source:
- description: Init system of the service. One of C(systemd), C(sysv), C(upstart).
+ description:
+ - Init system of the service.
+ - One of C(systemd), C(sysv), C(upstart).
returned: always
type: str
sample: sysv
state:
- description: State of the service. Either C(running), C(stopped), or C(unknown).
+ description:
+ - State of the service.
+ - Either C(running), C(stopped), or C(unknown).
returned: always
type: str
sample: running
status:
- description: State of the service. Either C(enabled), C(disabled), or C(unknown).
+ description:
+ - State of the service.
+ - Either C(enabled), C(disabled), C(static), C(indirect) or C(unknown).
returned: systemd systems or RedHat/SUSE flavored sysvinit/upstart
type: str
sample: enabled