Модуль theforeman.foreman.image — управление образами

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.image.

Добавлено в theforeman.foreman 1.0.0

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

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

Создание, обновление и удаление образов

Псевдонимы: foreman_image

Требования

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

requests

Параметры

Параметр	Комментарии
architecture строка / обязательный	Архитектура образа
ca_path путь	Файл в формате PEM, содержащий сертификат CA, используемый для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_CA_PATH`.
compute_resource строка / обязательный	Вычислительный ресурс, которому назначен образ
image_password строка	Пароль для входа в операционную систему
image_username строка / обязательный	Имя пользователя для входа в операционную систему
name строка / обязательный	Имя образа
oauth1_consumer_key строка	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret строка	Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
operatingsystem строка / обязательный	Операционные системы ищутся по названию, составленному в формате «<name> <major>.<minor>». Можно опустить часть с версией, если операционная система с таким именем только одна.
password строка	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
server_url строка / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state строка	Состояние объекта Варианты: `"present"` ← (по умолчанию) `"absent"`
use_gssapi логический	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos с аутентификацией Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
user_data логический	Образ поддерживает user_data Варианты: `false` `true`
username строка	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
uuid псевдонимы: image_uuid строка / обязательный	UUID или URN Marketplace образа операционной системы
validate_certs логический	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме check_mode и возвращать прогноз статуса изменений без изменения объекта
diff_mode	Поддержка: полная	В режиме diff_mode будут возвращены сведения об изменениях (или о возможных изменениях в режиме check_mode)

Примеры

- name: create Image for EC2
  theforeman.foreman.image:
     name: CentOS
     image_uuid: "ami-0ff760d16d9497662"
     image_username: "centos"
     operatingsystem: "CentOS 7"
     compute_resource: "AWS"
     architecture: "x86_64"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
entity словарь	Итоговое состояние затронутых объектов, сгруппированных по типу. Возвращается: при успешном выполнении
images список / элементы=словарь	Список образов. Возвращается: при успешном выполнении

Авторы

Mark Hlawatschek (@hlawatschek) ATIX AG

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

© 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/theforeman/foreman/image_module.html