Spec-Zone.ru › Ansible 2.4

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

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

  • Описание
  • Требования (для хоста, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Значения возврата
  • Примечания
    • Статус

Описание

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

Требования (для хоста, на котором выполняется модуль)

  • python >= 2.6
  • python >= 2.7
  • shade

Параметры

параметр обязателен по умолчанию возможные значения комментарии
api_timeout
нет None
Сколько времени должна ждать сокетная прослойка перед таймаутом вызовов API. Если это значение опущено, оно не будет передано в библиотеку requests.
auth
нет
Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля для авторизации облака. Для подключаемого модуля по умолчанию password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type
нет password
Имя подключаемого модуля для авторизации. Если облако использует что-то отличное от парольной авторизации, здесь должно быть указано имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone
нет
Игнорируется. Присутствует для обратной совместимости
cacert
нет None
Путь к пакету сертификатов CA, который может использоваться для проверки запросов SSL API.
cert
нет None
Путь к клиенту сертификату для использования в рамках транзакции SSL.
cloud
нет
Имя облака для работы с ним. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или если присутствуют переменные среды OpenStack OS_*.
endpoint_type
нет public
  • public
  • internal
  • admin
Тип URL конечной точки для извлечения из каталога служб.
image
да
Имя или идентификатор изображения
key
нет None
Путь к ключу клиента для использования в рамках транзакции SSL.
region_name
нет
Название региона.
timeout
нет 180
Сколько времени Ansible должно ждать запрашиваемый ресурс.
validate_certs
нет
Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True.
псевдонимы: verify
wait
нет yes
  • yes
  • no
Должен ли Ansible ждать, пока запрашиваемый ресурс будет завершен.

Примеры

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

- name: Show openstack facts
  debug:
    var: openstack_image

Значения возврата

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

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

Примечания

Примечание

  • Факты размещаются в переменной 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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимости.

Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация сообщества и участие, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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