community.proxysql.proxysql_global_variables 模块 – 获取或设置 ProxySQL 全局变量

注意

此模块是 community.proxysql 集合 (版本 1.6.0) 的一部分。

如果您正在使用 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install community.proxysql。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在剧本中使用它,请指定:community.proxysql.proxysql_global_variables

概要

要求

执行此模块的主机需要以下要求。

  • PyMySQL

  • mysqlclient

参数

参数

注释

config_file

路径

指定一个配置文件,从中读取 *login_user* 和 *login_password*。

默认值: ""

load_to_runtime

布尔值

动态地将配置加载到运行时内存。

选项

  • false

  • true ← (默认值)

login_host

字符串

用于连接到 ProxySQL 管理界面的主机。

默认值: "127.0.0.1"

login_password

字符串

用于对 ProxySQL 管理界面进行身份验证的密码。

login_port

整数

用于连接到 ProxySQL 管理界面的端口。

默认值: 6032

login_unix_socket

字符串

用于连接到 ProxySQL 管理界面的套接字。

login_user

字符串

用于对 ProxySQL 管理界面进行身份验证的用户名。

save_to_disk

布尔值

将配置保存到磁盘上的 sqlite 数据库以持久化配置。

选项

  • false

  • true ← (默认值)

value

字符串

定义使用 *variable* 指定的变量应设置为的值。

variable

字符串 / 必需

定义应返回哪个变量,或者如果指定了 *value*,则定义应更新哪个变量。

备注

注意

  • 支持 check_mode

示例

---
# This example sets the value of a variable, saves the mysql admin variables
# config to disk, and dynamically loads the mysql admin variables config to
# runtime. It uses supplied credentials to connect to the proxysql admin
# interface.

- name: Set the value of a variable
  community.proxysql.proxysql_global_variables:
    login_user: 'admin'
    login_password: 'admin'
    variable: 'mysql-max_connections'
    value: 4096

# This example gets the value of a variable.  It uses credentials in a
# supplied config file to connect to the proxysql admin interface.

- name: Get the value of a variable
  community.proxysql.proxysql_global_variables:
    config_file: '~/proxysql.cnf'
    variable: 'mysql-default_query_delay'

返回值

常用的返回值已在 此处 记录,以下是此模块特有的字段

描述

stdout

字典

返回提供的 MySQL 变量及其关联的值。

返回: 返回当前变量和值,或为提供的变量设置的新值。

示例: {"changed": false, "msg": "The variable is already been set to the supplied value", "var": {"variable_name": "mysql-poll_timeout", "variable_value": "3000"}}

作者

  • Ben Mildren (@bmildren)