Модуль community.proxmox.proxmox_pool_member — добавление и удаление участников из пулов кластера Proxmox VE

Примечание

Этот модуль входит в коллекцию community.proxmox (версия 1.6.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.proxmox. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_pool_member.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание или удаление участника пула в кластерах Proxmox VE.

Требования

Следующие требования должны быть выполнены на узле, который выполняет этот модуль.

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой узел кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
member string / обязательный	Укажите имя участника. Для `type=storage` это имя хранилища. Для `type=vm` можно использовать vmid или имя ВМ.
poolid псевдонимы: name string / обязательный	Идентификатор пула.
state string	Укажите требуемое состояние участника пула. Варианты: `"present"` ← (по умолчанию) `"absent"`
type string	Тип участника, добавляемого в пул или удаляемого из него. Варианты: `"vm"` ← (по умолчанию) `"storage"`
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время значение по умолчанию — `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.proxmox.proxmox	Используйте `group/community.proxmox.proxmox` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: full	Модуль можно запускать в режиме `check_mode`; он вернёт прогнозируемый статус изменений, не изменяя целевую систему.
diff_mode	Поддержка: full	В режиме сравнения будут возвращены сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Add new VM to Proxmox VE pool
  community.proxmox.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.proxmox.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.proxmox.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.proxmox.proxmox_pool_member:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    member: zfs-storage
    type: storage
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
member string	Имя участника. Возвращается: success Пример: `"101"`
msg string	Краткое сообщение о выполненных модулем действиях. Возвращается: always Пример: `"Member 101 deleted from the pool test"`
poolid string	Идентификатор пула. Возвращается: success Пример: `"test"`

Авторы

Sergei Antipov (@UnderGreen)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/proxmox/proxmox_pool_member_module.html