Модуль openstack.cloud.resources — список ресурсов облака OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.resources.
Краткое описание
- Список ресурсов облака OpenStack.
Требования
Следующие требования необходимы на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Время ожидания сокетного уровня перед истечением срока ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для используемой облаком стратегии плагина аутентификации. Для плагина password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им значения. Этот параметр не требуется, если указано именованное облако или доступны переменные окружения OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом изменить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при обмене данными SSL. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при обмене данными SSL. |
cloud any | Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она задаёт именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Параметр задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или доступны переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
parameters dictionary | Параметры запроса, передаваемые в API OpenStack для фильтрации результатов. attributes — это набор пар «ключ-значение», где ключом служит имя атрибута, например Полный список допустимых параметров запроса можно найти, открыв любой класс ресурсов в openstacksdk, например файл |
region_name string | Название региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся. |
service string / обязательный | Служба OpenStack, к которой относится этот ресурс. Например, service должно содержать |
timeout integer | Время ожидания Ansible запрошенного ресурса. По умолчанию: |
type string / обязательный | Название типа ресурса. Например, type должно содержать |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ожидать завершения обработки запрошенного ресурса. Варианты:
|
Примечания
Примечание
- Этот модуль поддерживает не все ресурсы облака OpenStack. Работа с ресурсами должна соответствовать структуре CRUD в openstacksdk и использовать функцию
<service>.<type>s. Если эту функцию не удаётся найти, модуль завершится с ошибкой. - Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно заданных параметров плейбука. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: List images
openstack.cloud.resources:
cloud: devstack-admin
service: image
type: image
register: images
- name: Identify CirrOS image id
set_fact:
image_id: "{{
images.resources|community.general.json_query(query)|first }}"
vars:
query: "[?starts_with(name, 'cirros')].id"
- name: List compute flavors
openstack.cloud.resources:
cloud: devstack-admin
service: compute
type: flavor
register: flavors
- name: Identify m1.tiny flavor id
set_fact:
flavor_id: "{{
flavors.resources|community.general.json_query(query)|first }}"
vars:
query: "[?name == 'm1.tiny'].id"
- name: List public network
openstack.cloud.resources:
cloud: devstack-admin
service: network
type: network
parameters:
name: public
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources list / elements=dictionary | Словарь с описанием обнаруженных ресурсов облака OpenStack. Возвращается: всегда |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/resources_module.html
