Модуль community.proxmox.proxmox_template — управление шаблонами ОС в кластере Proxmox VE

Примечание

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

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

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

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

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

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

Позволяет загружать и удалять шаблоны в кластере 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`.
checksum string	Контрольная сумма для проверки. Поставщики программного обеспечения часто предоставляют контрольные суммы, чтобы подтвердить, что загруженный файл не повреждён. Контрольные суммы обычно можно найти на странице загрузки поставщика в виде файла или строки. Если параметр указан, необходимо также указать `checksum_algorithm`.
checksum_algorithm string	Алгоритм, используемый для проверки контрольной суммы. Если параметр указан, необходимо также указать `checksum`. Варианты: `"md5"` `"sha1"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
content_type string	Тип содержимого шаблона. Допустимые значения: `vztmpl` для шаблонов контейнеров LXC, `iso` для образов дисков ISO и `import` для образов жёстких дисков и Open Virtual Appliances (OVA). Варианты: `"vztmpl"` ← (по умолчанию) `"import"` `"iso"`
force boolean	Можно использовать только с `state=present`; существующий шаблон будет перезаписан. Варианты: `false` ← (по умолчанию) `true`
node string	Узел Proxmox VE, на котором выполняются операции.
src path	Путь к загружаемому файлу. Для `state=present` требуется указать ровно один из параметров: `src` или `url`.
state string	Задайте требуемое состояние шаблона. Варианты: `"present"` ← (по умолчанию) `"absent"`
storage string	Целевое хранилище. По умолчанию: `"local"`
template string	Имя шаблона. Обязательно для `state=absent` при удалении шаблона. Обязательно для `state=present` при загрузке шаблона контейнера appliance (pveam).
timeout integer	Тайм-аут операций. По умолчанию: `30`
url string	URL-адрес файла для загрузки. Для `state=present` требуется указать ровно один из параметров: `src` или `url`.
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	Поддержка: none	Может выполняться в режиме `check_mode` и возвращать прогноз изменения статуса без изменения целевого узла.
diff_mode	Поддержка: none	В режиме diff будут возвращены подробные сведения об изменениях (или о возможных необходимых изменениях в `check_mode`).

Примечания

Примечание

На узле требуются модули proxmoxer и requests. Их можно установить с помощью ansible.builtin.pip.
Для загрузки файлов размером более 256 МБ требуется requests_toolbelt.

Примеры

---
- name: Upload new openvz template with minimal options
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    src: ~/ubuntu-14.04-x86_64.tar.gz

- name: Pull new openvz template with minimal options
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    url: https://ubuntu-mirror/ubuntu-14.04-x86_64.tar.gz

- name: >
    Upload new openvz template with minimal options use environment
    PROXMOX_PASSWORD variable(you should export it before)
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_host: node1
    src: ~/ubuntu-14.04-x86_64.tar.gz

- name: Upload new openvz template with all options and force overwrite
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    storage: local
    content_type: vztmpl
    src: ~/ubuntu-14.04-x86_64.tar.gz
    force: true

- name: Pull new openvz template with all options and force overwrite
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    storage: local
    content_type: vztmpl
    url: https://ubuntu-mirror/ubuntu-14.04-x86_64.tar.gz
    force: true

- name: Delete template with minimal options
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    template: ubuntu-14.04-x86_64.tar.gz
    state: absent

- name: Download proxmox appliance container template
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    storage: local
    content_type: vztmpl
    template: ubuntu-20.04-standard_20.04-1_amd64.tar.gz

- name: Download and verify a template's checksum
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    url: ubuntu-20.04-standard_20.04-1_amd64.tar.gz
    checksum_algorithm: sha256
    checksum: 65d860160bdc9b98abf72407e14ca40b609417de7939897d3b58d55787aaef69

- name: Upload new disk image template with minimal options
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    content_type: import
    src: debian-13-genericcloud-amd64.qcow2

- name: Upload new ISO with minimal options
  community.proxmox.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    content_type: iso
    src: proxmox.iso

Авторы

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_template_module.html