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。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：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

支持： 不适用

此操作不会修改状态。

当处于 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

列表 / 元素=字典

身份验证域列表。

返回: 总是返回，但可以为空

注释

字符串

域的简短描述。

返回: 成功时返回

摘要

字符串

域哈希值。

返回: 成功时返回，可以不存在

域

字符串

域名称。

返回: 成功时返回

类型

字符串

域类型。

返回: 成功时返回

作者

  • Tristan Le Guern (@tleguern)