os_image_info – Получение информации об изображении в OpenStack
Обзор
- Получение информации об изображении из OpenStack.
- Этот модуль назывался
os_image_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль os_image_info больше не возвращаетansible_facts!
Псевдонимы: os_image_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- 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 строка |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| properties словарь добавлено в 2.9 | Словарь свойств изображений, используемых для запроса | |
| region_name строка | Имя региона. | |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| validate_certs логическое |
| Требуется ли проверка SSL-API-запросов. До Ansible 2.3 это значение по умолчанию было yes.Псевдонимы: verify |
| wait логическое |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Gather information about a previously created image named image1
os_image_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
image: image1
register: result
- name: Show openstack information
debug:
msg: "{{ result.openstack_image }}"
# Show all available Openstack images
- name: Retrieve all available Openstack images
os_image_info:
register: result
- name: Show images
debug:
msg: "{{ result.openstack_image }}"
# Show images matching requested properties
- name: Retrieve images having properties with desired values
os_image_facts:
properties:
some_property: some_value
OtherProp: OtherVal
- name: Show images
debug:
msg: "{{ result.openstack_image }}"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| openstack_image complex | всегда, но может быть null | Содержит всю информацию об изображении OpenStack. | |
| checksum string | успех | Контрольная сумма изображения. | |
| container_format string | успех | Формат контейнера изображения. | |
| created_at string | успех | Дата и время создания изображения. | |
| deleted boolean | успех | Флаг удаления изображения. | |
| deleted_at string | успех | Дата и время удаления изображения. | |
| disk_format string | успех | Формат диска изображения. | |
| id string | успех | Уникальный UUID. | |
| is_public boolean | успех | Флаг публичности изображения. | |
| min_disk integer | успех | Минимальный объем памяти на диске, требуемый для этого изображения. | |
| min_ram integer | успех | Минимальный объем оперативной памяти, требуемый для этого изображения. | |
| name string | успех | Имя, присвоенное изображению. | |
| owner string | успех | Владелец изображения. | |
| properties dictionary | успех | Дополнительные свойства, связанные с изображением. | |
| protected boolean | успех | Флаг защиты изображения. | |
| size integer | успех | Размер изображения. | |
| status string | успех | Статус изображения. | |
| updated_at string | успех | Дата и время обновления изображения. | |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается сообществом 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.9/modules/os_image_info_module.html