community.general.proxmox_pool модуль — Управление пулами для кластера Proxmox VE

Примечание

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

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

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

Для использования в книге задач укажите: 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	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлено в community.general 1.3.0	Укажите секрет токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательный	Укажите пользователя для аутентификации.
comment строка	Укажите описание пула. Параметр игнорируется, если пул уже существует или `state=absent`.
poolid алиасы: name строка / обязательный	Идентификатор пула.
state строка	Укажите желаемое состояние пула. Пул должен быть пустым перед удалением с помощью `state=absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
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	Поддержка: отсутствует	Возвращает подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`), когда режим diff включен.

Примеры

- 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"`

Авторы

Сергей Антипов (@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_module.html