community.general.proxmox_pool_member модуль – Добавление или удаление членов из пулов кластера Proxmox VE

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.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	Укажите идентификатор токена. Требуется `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 строка / обязательно	Идентификатор пула.
state строка	Укажите желаемое состояние участника пула. Варианты: `"present"` ← (по умолчанию) `"absent"`
type строка	Тип участника для добавления/удаления из пула. Варианты: `"vm"` ← (по умолчанию) `"storage"`
validate_certs булево	Если `false`, SSL-сертификаты не будут проверяться. Это следует использовать только на лично контролируемых сайтах, использующих самозаверенные сертификаты. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.proxmox добавлено в community.general 9.0.0	Используйте `group/community.general.proxmox` в `module_defaults` для установки значений по умолчанию для этого модуля.
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 строка	Краткое сообщение о том, что сделал модуль. Возвращается: всегда Пример: `"Member 101 deleted from the pool test"`
poolid строка	ID пула. Возвращается: успешно Пример: `"test"`

Авторы

Сергей Антипов (@UnderGreen)

Ссылки на сборку

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