openstack.cloud.dns_zone_info модуль – Получение информации о зонах DNS
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в playbook укажите: openstack.cloud.dns_zone_info.
Описание
- Получение информации о зонах DNS. Вывод может быть отфильтрован.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- 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, который может использоваться для проверки запросов SSL API. |
client_cert алиасы: cert строка | Путь к клиенту сертификата для использования в рамках транзакции SSL. |
client_key алиасы: key строка | Путь к ключу клиента для использования в рамках транзакции SSL. |
cloud любой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
description строка | Описание зоны. |
строка | Электронная почта владельца зоны Применимо только к первичным зонам. |
interface алиасы: endpoint_type строка | Тип URL конечной точки для извлечения из каталога сервисов. Выбори:
|
name строка | Имя зоны. |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень логирования OpenStackSDK Выбори:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан. |
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
ttl целое число | Значение TTL (Time To Live) в секундах. |
type строка | Тип зоны. Выбори:
|
validate_certs алиасы: verify булево | Нужно ли проверять запросы SSL API? До Ansible 2.3 это имело значение по умолчанию Выбори:
|
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: Fetch all DNS zones
openstack.cloud.dns_zones:
cloud: devstack
- name: Fetch DNS zones by name
openstack.cloud.dns_zones:
cloud: devstack
name: ansible.test.zone.
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
zones list / elements=dictionary | Словарь, описывающий зоны DNS. Возвращается: При успешном выполнении, когда state равен |
|
action string |
Текущее действие, выполняемое над ресурсом. Возвращается: успех Пример: |
|
attributes dictionary |
Пары «ключ-значение» информации об этой зоне и пуле, в который пользователь хотел бы поместить зону. Эта информация может использоваться планировщиком для размещения зон в правильном пуле. Возвращается: успех Пример: |
|
created_at string |
Дата и время создания ресурса. Возвращается: успех Пример: |
|
description string |
Описание этой зоны. Возвращается: успех Пример: |
|
string |
Электронная почта для зоны. Используется в записях SOA для зоны. Возвращается: успех Пример: |
|
id integer |
Идентификатор ресурса. Возвращается: успех Пример: |
|
links dictionary |
Ссылки на ресурс и другие связанные ресурсы. Когда ответ был разбит на страницы, мы включим следующую ссылку, которой следует следовать, чтобы получить все результаты. Возвращается: успех Пример: |
|
masters list / elements=string |
Серверы, с которых нужно получать информацию DNS. Обязательно для вторичных зон. Возвращается: успех Пример: |
|
name string |
DNS-имя зоны. Возвращается: успех Пример: |
|
pool_id string |
Идентификатор пула, на котором размещена эта зона. Возвращается: успех Пример: |
|
project_id string |
Идентификатор проекта, которому принадлежит ресурс. Возвращается: успех Пример: |
|
serial integer |
Текущий порядковый номер зоны. Возвращается: успех Пример: |
|
status string |
Статус ресурса. Возвращается: успех Пример: |
|
ttl integer |
TTL (время существования) для зоны. Возвращается: успех Пример: |
|
type string |
Тип зоны. PRIMARY управляется Designate, SECONDARY зоны являются подчиненными от другого DNS-сервера. По умолчанию PRIMARY. Возвращается: успех Пример: |
|
updated_at string |
Дата и время последнего обновления ресурса. Возвращается: успех Пример: |
Ссылки на сборку
© 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/dns_zone_info_module.html