openstack.cloud.image_info модуль — Получение изображений из сервиса OpenStack image (Glance).
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Для использования в книге задач укажите: openstack.cloud.image_info.
Описание
- Получение изображений из сервиса OpenStack image (Glance).
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Сколько времени должен ожидать уровень сокета, прежде чем истечёт время ожидания для вызовов API. Если это значение опущено, ничего не будет передано в библиотеку requests. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*. |
auth_type строка | Имя подключаемого модуля аутентификации для использования. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. |
ca_cert псевдонимы: cacert строка | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к клиенту сертификату, который будет использован в рамках транзакции SSL. |
client_key псевдонимы: key строка | Путь к ключу клиента, который будет использован в рамках транзакции SSL. |
cloud любой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные среды OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
filters псевдонимы: properties словарь | Словарь свойств изображений, используемых для запроса. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки, который нужно извлечь из каталога сервисов. Варианты:
|
name псевдонимы: image строка | Имя или ID изображения |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается. |
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs псевдонимы: verify булево | Должны ли запросы API SSL проверяться. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait булево | Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершён. Варианты:
|
Примечания
Примечание
- Стандартные переменные среды 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 |
Используется для привязки виртуальных ЦП (vCPUs) экземпляров к физическим ядрам ЦП (pCPUs) хоста. Возвращается: успешно |
|
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) для обеспечения доступа к блочным устройствам для вычислительных экземпляров. Возвращено: success |
|
hw_video_model string |
Используемый драйвер видеоадаптера. Возвращено: success |
|
hw_video_ram string |
Максимальный объем ОЗУ для видео. Возвращено: success |
|
hw_vif_model string |
Указывает модель используемого виртуального сетевого интерфейса. Возвращено: success |
|
hw_watchdog_action string |
Включает виртуальное устройство сторожевого таймера, которое выполняет указанное действие, если сервер зависает. Возвращено: success |
|
hypervisor_type string |
Тип гипервизора. Возвращено: success |
|
id string |
Уникальный UUID. Возвращено: success |
|
instance_type_rxtx_factor string |
Необязательное свойство позволяет созданным серверам иметь другой лимит пропускной способности, чем тот, который определен в сети, к которой они подключены. Возвращено: success |
|
instance_uuid string |
Для снимков это UUID сервера, использованного для создания этого образа. Возвращено: success |
|
boolean |
Управляет отображением образа в ответе списка образов по умолчанию. Возвращено: success |
|
boolean |
Включает меню загрузки BIOS. Возвращено: success |
|
is_hw_vif_multiqueue_enabled boolean |
Включает функцию virtio-net multiqueue. Возвращено: success |
|
is_protected boolean |
Флаг защиты образа. Возвращено: success |
|
kernel_id string |
ID образа, хранящегося в службе образов, который должен использоваться в качестве ядра при загрузке образа в стиле AMI. Возвращено: success |
|
locations string |
Список URL-адресов для доступа к файлу образа во внешнем хранилище. Возвращено: success |
|
metadata string |
Метаданные местоположения. Возвращено: success |
|
min_disk integer |
Минимальный объем дискового пространства, требуемый для этого образа. Возвращено: success |
|
min_ram integer |
Минимальный объем ОЗУ, требуемый для этого образа. Возвращено: success |
|
name string |
Имя, присвоенное образу. Возвращено: success |
|
needs_config_drive boolean |
Указывает, требуется ли образу диск конфигурации. Возвращено: success |
|
needs_secure_boot boolean |
Требуется ли безопасная загрузка. Возвращено: success |
|
os_admin_user string |
Имя пользователя администратора операционной системы. Возвращено: success |
|
os_command_line string |
Командная строка ядра, которая будет использоваться драйвером libvirt. Возвращено: success |
|
os_distro string |
Обычное имя дистрибутива операционной системы в нижнем регистре. Возвращено: success |
|
os_require_quiesce string |
Если true, требуется затишье при создании снимка через агент гостевой системы QEMU. Возвращено: success |
|
os_shutdown_timeout string |
Время для корректного завершения работы. Возвращено: success |
|
os_type string |
Установленная на образе операционная система. Возвращено: success |
|
os_version string |
Версия операционной системы, указанная дистрибутором. Возвращено: success |
|
owner string |
Владелец образа. Возвращено: success |
|
owner_id string |
Идентификатор владельца или проекта образа. Возвращено: success |
|
ramdisk_id string |
Идентификатор образа, хранящегося в службе образов, который должен использоваться в качестве RAM-диска при загрузке образа в стиле AMI. Возвращено: success |
|
schema string |
URL для схемы, описывающей образ виртуальной машины. Возвращено: success |
|
size integer |
Размер образа. Возвращено: success |
|
status string |
Статус образа. Возвращено: success |
|
store string |
Glance попытается сохранить данные дискового образа в хранилище, указанном значением заголовка. Возвращено: success |
|
tags list / elements=string |
Список тегов, назначенных образу Возвращено: success |
|
updated_at string |
Метка времени последнего обновления образа. Возвращено: success |
|
url string |
URL для доступа к файлу образа, хранящемуся во внешнем хранилище. Возвращено: success |
|
virtual_size string |
Виртуальный размер образа. Возвращено: success |
|
visibility string |
Указывает, кто имеет доступ к образу. Возвращено: success |
|
vm_mode string |
Режим виртуальной машины. Возвращено: success |
|
vmware_adaptertype string |
Виртуальный SCSI или IDE контроллер, используемый гипервизором. Возвращено: success |
|
vmware_ostype string |
Операционная система, установленная на образе. Возвращено: success |
Ссылки на коллекцию
© 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/openstack/cloud/image_info_module.html
