W3cubDocs

/Ansible

community.proxysql.proxysql_info – Gathers information about proxysql server

Note

This plugin is part of the community.proxysql collection (version 1.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.proxysql.

To use it in a playbook, specify: community.proxysql.proxysql_info.

New in version 1.2.0: of community.proxysql

Synopsis

  • Gathers information about proxysql server.
  • Caution. The number of tables that returns, depends on the underlying proyxsql server version.

Requirements

The below requirements are needed on the host that executes this module.

  • PyMySQL
  • mysqlclient

Parameters

Parameter Choices/Defaults Comments
config_file
path
Default:
""
Specify a config file from which login_user and login_password are to be read.
login_host
string
Default:
"127.0.0.1"
The host used to connect to ProxySQL admin interface.
login_password
string
The password used to authenticate to ProxySQL admin interface.
login_port
integer
Default:
6032
The port used to connect to ProxySQL admin interface.
login_unix_socket
string
The socket used to connect to ProxySQL admin interface.
login_user
string
The username used to authenticate to ProxySQL admin interface.

Notes

Note

  • Supports check_mode.

Examples

- name: Receive information about proxysql setup
  community.proxysql.proxysql_info:
    login_user: admin
    login_password: admin

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
stdout
dictionary
Always
The number of tables that returns, depends on the underlying proyxsql server version.

Sample:
{'changed': False, 'failed': False, 'global_variables': {'description': 'Global variables of requested proxysql.', 'returned': 'Always', 'type': 'dict'}, 'tables': {'description': 'List of tables that exist in the requested proxysql version.', 'returned': 'Always', 'sample': ['global_variables', 'mysql_aws_aurora_hostgroups', 'mysql_collations', 'mysql_firewall_whitelist_rules', 'mysql_firewall_whitelist_sqli_fingerprints', 'mysql_firewall_whitelist_users', 'mysql_galera_hostgroups', 'mysql_group_replication_hostgroups', 'mysql_query_rules', 'mysql_query_rules_fast_routing', 'mysql_replication_hostgroups', 'mysql_servers', 'mysql_users', 'proxysql_servers', 'restapi_routes', 'runtime_checksums_values', 'runtime_global_variables', 'runtime_mysql_aws_aurora_hostgroups', 'runtime_mysql_firewall_whitelist_rules', 'runtime_mysql_firewall_whitelist_sqli_fingerprints', 'runtime_mysql_firewall_whitelist_users', 'runtime_mysql_galera_hostgroups', 'runtime_mysql_group_replication_hostgroups', 'runtime_mysql_query_rules', 'runtime_mysql_query_rules_fast_routing', 'runtime_mysql_replication_hostgroups', 'runtime_mysql_servers', 'runtime_mysql_users', 'runtime_proxysql_servers', 'runtime_restapi_routes', 'runtime_scheduler', 'scheduler'], 'type': 'list'}, 'version': {'description': 'Version of proxysql.', 'returned': 'Always', 'sample': {'full': '2.1.1-40-g1c2b7e4', 'major': 2, 'minor': 1, 'release': 1, 'suffix': 40}, 'type': 'dict'}}


Authors

  • Markus Bergholz (@markuman)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/proxysql/proxysql_info_module.html