openstack.cloud.resources модуль – Список ресурсов облака OpenStack
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.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 целое число | Сколько времени должна ждать сетевая прослойка, прежде чем прервать вызов API. Если этот параметр опущен, библиотека requests не получит никаких данных. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. |
auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь должно быть указано имя подключаемого модуля, а содержимое параметра auth должно быть соответствующим образом обновлено. |
ca_cert псевдонимы: cacert строка | Путь к пакету сертификатов CA, который может быть использован для проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к клиенту сертификат для использования в рамках SSL-транзакции. |
client_key псевдонимы: key строка | Путь к клиенту ключу для использования в рамках SSL-транзакции. |
cloud любой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки, который нужно получить из каталога служб. Варианты:
|
parameters словарь | Параметры запроса, передаваемые в API OpenStack для фильтрации результатов. attributes — набор пар «ключ-значение», где каждый ключ — имя атрибута, например Полный список допустимых параметров запроса можно найти, открыв любой класс ресурсов внутри openstacksdk, например, файл |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается. |
service строка / обязательно | Служба OpenStack, к которой относится этот ресурс. Примерами являются service должно быть именем службы OpenStack, используемой в openstacksdk. Список доступных служб можно найти на странице https://opendev.org/openstack/openstacksdk: большинство подкаталогов в каталоге |
timeout целое число | Сколько времени Ansible должно ждать запрашиваемый ресурс. По умолчанию: |
type строка / обязательно | Имя типа ресурса. Примерами являются type должно быть именем класса ресурса openstacksdk. Классы ресурсов определены в папках служб openstacksdk. Например, перейдите на https://opendev.org/openstack/openstacksdk, перейдите в каталог |
validate_certs псевдонимы: verify булево | Должны ли проверяться запросы 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 список / элементы=словарь | Словарь, описывающий идентифицированные ресурсы облака OpenStack. Возвращаемое значение: всегда |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/resources_module.html
