supervisorctl – Manage the state of a program or group of programs running via supervisord
supervisorctl – Manage the state of a program or group of programs running via supervisord
Synopsis
- Manage the state of a program or group of programs running via supervisord
Requirements
The below requirements are needed on the host that executes this module.
- supervisorctl
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
config - |
The supervisor configuration file path | |
name - / required |
The name of the supervisord program or group to manage. The name will be taken as group name when it ends with a colon : Group support is only available in Ansible version 1.6 or later. | |
password - |
password to use for authentication | |
server_url - |
URL on which supervisord server is listening | |
signal - added in 2.8 |
The signal to send to the program/group, when combined with the 'signalled' state. Required when l(state=signalled). | |
state - / required |
|
The desired state of program/group. |
supervisorctl_path - |
path to supervisorctl executable | |
username - |
username to use for authentication |
Notes
Note
- When
state
= present, the module will callsupervisorctl reread
thensupervisorctl add
if the program/group does not exist. - When
state
= restarted, the module will callsupervisorctl update
then callsupervisorctl restart
. - When
state
= absent, the module will callsupervisorctl reread
thensupervisorctl remove
to remove the target program/group.
Examples
# Manage the state of program to be in 'started' state.
- supervisorctl:
name: my_app
state: started
# Manage the state of program group to be in 'started' state.
- supervisorctl:
name: 'my_apps:'
state: started
# Restart my_app, reading supervisorctl configuration from a specified file.
- supervisorctl:
name: my_app
state: restarted
config: /var/opt/my_project/supervisord.conf
# Restart my_app, connecting to supervisord with credentials and server URL.
- supervisorctl:
name: my_app
state: restarted
username: test
password: testpass
server_url: http://localhost:9001
# Send a signal to my_app via supervisorctl
- supervisorctl:
name: my_app
state: signalled
signal: USR1
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Matt Wright (@mattupstate)
- Aaron Wang (@inetfuture) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/supervisorctl_module.html