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	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 `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)