Spec-Zone.ru › Ansible

Модуль community.dns.hetzner_dns_zone_info – получение сведений о зоне в службе Hetzner DNS

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.dns.

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

Новое в community.dns 2.0.0

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

Краткое описание

  • Получает сведения о зоне в службе Hetzner DNS.

Параметры

Параметр

Комментарии

hetzner_api_token

string

Токен для нового API Hetzner DNS.

Если не указан, будет получен из переменной окружения HETZNER_API_TOKEN.

Необходимо указать ровно один из параметров hetzner_token и hetzner_api_token.

hetzner_token

псевдонимы: api_token

string

Токен для классического API Hetzner DNS.

Если не указан, будет получен из переменной окружения HETZNER_DNS_TOKEN.

Необходимо указать ровно один из параметров hetzner_token и hetzner_api_token.

zone_id

string

добавлено в community.dns 0.2.0

Идентификатор DNS-зоны, сведения о которой нужно получить.

Необходимо указать ровно один из параметров zone_name и zone_id.

zone_name

псевдонимы: zone

string

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

Поддержка: Н/Д

Это действие не изменяет состояние.

В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в check_mode).

idempotent

Поддержка: полная

Это действие не изменяет состояние.

При повторном запуске с теми же аргументами вне режима проверки второй вызов сообщает об отсутствии изменений.

Предполагается, что система, которой управляет модуль или сведения о которой он получает, не изменилась существенным образом.

Примечания

Примечание

  • Обратите внимание: оба API поддерживают не все типы записей. Старый API (hetzner_token) не поддерживает записи HTTPS, PTR и SVCB. Новый API (hetzner_api_token) не поддерживает записи DANE.

Примеры

- 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

Возвращаемые значения

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

Ключ

Описание

zone_id

string

Идентификатор зоны.

Возвращается: при успешном выполнении

Пример: "23"

zone_info

dictionary

Дополнительные сведения, возвращаемые API.

Возвращается: при успешном выполнении

created

string

Время создания зоны.

Возвращается: при успешном выполнении

Пример: "2021-07-15T19:23:58Z"

is_secondary_dns

boolean

Указывает, является ли зона вторичной DNS-зоной.

Возвращается: при успешном выполнении

Пример: true

legacy_dns_host

string

Неизвестно.

Возвращается: если зона была импортирована

legacy_ns

list / элементы=string

Список серверов имён на момент импорта.

Возвращается: если зона была импортирована

modified

string

Время последнего изменения зоны.

Возвращается: при успешном выполнении

Пример: "2021-07-15T19:23:58Z"

ns

list / элементы=string

Список серверов имён, которые должны быть назначены зоне для использования DNS Hetzner.

Возвращается: при успешном выполнении

owner

string

Владелец зоны.

Возвращается: при успешном выполнении

paused

boolean

Неизвестно.

Возвращается: при успешном выполнении

Пример: true

permission

string

Разрешения для зоны.

Возвращается: при успешном выполнении

project

string

Неизвестно.

Возвращается: при успешном выполнении

records_count

integer

Количество записей, связанных с этой зоной.

Возвращается: при успешном выполнении

Пример: 0

registrar

string

Неизвестно.

Возвращается: при успешном выполнении

status

string

Статус зоны.

Возможные значения: verified, failed и pending.

Возвращается: при успешном выполнении

Пример: "verified"

ttl

integer

TTL зоны.

Возвращается: при успешном выполнении

Пример: 0

txt_verification

dictionary

Формат TXT-записи, которую необходимо добавить для проверки зоны.

Если имя и токен пусты, добавлять TXT-запись не требуется.

Возвращается: при успешном выполнении

Пример: {"name": "", "token": ""}

name

string

Имя TXT-записи.

Возвращается: при успешном выполнении

token

string

Содержимое TXT-записи.

Возвращается: при успешном выполнении

verified

string

Время проверки зоны.

Возвращается: при успешном выполнении

Пример: "2021-07-15T19:23:58Z"

zone_name

integer

Имя зоны.

Возвращается: при успешном выполнении

Пример: "example.com"

Авторы

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

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос (DNS)
  • Сообщить об ошибке
  • Предложить новую функцию
  • Связь с сообществом

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API