Модуль openstack.cloud.dns_zone_info — получение информации о DNS-зонах
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: 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 (время жизни) в секундах. |
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_zone_info:
cloud: devstack
- name: Fetch DNS zones by name
openstack.cloud.dns_zone_info:
cloud: devstack
name: ansible.test.zone.
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
zones список / элементы=словарь | Словарь с описанием DNS-зон. Возвращается: при успешном выполнении, если state имеет значение |
|
action строка |
Текущее действие, выполняемое над ресурсом. Возвращается: при успешном выполнении Пример: |
|
attributes словарь |
Пары ключ-значение с информацией об этой зоне и пуле, в который пользователь хочет поместить зону. Планировщик может использовать эту информацию для размещения зон в соответствующем пуле. Возвращается: при успешном выполнении Пример: |
|
created_at строка |
Дата и время создания ресурса. Возвращается: при успешном выполнении Пример: |
|
description строка |
Описание этой зоны. Возвращается: при успешном выполнении Пример: |
|
строка |
Адрес электронной почты зоны. Используется в записях SOA зоны. Возвращается: при успешном выполнении Пример: |
|
id целое число |
Идентификатор ресурса. Возвращается: при успешном выполнении Пример: |
|
links словарь |
Ссылки на ресурс и другие связанные ресурсы. Если ответ разбит на страницы, будет включена ссылка next, по которой следует перейти для получения всех результатов. Возвращается: при успешном выполнении Пример: |
|
masters список / элементы=строка |
Серверы, с которых получают DNS-информацию в режиме ведомого сервера. Обязательный параметр для вторичных зон. Возвращается: при успешном выполнении Пример: |
|
name строка |
DNS-имя зоны. Возвращается: при успешном выполнении Пример: |
|
pool_id строка |
Идентификатор пула, в котором размещена эта зона. Возвращается: при успешном выполнении Пример: |
|
project_id строка |
Идентификатор проекта, которому принадлежит ресурс. Возвращается: при успешном выполнении Пример: |
|
serial целое число |
Текущий серийный номер зоны. Возвращается: при успешном выполнении Пример: |
|
status строка |
Состояние ресурса. Возвращается: при успешном выполнении Пример: |
|
ttl целое число |
TTL (время жизни) зоны. Возвращается: при успешном выполнении Пример: |
|
type строка |
Тип зоны. Зона PRIMARY управляется Designate, а зоны SECONDARY получают данные с другого DNS-сервера. По умолчанию используется PRIMARY. Возвращается: при успешном выполнении Пример: |
|
updated_at строка |
Дата и время последнего обновления ресурса. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/dns_zone_info_module.html