community.general.keyring_info 模块 – 使用操作系统的原生密钥环获取密码

注意

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

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

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

要在 playbook 中使用它，请指定：community.general.keyring_info。

community.general 5.2.0 中的新增功能

概要

  • 此模块使用 keyring Python 库，从操作系统的原生密钥环中检索给定服务和用户名的密码。

要求

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

  • keyring (Python 库)

  • gnome-keyring (应用程序 - 无头 Linux 密钥环访问需要)

  • dbus-run-session (应用程序 - 无头 Linux 密钥环访问需要)

参数

参数

注释

keyring_password

字符串 / 必需

用于解锁密钥环的密码。

service

字符串 / 必需

服务的名称。

username

字符串 / 必需

属于该服务的用户。

属性

属性

支持

描述

check_mode

支持: 完全

此操作不会修改状态。

可以在 check_mode 中运行，并返回已更改的状态预测，而不会修改目标。

diff_mode

支持: N/A

此操作不会修改状态。

当处于 diff 模式时，将返回有关已更改（或可能需要在 check_mode 中更改）的详细信息。

示例

- name: Retrieve password for service_name/user_name
  community.general.keyring_info:
    service: test
    username: test1
    keyring_password: "{{ keyring_password }}"
  register: test_password

- name: Display password
  ansible.builtin.debug:
    msg: "{{ test_password.passphrase }}"

返回值

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

键

描述

passphrase

字符串

包含密码的字符串。

返回: 成功，并且密码存在

示例: "Password123"

作者

  • Alexander Hussey (@ahussey-redhat)