From 35f6d710570309af3ba7a0cf0df7e88ee6cce238 Mon Sep 17 00:00:00 2001 From: Marco Vito Moscaritolo Date: Sat, 29 Sep 2012 21:02:07 +0200 Subject: [PATCH] Added DOCUMENTATION to supervisorctl module. --- supervisorctl | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/supervisorctl b/supervisorctl index 880388abd5a..ff45af8496b 100755 --- a/supervisorctl +++ b/supervisorctl @@ -19,6 +19,32 @@ # along with Ansible. If not, see . # +DOCUMENTATION = ''' +--- +module: supervisorctl +short_description: Manage the state of a program or group of programs running via Supervisord +description: + - Manage the state of a program or group of programs running via Supervisord +version_added: "0.7" +options: + name: + description: + - The name of the supervisord program/process to manage + required: true + default: null + state: + description: + - The state of service + required: true + default: null + choices: [ "started", "stopped", "restarted" ] +examples: + - code: supervisorctl name=my_app state=started + description: Manage the state of program I(my_app) to be in I(started) state. +requirements: [ ] +author: Matt Wright +''' + def _is_present(name, supervisorctl): rc, out, err = _run('%s status' % supervisorctl) return name in out