os_keystone_domain_facts – Получение фактов о домене OpenStack или нескольких домена
Новая в версии 2.1.
Обзор
- Получение фактов о домене или нескольких домене OpenStack
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
- sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. | |
| filters - | Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface - добавлено в 2.3 |
| Тип URL конечной точки для получения из каталога служб. псевдонимы: endpoint_type |
| key - | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name - | Имя или ID домена | |
| region_name - | Имя региона. | |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должен ожидать запрашиваемого ресурса. |
| verify boolean |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ожидать завершения запрашиваемого ресурса. |
Примечания
Примечание
- Могут быть использованы стандартные переменные окружения 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
Примеры
# Gather facts about previously created domain
- os_keystone_domain_facts:
cloud: awesomecloud
- debug:
var: openstack_domains
# Gather facts about a previously created domain by name
- os_keystone_domain_facts:
cloud: awesomecloud
name: demodomain
- debug:
var: openstack_domains
# Gather facts about a previously created domain with filter
- os_keystone_domain_facts:
cloud: awesomecloud
name: demodomain
filters:
enabled: False
- debug:
var: openstack_domains
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| openstack_domains сложный | всегда, но может быть null | содержит все факты OpenStack о доменах | |
| description строка | успех | Описание домена. | |
| enabled boolean | успех | Флаг, указывающий, включен ли домен. | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя домена. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Ricardo Carrillo Cruz (@rcarrillocruz)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/os_keystone_domain_facts_module.html