Spec-Zone.ru › Ansible 2.7

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

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

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

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

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

Требования

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

  • openstacksdk
  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_timeout
-
Сколько времени должно ждать сокетное соединение перед таймаутом для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth
-
Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако её поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые данному подключаемому модулю. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type
-
Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной авторизации, здесь должно быть указано имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone
-
Игнорируется. Присутствует для обратной совместимости.
cacert
-
Путь к пакету сертификатов CA, который может использоваться для проверки SSL-API-запросов.
cert
-
Путь к клиенту сертификату для использования в рамках SSL-транзакции.
cloud
-
Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
image
-
Имя или идентификатор изображения.
interface
-
добавлено в 2.3
    Варианты:
  • public ←
  • internal
  • admin
Тип URL-адреса конечной точки для извлечения из каталога услуг.

Псевдонимы: endpoint_type
key
-
Путь к ключу клиента для использования в рамках SSL-транзакции.
region_name
-
Имя региона.
timeout
-
По умолчанию:
180
Сколько времени Ansible должно ждать запрошенного ресурса.
verify
boolean
    Варианты:
  • no
  • yes
Должны ли SSL-API-запросы проверяться. До версии 2.3 по умолчанию было True.

Псевдонимы: validate_certs
wait
boolean
    Варианты:
  • no
  • yes ←
Должен ли Ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

  • Факты размещаются в переменной openstack.
  • Стандартные переменные окружения OpenStack, такие как OS_USERNAME, могут использоваться вместо явных значений.
  • Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем из явных параметров в задачах. Более подробная информация доступна по адресу http://docs.openstack.org/developer/os-client-config

Примеры

- 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
complex
всегда, но может быть null
содержит все факты OpenStack об изображении

checksum
строка
успех
Контрольная сумма изображения.

container_format
строка
успех
Формат контейнера изображения.

created_at
строка
успех
Дата и время создания изображения.

deleted
boolean
успех
Флаг удаления изображения.

deleted_at
строка
успех
Дата и время удаления изображения.

disk_format
строка
успех
Формат диска изображения.

id
строка
успех
Уникальный UUID.

is_public
boolean
успех
Флаг публичности изображения.

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

min_ram
целое число
успех
Минимальный объем оперативной памяти, необходимый для данного изображения.

name
строка
успех
Имя, присвоенное изображению.

owner
строка
успех
Владелец изображения.

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

protected
boolean
успех
Флаг защиты изображения.

size
целое число
успех
Размер изображения.

status
строка
успех
Статус изображения.

updated_at
строка
успех
Дата и время обновления изображения.



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.7/modules/os_image_facts_module.html

Spec-Zone.ru

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