Class: Ansible::Ruby::Modules::Proxysql_backend_servers

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb

Overview

The M(proxysql_backend_servers) module adds or removes mysql hosts using the proxysql admin interface.

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

#comment ⇒ String?

Returns Text field that can be used for any purposed defined by the user. Could be a description of what the host stores, a reminder of when the host was added or disabled, or a JSON processed by some checker script.

Returns:

  • (String, nil) —

    Text field that can be used for any purposed defined by the user. Could be a description of what the host stores, a reminder of when the host was added or disabled, or a JSON processed by some checker script.



46
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 46

attribute :comment

#compression ⇒ Object?

Returns If the value of I(compression) is greater than 0, new connections to that server will use compression. If omitted the proxysql database default for I(compression) is 0.

Returns:

  • (Object, nil) —

    If the value of I(compression) is greater than 0, new connections to that server will use compression. If omitted the proxysql database default for I(compression) is 0.



31
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 31

attribute :compression

#hostgroup_id ⇒ Integer?

Returns The hostgroup in which this mysqld instance is included. An instance can be part of one or more hostgroups.

Returns:

  • (Integer, nil) —

    The hostgroup in which this mysqld instance is included. An instance can be part of one or more hostgroups.



12
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 12

attribute :hostgroup_id

#hostname ⇒ String

Returns The ip address at which the mysqld instance can be contacted.

Returns:

  • (String) —

    The ip address at which the mysqld instance can be contacted.



16
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 16

attribute :hostname

#max_connections ⇒ Object?

Returns The maximum number of connections ProxySQL will open to this backend server. If omitted the proxysql database default for I(max_connections) is 1000.

Returns:

  • (Object, nil) —

    The maximum number of connections ProxySQL will open to this backend server. If omitted the proxysql database default for I(max_connections) is 1000.



34
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 34

attribute :max_connections

#max_latency_ms ⇒ Object?

Returns Ping time is monitored regularly. If a host has a ping time greater than I(max_latency_ms) it is excluded from the connection pool (although the server stays ONLINE). If omitted the proxysql database default for I(max_latency_ms) is 0.

Returns:

  • (Object, nil) —

    Ping time is monitored regularly. If a host has a ping time greater than I(max_latency_ms) it is excluded from the connection pool (although the server stays ONLINE). If omitted the proxysql database default for I(max_latency_ms) is 0.



43
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 43

attribute :max_latency_ms

#max_replication_lag ⇒ Object?

Returns If greater than 0, ProxySQL will reguarly monitor replication lag. If replication lag goes above I(max_replication_lag), proxysql will temporarily shun the server until replication catches up. If omitted the proxysql database default for I(max_replication_lag) is 0.

Returns:

  • (Object, nil) —

    If greater than 0, ProxySQL will reguarly monitor replication lag. If replication lag goes above I(max_replication_lag), proxysql will temporarily shun the server until replication catches up. If omitted the proxysql database default for I(max_replication_lag) is 0.



37
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 37

attribute :max_replication_lag

#port ⇒ Integer?

Returns The port at which the mysqld instance can be contacted.

Returns:

  • (Integer, nil) —

    The port at which the mysqld instance can be contacted.



20
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 20

attribute :port

#state ⇒ :present, ...

Returns When C(present) - adds the host, when C(absent) - removes the host.

Returns:

  • (:present, :absent, nil) —

    When C(present) - adds the host, when C(absent) - removes the host.



50
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 50

attribute :state

#status ⇒ :ONLINE, ...

Returns ONLINE - Backend server is fully operational. OFFLINE_SOFT - When a server is put into C(OFFLINE_SOFT) mode, connections are kept in use until the current transaction is completed. This allows to gracefully detach a backend. OFFLINE_HARD - When a server is put into C(OFFLINE_HARD) mode, the existing connections are dropped, while new incoming connections aren’t accepted either.rnIf omitted the proxysql database default for I(status) is C(ONLINE).

Returns:

  • (:ONLINE, :OFFLINE_SOFT, :OFFLINE_HARD, nil) —

    ONLINE - Backend server is fully operational. OFFLINE_SOFT - When a server is put into C(OFFLINE_SOFT) mode, connections are kept in use until the current transaction is completed. This allows to gracefully detach a backend. OFFLINE_HARD - When a server is put into C(OFFLINE_HARD) mode, the existing connections are dropped, while new incoming connections aren’t accepted either.rnIf omitted the proxysql database default for I(status) is C(ONLINE).



24
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 24

attribute :status

#use_ssl ⇒ Object?

Returns If I(use_ssl) is set to C(True), connections to this server will be made using SSL connections. If omitted the proxysql database default for I(use_ssl) is C(False).

Returns:

  • (Object, nil) —

    If I(use_ssl) is set to C(True), connections to this server will be made using SSL connections. If omitted the proxysql database default for I(use_ssl) is C(False).



40
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 40

attribute :use_ssl

#weight ⇒ Object?

Returns The bigger the weight of a server relative to other weights, the higher the probability of the server being chosen from the hostgroup. If omitted the proxysql database default for I(weight) is 1.

Returns:

  • (Object, nil) —

    The bigger the weight of a server relative to other weights, the higher the probability of the server being chosen from the hostgroup. If omitted the proxysql database default for I(weight) is 1.



28
 
# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_backend_servers.rb', line 28

attribute :weight