Spec-Zone.ru › Ansible

Модуль openstack.cloud.image_info — получение образов из службы образов OpenStack (Glance).

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.image_info.

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

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

  • Получение образов из службы образов OpenStack (Glance).

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

Время ожидания сокетным уровнем до истечения времени ожидания вызовов API. Если значение не указано, в библиотеку requests ничего не передаётся.

auth

dictionary

Словарь со сведениями для аутентификации, необходимыми выбранной облачной стратегией плагина аутентификации. Для стандартного плагина password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, укажите здесь имя плагина и соответствующим образом обновите содержимое параметра auth.

ca_cert

псевдонимы: cacert

string

Путь к пакету сертификатов CA, который можно использовать для проверки запросов API по SSL.

client_cert

псевдонимы: cert

string

Путь к клиентскому сертификату, используемому при обмене данными по SSL.

client_key

псевдонимы: key

string

Путь к клиентскому ключу, используемому при обмене данными по SSL.

cloud

any

Именованное облако или конфигурация облака, с которыми нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Параметр задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.

filters

псевдонимы: properties

dictionary

Словарь свойств образов, используемых для запроса

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, который нужно получить из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

псевдонимы: image

string

Имя или идентификатор образа

region_name

string

Имя региона.

sdk_log_level

string

Уровень журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается

timeout

integer

Время ожидания запрошенного ресурса со стороны Ansible.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Следует ли проверять запросы API по SSL.

До Ansible 2.3 значение по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ожидать завершения подготовки запрошенного ресурса.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например OS_USERNAME.
  • Сведения для аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из YAML-файла конфигурации /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явных параметров плейбука. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Gather previously created image named image1
  openstack.cloud.image_info:
    cloud: devstack-admin
    image: image1

- name: List all images
  openstack.cloud.image_info:

- name: Retrieve and filter images
  openstack.cloud.image_info:
    filters:
      is_protected: False

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

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

Ключ

Описание

images

list / elements=dictionary

Список словарей с описанием соответствующих образов.

Возвращается: всегда

architecture

string

Архитектура процессора, которую должен поддерживать гипервизор.

Возвращается: при успешном выполнении

checksum

string

Контрольная сумма образа.

Возвращается: при успешном выполнении

container_format

string

Формат контейнера образа.

Возвращается: при успешном выполнении

created_at

string

Метка времени создания образа.

Возвращается: при успешном выполнении

direct_url

string

URL для доступа к файлу образа, хранящемуся во внешнем хранилище.

Возвращается: при успешном выполнении

disk_format

string

Формат диска образа.

Возвращается: при успешном выполнении

file

string

URL файла образа виртуальной машины.

Возвращается: при успешном выполнении

filters

dictionary

Дополнительные свойства, связанные с образом.

Возвращается: при успешном выполнении

has_auto_disk_config

boolean

Автоматически ли изменяется размер корневого раздела диска перед загрузкой экземпляра.

Возвращается: при успешном выполнении

hash_algo

string

Алгоритм, используемый для вычисления криптографического хеша данных образа.

Возвращается: при успешном выполнении

hash_value

string

Шестнадцатеричное представление криптографического хеша данных образа, вычисленного с помощью алгоритма, название которого указано в свойстве os_hash_algo.

Возвращается: при успешном выполнении

hw_cpu_cores

string

Используется для закрепления виртуальных процессоров (vCPU) экземпляров за физическими ядрами процессора (pCPU) хоста.

Возвращается: при успешном выполнении

hw_cpu_policy

string

Шестнадцатеричное представление криптографического хеша данных образа.

Возвращается: при успешном выполнении

hw_cpu_sockets

string

Предпочтительное число сокетов, отображаемых гостевой системе.

Возвращается: при успешном выполнении

hw_cpu_thread_policy

string

Определяет, как использовать аппаратные потоки процессора в архитектуре с одновременной многопоточностью (SMT).

Возвращается: при успешном выполнении

hw_cpu_threads

string

Предпочтительное число потоков, отображаемых гостевой системе.

Возвращается: при успешном выполнении

hw_disk_bus

string

Указывает тип контроллера диска, к которому подключаются дисковые устройства.

Возвращается: при успешном выполнении

hw_machine_type

string

Позволяет загрузить систему ARM, используя указанный тип машины.

Возвращается: при успешном выполнении

hw_qemu_guest_agent

string

Логическое значение в виде строки: если оно равно «true», для экземпляра будет доступен гостевой агент QEMU.

Возвращается: при успешном выполнении

hw_rng_model

string

Добавляет к экземплярам образа устройство генерации случайных чисел.

Возвращается: при успешном выполнении

hw_scsi_model

string

Включает использование VirtIO SCSI (virtio-scsi) для доступа вычислительных экземпляров к блочным устройствам.

Возвращается: при успешном выполнении

hw_video_model

string

Используемый видеодрайвер образа.

Возвращается: при успешном выполнении

hw_video_ram

string

Максимальный объем оперативной памяти для видеообраза.

Возвращается: при успешном выполнении

hw_vif_model

string

Указывает используемую модель устройства виртуального сетевого интерфейса.

Возвращается: при успешном выполнении

hw_watchdog_action

string

Включает виртуальное аппаратное устройство watchdog, выполняющее указанное действие при зависании сервера.

Возвращается: при успешном выполнении

hypervisor_type

string

Тип гипервизора.

Возвращается: при успешном выполнении

id

string

Уникальный UUID.

Возвращается: при успешном выполнении

instance_type_rxtx_factor

string

Необязательное свойство позволяет создавать серверы с ограничением пропускной способности, отличным от заданного для подключенной к ним сети.

Возвращается: при успешном выполнении

instance_uuid

string

Для образов-снимков это UUID сервера, использованного для создания образа.

Возвращается: при успешном выполнении

is_hidden

boolean

Определяет, отображается ли образ в ответе со списком образов по умолчанию.

Возвращается: при успешном выполнении

is_hw_boot_menu_enabled

boolean

Включает меню загрузки BIOS.

Возвращается: при успешном выполнении

is_hw_vif_multiqueue_enabled

boolean

Включает функцию virtio-net multiqueue.

Возвращается: при успешном выполнении

is_protected

boolean

Флаг защиты образа.

Возвращается: при успешном выполнении

kernel_id

string

Идентификатор образа, хранящегося в службе Image и используемого в качестве ядра при загрузке образа в стиле AMI.

Возвращается: при успешном выполнении

locations

string

Список URL для доступа к файлу образа во внешнем хранилище.

Возвращается: при успешном выполнении

metadata

string

Метаданные расположения.

Возвращается: при успешном выполнении

min_disk

integer

Минимальный объем дискового пространства, необходимый для этого образа.

Возвращается: при успешном выполнении

min_ram

integer

Минимальный объем ОЗУ, необходимый для этого образа.

Возвращается: при успешном выполнении

name

string

Имя, присвоенное образу.

Возвращается: при успешном выполнении

needs_config_drive

boolean

Указывает, требуется ли образу config drive.

Возвращается: при успешном выполнении

needs_secure_boot

boolean

Требуется ли безопасная загрузка (Secure Boot).

Возвращается: при успешном выполнении

os_admin_user

string

Имя пользователя-администратора операционной системы.

Возвращается: при успешном выполнении

os_command_line

string

Командная строка ядра, используемая драйвером libvirt.

Возвращается: при успешном выполнении

os_distro

string

Общепринятое название дистрибутива операционной системы в нижнем регистре.

Возвращается: при успешном выполнении

os_require_quiesce

string

Если значение равно true, при создании снимка требуется приостановить работу системы через гостевой агент QEMU.

Возвращается: при успешном выполнении

os_shutdown_timeout

string

Время, отведенное на корректное завершение работы.

Возвращается: при успешном выполнении

os_type

string

Операционная система, установленная в образе.

Возвращается: при успешном выполнении

os_version

string

Версия операционной системы, указанная разработчиком дистрибутива.

Возвращается: при успешном выполнении

owner

string

Владелец образа.

Возвращается: при успешном выполнении

owner_id

string

Идентификатор владельца или проекта, которому принадлежит образ.

Возвращается: при успешном выполнении

ramdisk_id

string

Идентификатор образа, хранящегося в службе Image и используемого в качестве ramdisk при загрузке образа в стиле AMI.

Возвращается: при успешном выполнении

schema

string

URL схемы, описывающей образ виртуальной машины.

Возвращается: при успешном выполнении

size

integer

Размер образа.

Возвращается: при успешном выполнении

status

string

Статус образа.

Возвращается: при успешном выполнении

store

string

Glance попытается сохранить данные образа диска в базовом хранилище, указанном значением заголовка.

Возвращается: при успешном выполнении

tags

list / elements=string

Список тегов, присвоенных образу

Возвращается: при успешном выполнении

updated_at

string

Метка времени обновления образа.

Возвращается: при успешном выполнении

url

string

URL для доступа к файлу образа, хранящемуся во внешнем хранилище.

Возвращается: при успешном выполнении

virtual_size

string

Виртуальный размер образа.

Возвращается: при успешном выполнении

visibility

string

Указывает, кто имеет доступ к образу.

Возвращается: при успешном выполнении

vm_mode

string

Режим виртуальной машины.

Возвращается: при успешном выполнении

vmware_adaptertype

string

Виртуальный контроллер SCSI или IDE, используемый гипервизором.

Возвращается: при успешном выполнении

vmware_ostype

string

Операционная система, установленная в образе.

Возвращается: при успешном выполнении

Авторы

  • OpenStack Ansible SIG

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

© 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/openstack/cloud/image_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API