community.general.proxmox_pool_member 模块 – 从 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_member。

community.general 7.1.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

字符串 / 必需

指定用于身份验证的用户。

member

字符串 / 必需

指定成员名称。

对于 type=storage，它是存储名称。

对于 type=vm，可以使用 vmid 或虚拟机名称。

poolid

别名：name

字符串 / 必需

池 ID。

state

字符串

指示池成员的期望状态。

选项

  • "present" ← (默认)

  • "absent"

type

字符串

要从池中添加/删除的成员类型。

选项

  • "vm" ← (默认)

  • "storage"

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: Add new VM to Proxmox VE pool
  community.general.proxmox_pool_member:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    member: 101

- name: Add new storage to Proxmox VE pool
  community.general.proxmox_pool_member:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    member: zfs-data
    type: storage

- name: Remove VM from the Proxmox VE pool using VM name
  community.general.proxmox_pool_member:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    member: pxe.home.arpa
    state: absent

- name: Remove storage from the Proxmox VE pool
  community.general.proxmox_pool_member:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    member: zfs-storage
    type: storage
    state: absent

返回值

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

键

描述

member

字符串

成员名称。

已返回： 成功

示例： "101"

msg

字符串

有关模块所做操作的简短消息。

已返回： 始终

示例： "成员 101 已从 池 test 中删除"

poolid

字符串

池 ID。

已返回： 成功

示例： "test"

作者

  • Sergei Antipov (@UnderGreen)