Class: Ansible::Ruby::Modules::Supervisorctl

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#config ⇒ String?

Returns The supervisor configuration file path.

Returns:

  • (String, nil) —

    The supervisor configuration file path



16
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 16

attribute :config

#name ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



12
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 12

attribute :name

#password ⇒ String?

Returns password to use for authentication.

Returns:

  • (String, nil) —

    password to use for authentication



28
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 28

attribute :password

#server_url ⇒ String?

Returns URL on which supervisord server is listening.

Returns:

  • (String, nil) —

    URL on which supervisord server is listening



20
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 20

attribute :server_url

#state ⇒ :present, ...

Returns The desired state of program/group.

Returns:

  • (:present, :started, :stopped, :restarted, :absent) —

    The desired state of program/group.



32
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 32

attribute :state

#supervisorctl_path ⇒ Object?

Returns path to supervisorctl executable.

Returns:

  • (Object, nil) —

    path to supervisorctl executable



36
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 36

attribute :supervisorctl_path

#username ⇒ String?

Returns username to use for authentication.

Returns:

  • (String, nil) —

    username to use for authentication



24
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/supervisorctl.rb', line 24

attribute :username