openstack.cloud.os_image_info – Получение информации об изображении в OpenStack.

Примечание

Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в книге задач, укажите: openstack.cloud.os_image_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получение информации об изображении из OpenStack.
Этот модуль назывался openstack.cloud.image_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль openstack.cloud.image_info больше не возвращает ansible_facts!

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ожидать сетевая часть, прежде чем прервать вызов API из-за истечения времени. Если это опущено, библиотеке запросов ничего не будет передано.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного плагина password в него входят auth_url, username, password, project_name и любая информация о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, требуемые этим плагином. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка		Имя плагина авторизации, который следует использовать. Если облако использует что-то помимо аутентификации по паролю, здесь следует указать имя плагина, и содержимое параметра auth следует обновить соответствующим образом.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету CA-сертификата, который можно использовать при проверке запросов SSL API. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификату, который будет использоваться в ходе SSL-транзакции. псевдонимы: cert
client_key строка		Путь к клиенту ключу, который будет использоваться в ходе SSL-транзакции. псевдонимы: key
cloud сырой		Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
image строка		Имя или идентификатор изображения
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога услуг. псевдонимы: endpoint_type
properties словарь		Словарь свойств изображений, используемых для запроса
region_name строка		Имя региона.
timeout целое число	Значение по умолчанию: 180	Сколько времени ansible должно ждать запрошенного ресурса.
validate_certs логическое	Варианты: нет ← да	Выполнять ли проверку запросов SSL API. До Ansible 2.3 по умолчанию было `yes`. псевдонимы: verify
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 information about a previously created image named image1
  openstack.cloud.image_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    image: image1
  register: result

- name: Show openstack information
  debug:
    msg: "{{ result.openstack_image }}"

# Show all available Openstack images
- name: Retrieve all available Openstack images
  openstack.cloud.image_info:
  register: result

- name: Show images
  debug:
    msg: "{{ result.openstack_image }}"

# Show images matching requested properties
- name: Retrieve images having properties with desired values
  openstack.cloud.image_facts:
    properties:
      some_property: some_value
      OtherProp: OtherVal

- name: Show images
  debug:
    msg: "{{ result.openstack_image }}"

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

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

Ключ		Возвращаемое значение	Описание
openstack_image сложный		всегда, но может быть пусто	содержит всю информацию OpenStack об изображении
	checksum строка	успех	Контрольная сумма изображения.
	container_format строка	успех	Формат контейнера изображения.
	created_at строка	успех	Дата и время создания изображения.
	deleted логическое	успех	Флаг удаления изображения.
	deleted_at строка	успех	Дата и время удаления изображения.
	disk_format строка	успех	Формат диска изображения.
	id строка	успех	Уникальный UUID.
	is_public логическое	успех	Флаг публичности изображения.
	min_disk целое число	успех	Минимальный объем места на диске, требуемый для этого изображения.
	min_ram целое число	успех	Минимальный объем оперативной памяти, требуемый для этого изображения.
	name строка	успех	Имя, присвоенное изображению.
	owner строка	успех	Владелец изображения.
	properties словарь	успех	Дополнительные свойства, связанные с изображением.
	protected логическое	успех	Флаг защиты изображения.
	size целое число	успех	Размер изображения.
	status строка	успех	Статус изображения.
	updated_at строка	успех	Дата и время обновления изображения.

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_image_info_module.html