supervisorctl - Manage the state of a program or group of programs running via supervisord

Author:Matt Wright, Aaron Wang <inetfuture@gmail.com>

Synopsis

Manage the state of a program or group of programs running via supervisord

Options

parameter required default choices comments
config no
    The supervisor configuration file path (added in Ansible 1.3)
    name yes
      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 no
        password to use for authentication (added in Ansible 1.3)
        server_url no
          URL on which supervisord server is listening (added in Ansible 1.3)
          state yes
          • present
          • started
          • stopped
          • restarted
          The desired state of program/group.
          supervisorctl_path no
            path to supervisorctl executable (added in Ansible 1.4)
            username no
              username to use for authentication (added in Ansible 1.3)

              Note

              Requires supervisorctl

              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
              

              Note

              When state = present, the module will call supervisorctl reread then supervisorctl add if the program/group does not exist.

              Note

              When state = restarted, the module will call supervisorctl update then call supervisorctl restart.