ansible.builtin.supervisorctl (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Requirements

• supervisorctl

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Manage the state of program to be in 'started' state.
- supervisorctl:
    name: my_app
    state: started

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Manage the state of program group to be in 'started' state.
- supervisorctl:
    name: 'my_apps:'
    state: started

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Restart my_app, reading supervisorctl configuration from a specified file.
- supervisorctl:
    name: my_app
    state: restarted
    config: /var/opt/my_project/supervisord.conf

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Send a signal to my_app via supervisorctl
- supervisorctl:
    name: my_app
    state: signalled
    signal: USR1

Inputs

    
name:
    description:
    - 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

state:
    choices:
    - present
    - started
    - stopped
    - restarted
    - absent
    - signalled
    description:
    - The desired state of program/group.
    required: true

config:
    description:
    - The supervisor configuration file path
    version_added: '1.3'
    version_added_collection: ansible.builtin

signal:
    description:
    - The signal to send to the program/group, when combined with the 'signalled' state.
      Required when l(state=signalled).
    version_added: '2.8'
    version_added_collection: ansible.builtin

password:
    description:
    - password to use for authentication
    version_added: '1.3'
    version_added_collection: ansible.builtin

username:
    description:
    - username to use for authentication
    version_added: '1.3'
    version_added_collection: ansible.builtin

server_url:
    description:
    - URL on which supervisord server is listening
    version_added: '1.3'
    version_added_collection: ansible.builtin

supervisorctl_path:
    description:
    - path to supervisorctl executable
    version_added: '1.4'
    version_added_collection: ansible.builtin