community.general.proxmox_domain_info 模块 – 获取一个或多个 Proxmox VE 域的信息

注意

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

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

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

要在剧本中使用它，请指定：community.general.proxmox_domain_info。

community.general 1.3.0 中的新增功能

概要 

获取一个或多个 Proxmox VE 域的信息。

要求 

以下要求需要在执行此模块的主机上满足。

proxmoxer
requests

参数 

参数	注释
api_host 字符串 / 必需	指定 Proxmox VE 集群的目标主机。
api_password 字符串	指定用于身份验证的密码。您可以使用 `PROXMOX_PASSWORD` 环境变量。
api_port 整数在 community.general 9.1.0 中添加	指定 Proxmox VE 集群的目标端口。如果未指定，则使用 `PROXMOX_PORT` 环境变量。
api_token_id 字符串在 community.general 1.3.0 中添加	指定令牌 ID。需要 `proxmoxer>=1.1.0` 才能工作。
api_token_secret 字符串在 community.general 1.3.0 中添加	指定令牌密钥。需要 `proxmoxer>=1.1.0` 才能工作。
api_user 字符串 / 必需	指定用于身份验证的用户。
domain 别名：realm，name 字符串	将结果限制为特定的身份验证领域。
validate_certs 布尔值	如果 `false`，则不会验证 SSL 证书。这应该只在个人控制的使用自签名证书的站点上使用。选择 `false` ← （默认） `true`

属性 

属性	支持	描述
action_group	操作组： community.general.proxmox 在 community.general 9.0.0 中添加	在 `module_defaults` 中使用 `group/community.general.proxmox` 来为此模块设置默认值。
check_mode	支持：完整此操作不修改状态。	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改的状态预测。
diff_mode	支持： N/A 此操作不修改状态。	在 diff 模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: List existing domains
  community.general.proxmox_domain_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_domains

- name: Retrieve information about the pve domain
  community.general.proxmox_domain_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    domain: pve
  register: proxmox_domain_pve

返回值 

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

键	描述
proxmox_domains 列表 / 元素=字典	身份验证域的列表。返回：始终，但可以为空
comment 字符串	领域的简短描述。返回：成功时
digest 字符串	领域哈希。返回：成功时，可以不存在
realm 字符串	领域名称。返回：成功时
type 字符串	领域类型。返回：成功时

作者

Tristan Le Guern (@tleguern)