Class: Ansible::Ruby::Modules::Haproxy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/network/haproxy.rb

Overview

Enable, disable, and set weights for HAProxy backend servers using socket commands.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#backend ⇒ String?

Returns Name of the HAProxy backend pool.

Returns:

  • (String, nil) —

    Name of the HAProxy backend pool.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 11

attribute :backend

#host ⇒ String

Returns Name of the backend host to change.

Returns:

  • (String) —

    Name of the backend host to change.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 15

attribute :host

#shutdown_sessions ⇒ Boolean?

Returns When disabling a server, immediately terminate all the sessions attached to the specified server. This can be used to terminate long-running sessions after a server is put into maintenance mode.

Returns:

  • (Boolean, nil) —

    When disabling a server, immediately terminate all the sessions attached to the specified server. This can be used to terminate long-running sessions after a server is put into maintenance mode.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 19

attribute :shutdown_sessions

#socket ⇒ String?

Returns Path to the HAProxy socket file.

Returns:

  • (String, nil) —

    Path to the HAProxy socket file.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 23

attribute :socket

#state ⇒ :enabled, :disabled

Returns Desired state of the provided backend host.

Returns:

  • (:enabled, :disabled) —

    Desired state of the provided backend host.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 27

attribute :state

#wait ⇒ Boolean?

Returns Wait until the server reports a status of ‘UP’ when ‘state=enabled`, or status of ’MAINT’ when ‘state=disabled`.

Returns:

  • (Boolean, nil) —

    Wait until the server reports a status of ‘UP’ when ‘state=enabled`, or status of ’MAINT’ when ‘state=disabled`.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 31

attribute :wait

#wait_interval ⇒ Integer?

Returns Number of seconds to wait between retries.

Returns:

  • (Integer, nil) —

    Number of seconds to wait between retries.



35
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 35

attribute :wait_interval

#wait_retries ⇒ Integer?

Returns Number of times to check for status after changing the state.

Returns:

  • (Integer, nil) —

    Number of times to check for status after changing the state.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 39

attribute :wait_retries

#weight ⇒ String?

Returns The value passed in argument. If the value ends with the ‘%` sign, then the new weight will be relative to the initially configured weight. Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256.

Returns:

  • (String, nil) —

    The value passed in argument. If the value ends with the ‘%` sign, then the new weight will be relative to the initially configured weight. Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256.



43
 
# File 'lib/ansible/ruby/modules/generated/extras/network/haproxy.rb', line 43

attribute :weight