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

Примечание

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

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

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

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

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

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

Создание или удаление пула в кластерах Proxmox VE.
Сведения об управлении участниками пула см. в модуле community.proxmox.proxmox_pool_member.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host строка / обязательный	Укажите целевой хост кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password строка	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port целое число	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout целое число	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id строка	Укажите ID токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret строка	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user строка / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path путь	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
comment строка	Укажите описание пула. Параметр игнорируется, если пул уже существует или `state=absent`.
poolid псевдонимы: name строка / обязательный	ID пула.
state строка	Задаёт требуемое состояние пула. Перед удалением пула с помощью `state=absent` он должен быть пустым. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Проверять 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	Поддержка: полная	Модуль может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Create new Proxmox VE pool
  community.proxmox.proxmox_pool:
    api_host: node1
    api_user: root@pam
    api_password: password
    poolid: test
    comment: 'New pool'

- name: Delete the Proxmox VE pool
  community.proxmox.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)

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

© 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_module.html