salt.modules.supervisord¶

Provide the service module for system supervisord or supervisord in a virtualenv

salt.modules.supervisord.add(name, user=None, conf_file=None, bin_env=None)¶

Activates any updates in config for process/group.

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.add <name>

salt.modules.supervisord.custom(command, user=None, conf_file=None, bin_env=None)¶

Run any custom supervisord command

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.custom "mstop '*gunicorn*'"

salt.modules.supervisord.options(name, conf_file=None)¶

New in version 2014.1.0.

Read the config file and return the config options for a given process

name: Name of the configured process
conf_file: path to supervisord config file

CLI Example:

salt '*' supervisord.options foo

salt.modules.supervisord.remove(name, user=None, conf_file=None, bin_env=None)¶

Removes process/group from active config

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.remove <name>

salt.modules.supervisord.reread(user=None, conf_file=None, bin_env=None)¶

Reload the daemon's configuration files

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.reread

salt.modules.supervisord.restart(name='all', user=None, conf_file=None, bin_env=None)¶

Restart the named service. Process group names should not include a trailing asterisk.

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.restart <service>
salt '*' supervisord.restart <group>:

salt.modules.supervisord.start(name='all', user=None, conf_file=None, bin_env=None)¶

Start the named service. Process group names should not include a trailing asterisk.

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.start <service>
salt '*' supervisord.start <group>:

salt.modules.supervisord.status(name=None, user=None, conf_file=None, bin_env=None)¶

List programs and its state

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.status

salt.modules.supervisord.status_bool(name, expected_state=None, user=None, conf_file=None, bin_env=None)¶

Check for status of a specific supervisord process and return boolean result.

name: name of the process to check
expected_state: search for a specific process state. If set to None - any process state will match.
user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.status_bool nginx expected_state='RUNNING'

salt.modules.supervisord.status_raw(name=None, user=None, conf_file=None, bin_env=None)¶

Display the raw output of status

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.status_raw

salt.modules.supervisord.stop(name='all', user=None, conf_file=None, bin_env=None)¶

Stop the named service. Process group names should not include a trailing asterisk.

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed

CLI Example:

salt '*' supervisord.stop <service>
salt '*' supervisord.stop <group>:

salt.modules.supervisord.update(user=None, conf_file=None, bin_env=None, name=None)¶

Reload config and add/remove/update as necessary

user: user to run supervisorctl as
conf_file: path to supervisord config file
bin_env: path to supervisorctl bin or path to virtualenv with supervisor installed
name: name of the process group to update. if none then update any process group that has changes

CLI Example:

salt '*' supervisord.update

Generated on June 18, 2020 at 04:09:58 UTC.

You are viewing docs for the latest stable release, 3001. Switch to docs for the previous stable release, 3000.3, or to a recent doc build from the master branch.

saltstack.com