cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Documentation updates for supervisor module changes.

Browse source
This commit is contained in:
Michael DeHaan 2014-03-28 13:07:13 -04:00
parent f24a625750
commit 6c206b3866
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
web_infrastructure/supervisorctl
View file

@ -30,48 +30,50 @@ version_added: "0.7"
options: options:
name: name:
description: 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 required: true
default: null default: null
config: config:
description: description:
- configuration file path, passed as -c to supervisorctl. - The supervisor configuration file path
required: false required: false
default: null default: null
version_added: "1.3" version_added: "1.3"
server_url: server_url:
description: description:
- URL on which supervisord server is listening, passed as -s to supervisorctl. - URL on which supervisord server is listening
required: false required: false
default: null default: null
version_added: "1.3" version_added: "1.3"
username: username:
description: description:
- username to use for authentication with server, passed as -u to supervisorctl. - username to use for authentication
required: false required: false
default: null default: null
version_added: "1.3" version_added: "1.3"
password: password:
description: description:
- password to use for authentication with server, passed as -p to supervisorctl. - password to use for authentication
required: false required: false
default: null default: null
version_added: "1.3" version_added: "1.3"
state: state:
description: 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 required: true
default: null default: null
choices: [ "present", "started", "stopped", "restarted" ] choices: [ "present", "started", "stopped", "restarted" ]
supervisorctl_path: supervisorctl_path:
description: description:
- Path to supervisorctl executable to use. - path to supervisorctl executable
required: false required: false
default: null default: null
version_added: "1.4" version_added: "1.4"
notes: 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(present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist.
- When C(state) = I(restarted), will call C(supervisorctl update) then call C(supervisorctl restart). - When C(state) = I(restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart).
requirements: [ "supervisorctl" ] requirements: [ "supervisorctl" ]
author: Matt Wright, Aaron Wang <inetfuture@gmail.com> author: Matt Wright, Aaron Wang <inetfuture@gmail.com>
''' '''