community.general.proxmox_pool 模块 – Proxmox VE 集群的池管理

注意

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

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

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

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

community.general 7.1.0 中的新增功能

概要 

为 Proxmox VE 集群创建或删除池。
有关池成员管理，请查阅 community.general.proxmox_pool_member 模块。

要求 

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

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 字符串 / 必需	指定用于身份验证的用户。
comment 字符串	指定池的描述。当池已存在或 `state=absent` 时，将忽略此参数。
poolid 别名：name 字符串 / 必需	池 ID。
state 字符串	指示池的期望状态。必须先清空池，然后才能使用 `state=absent` 删除它。选项 `"present"` ←（默认） `"absent"`
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: Create new Proxmox VE pool
  community.general.proxmox_pool:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    comment: 'New pool'

- name: Delete the Proxmox VE pool
  community.general.proxmox_pool:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    state: absent

返回值 

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

键	描述
msg 字符串	关于模块执行的操作的简短消息。返回：始终示例： `"Pool test successfully created"`
poolid 字符串	池 ID。返回：成功示例： `"test"`

作者

Sergei Antipov (@UnderGreen)