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

Примечание

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

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

Для использования в книге задач укажите: openstack.cloud.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 строка		Имя или ID изображения
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
properties словарь		Словарь свойств изображений, используемых для запроса.
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должен ждать запрошенного ресурса.
validate_certs логический	Варианты: нет ← да	Должны ли проверяться запросы API SSL. До 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/image_info_module.html