From cb8b5f30255b5fe352763816ff5a2312aab1da52 Mon Sep 17 00:00:00 2001 From: Matthew Jones Date: Thu, 26 Mar 2015 10:51:46 -0400 Subject: [PATCH] Add some header documentation for the service scanning module --- awx/plugins/library/scan_services.py | 40 ++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/awx/plugins/library/scan_services.py b/awx/plugins/library/scan_services.py index 4c6931dc3c..920daa860c 100644 --- a/awx/plugins/library/scan_services.py +++ b/awx/plugins/library/scan_services.py @@ -3,6 +3,46 @@ import re from ansible.module_utils.basic import * # noqa +DOCUMENTATION = ''' +--- +module: scan_services +short_description: Return service state information as fact data +description: + - Return service state information as fact data for various service management utilities +version_added: "1.9" +options: +requirements: [ ] +author: Matthew Jones +''' + +EXAMPLES = ''' +- monit: scan_services +# Example fact output: +# host | success >> { +# "ansible_facts": { +# "services": [ +# { +# "name": "acpid", +# "source": "sysv", +# "state": "running" +# }, +# { +# "name": "apparmor", +# "source": "sysv", +# "state": "stopped" +# }, +# { +# "name": "atd", +# "source": "sysv", +# "state": "running" +# }, +# { +# "name": "cron", +# "source": "sysv", +# "state": "running" +# }, .... ] } } +''' + class BaseService(object): def __init__(self, module):