os_image_facts – Получение фактов об изображении в OpenStack

Новая версия 2.0.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

Получение фактов об изображении из OpenStack.

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать сокетная часть перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина password по умолчанию он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 строка добавлен в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
region_name строка		Название региона.
timeout целое число	Значение по умолчанию: 180	Сколько времени Ansible должно ждать запрошенного ресурса.
validate_certs булево	Варианты: нет ← да	Должны ли запросы SSL API проверяться. До Ansible 2.3 это по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: нет да ←	Должен ли Ansible ждать, пока запрошенный ресурс будет завершен.

Примечания

Примечание

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

Примеры

- name: Gather facts about a previously created image named image1
  os_image_facts:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    image: image1

- name: Show openstack facts
  debug:
    var: openstack_image

# Show all available Openstack images
- name: Retrieve all available Openstack images
  os_image_facts:

- name: Show images
  debug:
    var: 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 строка	успех	Дата и время обновления изображения.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Davide Agnello (@dagnello)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_image_facts_module.html