community.general.redis_data_info 模块 – 获取 Redis 数据库中键的值

注意

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

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

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

要在 playbook 中使用它,请指定:community.general.redis_data_info

community.general 3.7.0 中的新增功能

概要

  • 获取 Redis 数据库中键的值。

要求

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

  • redis

  • certifi

参数

参数

注释

ca_certs

字符串

根证书文件的路径。如果未设置且 tls 设置为 true,则将使用 certifi ca 证书。

client_cert_file

字符串

community.general 9.3.0 中新增

客户端证书文件的路径。

client_key_file

字符串

community.general 9.3.0 中新增

客户端私钥文件的路径。

key

字符串 / 必需

数据库键。

login_host

字符串

指定运行数据库的目标主机。

默认值: "localhost"

login_password

字符串

指定用于身份验证的密码。

目标为本地主机时通常不使用。

login_port

整数

指定要连接的端口。

默认值: 6379

login_user

字符串

指定用于身份验证的用户。

需要 redis >= 3.4.0。

tls

布尔值

指定是否使用 TLS 进行连接。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

指定是否验证 TLS 证书。

仅应针对个人控制的站点或目标为 localhost 时将其关闭。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持:完全支持

此操作不会修改状态。

可以在 check_mode 中运行,并在不修改目标的情况下返回更改状态预测。

diff_mode

支持: N/A

此操作不会修改状态。

处于差异模式时,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息。

备注

注意

另请参阅

另请参阅

community.general.redis_data

在 Redis 中设置键值对。

community.general.redis_data_incr

递增 Redis 中的键。

community.general.redis_info

收集有关 Redis 服务器的信息。

community.general.redis

各种 redis 命令,副本和刷新。

示例

- name: Get key foo=bar from loalhost with no username
  community.general.redis_data_info:
    login_host: localhost
    login_password: supersecret
    key: foo

- name: Get key foo=bar on redishost with custom ca-cert file
  community.general.redis_data_info:
    login_host: redishost
    login_password: supersecret
    login_user: somuser
    validate_certs: true
    ssl_ca_certs: /path/to/ca/certs
    key: foo

返回值

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

描述

exists

布尔值

如果键存在于数据库中。

返回值:成功时

msg

字符串

一条简短的消息。

返回值:始终返回

示例: "Got key: foo with value: bar"

value

字符串

键设置的值。

返回值:如果键存在

示例: "value_of_some_key"

作者

  • Andreas Botzner (@paginabianca)