os_keystone_domain_facts – Получение фактов о домене OpenStack
Новая версия 2.1.
Описание
- Получение фактов о домене OpenStack
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
- sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, который может использоваться для проверки запросов API SSL. Псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату, который будет использоваться в рамках SSL транзакции. Псевдонимы: cert | |
| client_key строка | Путь к клиенту ключу, который будет использоваться в рамках SSL транзакции. Псевдонимы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, аналогичную той, что содержится в разделе clouds.yaml. | |
| filters - | Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface строка добавлен в 2.3 |
| Тип URL конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| name - | Имя или ID домена | |
| region_name строка | Имя региона. | |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| validate_certs булево |
| Необходимо ли проверять запросы API SSL. До 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/
Примеры
# 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 сложное | всегда, но может быть пустым | Содержит все факты OpenStack о домене | |
| description строка | успех | Описание домена. | |
| enabled булево | успех | Флаг, указывающий, активирован ли домен. | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя, данное домену. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/os_keystone_domain_facts_module.html
