os_image_facts - Получение фактов об изображении в OpenStack.
Новое в версии 2.0.
Обзор
- Получение фактов об изображении из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Время ожидания сокета при таймауте вызовов API. Если этот параметр опущен, в библиотеку requests ничего не будет передано. | |
| 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 |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Должен ли 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| openstack_image сложный | всегда, но может быть null | содержит все факты OpenStack об изображении | |
| status строка | success | Статус изображения. | |
| deleted логическое | success | Флаг удалённого изображения. | |
| container_format строка | success | Формат контейнера изображения. | |
| min_ram целое число | success | Минимальное количество оперативной памяти, необходимое для этого изображения. | |
| updated_at строка | success | Отметка времени последнего обновления изображения. | |
| min_disk целое число | success | Минимальный объем дискового пространства, необходимый для этого изображения. | |
| owner строка | success | Владелец изображения. | |
| is_public логическое | success | Флаг общедоступности изображения. | |
| deleted_at строка | success | Отметка времени удаления изображения. | |
| properties словарь | success | Дополнительные свойства, связанные с изображением. | |
| size целое число | success | Размер изображения. | |
| name строка | success | Имя, присвоенное изображению. | |
| checksum строка | success | Контрольная сумма изображения. | |
| created_at строка | success | Отметка времени создания изображения. | |
| disk_format строка | success | Формат диска изображения. | |
| id строка | success | Уникальный UUID. | |
| protected логическое | success | Флаг защиты изображения. | |
Статус
Этот модуль помечен как preview, что означает, что гарантии обратной совместимости нет.
Автор
- 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.5/modules/os_image_facts_module.html