Модуль community.dns.hetzner_dns_zone_info — Получение информации о зоне в службе Hetzner DNS

Примечание

Этот модуль является частью коллекции community.dns (версия 3.0.5).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.dns.

Чтобы использовать её в playbook, укажите: community.dns.hetzner_dns_zone_info.

Новое в community.dns 2.0.0

Описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Получает информацию о зоне в службе Hetzner DNS.

Параметры

Параметр	Комментарии
hetzner_token псевдонимы: api_token строка / обязательный	Токен для API Hetzner. Если не указан, будет считан из переменной окружения `HETZNER_DNS_TOKEN`.
zone_id строка добавлено в community.dns 0.2.0	Идентификатор зоны DNS для запроса. Должен быть указан ровно один из `zone_name` и `zone_id`.
zone_name псевдонимы: zone строка	Имя зоны DNS для запроса. Должен быть указан ровно один из `zone_name` и `zone_id`.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.dns.hetzner добавлено в community.dns 2.4.0	Используйте `group/community.dns.hetzner` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз состояния изменения без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Возвратит подробности о том, что изменилось (или, возможно, нужно изменить в `check_mode`), при режиме сравнения.

Примеры

- name: Retrieve details for foo.com zone
  community.dns.hetzner_dns_zone_info:
    zone: foo.com
    hetzner_token: access_token
  register: rec

- name: Retrieve details for zone 23
  community.dns.hetzner_dns_zone_info:
    zone_id: 23
    hetzner_token: access_token

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
zone_id строка	Идентификатор зоны. Возвращается: успешно Пример: `"23"`
zone_info словарь	Дополнительная информация, возвращаемая API. Возвращается: успешно
created строка	Время создания зоны. Возвращается: успешно Пример: `"2021-07-15T19:23:58Z"`
is_secondary_dns логическое значение	Указывает, является ли зона вторичной зоной DNS. Возвращается: успешно Пример: `true`
legacy_dns_host строка	Неизвестно. Возвращается: успешно
legacy_ns список / элементы=строка	Список серверов имен при импорте. Возвращается: успешно
modified строка	Время последнего изменения зоны. Возвращается: успешно Пример: `"2021-07-15T19:23:58Z"`
ns список / элементы=строка	Список серверов имен, которые должна иметь зона для использования DNS Hetzner. Возвращается: успешно
owner строка	Владелец зоны. Возвращается: успешно
paused логическое значение	Неизвестно. Возвращается: успешно Пример: `true`
permission строка	Разрешения зоны. Возвращается: успешно
project строка	Неизвестно. Возвращается: успешно
records_count целое число	Количество записей, связанных с этой зоной. Возвращается: успешно Пример: `0`
registrar строка	Неизвестно. Возвращается: успешно
status строка	Статус зоны. Может быть одним из `verified`, `failed` и `pending`. Возвращается: успешно Пример: `"verified"`
ttl целое число	TTL зоны. Возвращается: успешно Пример: `0`
txt_verification словарь	Форма записи TXT, которая должна быть установлена для проверки зоны. Если имя и токен пусты, запись TXT устанавливать не нужно. Возвращается: успешно Пример: `{"name": "", "token": ""}`
name строка	Имя записи TXT. Возвращается: успешно
token строка	Содержание записи TXT. Возвращается: успешно

END_OF_DOCUMENT_MARKER

verified string	Время проверки зоны. Возвращаемое значение: success Пример: `"2021-07-15T19:23:58Z"`
zone_name integer	Имя зоны. Возвращаемое значение: success Пример: `"example.com"`

Авторы

Markus Bergholz (@markuman)
Felix Fontein (@felixfontein)

Ссылки на коллекцию

© 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/community/dns/hetzner_dns_zone_info_module.html