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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.general.proxmox_template.

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

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

позволяет загружать/удалять шаблоны в кластере 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	Укажите ID токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлено в community.general 1.3.0	Укажите секретный ключ токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательно	Укажите пользователя для аутентификации.
content_type строка	Тип контента. Требуется только для `state=present`. Варианты: `"vztmpl"` ← (по умолчанию) `"iso"`
force логическое значение	Может использоваться только с `state=present`, существующий шаблон будет перезаписан. Варианты: `false` ← (по умолчанию) `true`
node строка	Узел Proxmox VE, на котором нужно выполнить операцию.
src путь	Путь к загружаемому файлу. Требуется только для `state=present`.
state строка	Указывает желаемое состояние шаблона. Варианты: `"present"` ← (по умолчанию) `"absent"`
storage строка	Целевое хранилище. По умолчанию: `"local"`
template строка	Имя шаблона. Требуется для `state=absent` для удаления шаблона. Требуется для `state=present` для загрузки шаблона контейнера приложения (pveam).
timeout целое число	Таймаут для операций. По умолчанию: `30`
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.

Примечания

Примечание

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

Примеры

- name: Upload new openvz template with minimal options
  community.general.proxmox_template:
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    src: ~/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.general.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.general.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: Delete template with minimal options
  community.general.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.general.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

Авторы

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