diff options
| author | Michael DeHaan <michael@ansible.com> | 2014-03-28 13:07:13 -0400 |
|---|---|---|
| committer | Michael DeHaan <michael@ansible.com> | 2014-03-28 13:07:13 -0400 |
| commit | 6c206b3866444f86bd7d3542609934e6aefea62b (patch) | |
| tree | 47a7027718756692571c31e1fbcb51a6f7dbd211 /web_infrastructure | |
| parent | f24a6257501e4a83a9744ff43667a514d18e5b0d (diff) | |
| download | ansible-modules-extras-6c206b3866444f86bd7d3542609934e6aefea62b.tar.gz | |
Documentation updates for supervisor module changes.
Diffstat (limited to 'web_infrastructure')
| -rw-r--r-- | web_infrastructure/supervisorctl | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/web_infrastructure/supervisorctl b/web_infrastructure/supervisorctl index a53a93d2..2d458169 100644 --- a/web_infrastructure/supervisorctl +++ b/web_infrastructure/supervisorctl @@ -30,48 +30,50 @@ version_added: "0.7" options: name: description: - - The name of the supervisord program/group to manage. It will be taken as group name when it end with a colon I(:). + - The name of the supervisord program or group to manage. + - The name will be taken as group name when it ends with a colon I(:) + - Group support is only available in Ansible version 1.6 or later. required: true default: null config: description: - - configuration file path, passed as -c to supervisorctl. + - The supervisor configuration file path required: false default: null version_added: "1.3" server_url: description: - - URL on which supervisord server is listening, passed as -s to supervisorctl. + - URL on which supervisord server is listening required: false default: null version_added: "1.3" username: description: - - username to use for authentication with server, passed as -u to supervisorctl. + - username to use for authentication required: false default: null version_added: "1.3" password: description: - - password to use for authentication with server, passed as -p to supervisorctl. + - password to use for authentication required: false default: null version_added: "1.3" state: description: - - The desired state of program/group. Affected programs' name will be returned in I(affected) field of the result. + - The desired state of program/group. required: true default: null choices: [ "present", "started", "stopped", "restarted" ] supervisorctl_path: description: - - Path to supervisorctl executable to use. + - path to supervisorctl executable required: false default: null version_added: "1.4" notes: - - When C(state) = I(present), will call C(supervisorctl reread) then call C(supervisorctl add) if the program/group is not exists. - - When C(state) = I(restarted), will call C(supervisorctl update) then call C(supervisorctl restart). + - When C(state) = I(present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist. + - When C(state) = I(restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart). requirements: [ "supervisorctl" ] author: Matt Wright, Aaron Wang <inetfuture@gmail.com> ''' |