os_image_facts - Получение фактов об изображении в OpenStack.
Новое в версии 2.0.
Обзор
- Получение фактов об изображении из OpenStack.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ждать подсистема сокетов, прежде чем истечёт время ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации, который нужно использовать. Если облако использует что-то помимо аутентификации по паролю, здесь следует указать имя плагина, и содержимое параметра auth следует соответствующим образом обновить. | |
| availability_zone | Игнорируется. Присутствует для обеспечения обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать при проверке запросов API SSL. | |
| cert | Путь к клиенту сертификат, который следует использовать в рамках транзакции SSL. | |
| cloud | Имя облака или конфигурация облака, с которой работать. Если cloud является строкой, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| image | Имя или идентификатор изображения | |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| region_name | Имя региона. | |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify bool |
| Выполнять ли проверку запросов API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли 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 сложный | всегда, но может быть null | содержит все факты OpenStack об изображении | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя, присвоенное изображению. | |
| status строка | успех | Статус изображения. | |
| created_at строка | успех | Дата и время создания изображения. | |
| deleted логическое значение | успех | Флаг удаления изображения. | |
| container_format строка | успех | Формат контейнера изображения. | |
| min_ram целое число | успех | Минимальный объём оперативной памяти, требуемый для этого изображения. | |
| disk_format строка | успех | Формат диска изображения. | |
| updated_at строка | успех | Дата и время обновления изображения. | |
| properties словарь | успех | Дополнительные свойства, связанные с изображением. | |
| min_disk целое число | успех | Минимальный объём дискового пространства, требуемый для этого изображения. | |
| protected логическое значение | успех | Флаг защиты изображения. | |
| checksum строка | успех | Контрольная сумма для изображения. | |
| owner строка | успех | Владелец изображения. | |
| is_public логическое значение | успех | Флаг публичности изображения. | |
| deleted_at строка | успех | Дата и время удаления изображения. | |
| size целое число | успех | Размер изображения. | |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/os_image_facts_module.html
