Модуль community.dns.hetzner_dns_record — добавление или удаление одной записи в службе Hetzner DNS

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.dns.hetzner_dns_record.

Добавлено в community.dns 2.0.0

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

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

Создает и удаляет отдельные записи DNS в службе Hetzner DNS.
Если вместо добавления или удаления значений требуется заменить их, следует изменить набор записей, а не отдельную запись. Это особенно важно при работе с записями CNAME и SOA. Для работы с наборами записей используйте модуль community.dns.hetzner_dns_record_set.
Записи сопоставляются по префиксу / имени записи и значению.

Параметры

Параметр	Комментарии
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`.
prefix string	Префикс записи DNS. Это часть `record` перед `zone_name`. Например, если изменяемая запись — `www.example.com` для зоны `example.com`, префикс — `www`. Если бы запись в этом примере была `example.com`, префиксом было бы `''` (пустая строка). Необходимо указать ровно один из параметров `record` и `prefix`.
record string	Полная запись DNS для создания или удаления. Необходимо указать ровно один из параметров `record` и `prefix`.
state string / обязательный	Задает состояние ресурсной записи. Варианты: `"present"` `"absent"`
ttl integer	TTL новой записи в секундах. Не используется при удалении записи.
txt_character_encoding string добавлено в community.dns 2.5.0	Определяет, следует ли обрабатывать числовые escape-последовательности (`\xyz`) как восьмеричные или десятичные числа. Используется только при `txt_transformation=quoted`. В community.dns 3.0.0 значение по умолчанию изменено на `decimal`. Ранее значением по умолчанию было `octal`. Значение `decimal` совместимо с RFC 1035. Варианты: `"decimal"` ← (по умолчанию) `"octal"`
txt_transformation string	Определяет, как значения записей TXT преобразуются между API и входными и выходными данными этого модуля. Значение `api` означает, что модуль возвращает значения в том виде, в котором их возвращает API, и передает в API в том виде, в котором они были переданы модулю. При проверке идемпотентности входная строка сравнивается со строками, возвращенными API. API может автоматически преобразовывать некоторые значения, например разбивать длинные значения или добавлять кавычки, что может привести к проблемам с идемпотентностью. Значение `unquoted` автоматически преобразует значения: можно передавать значения без кавычек, и модуль будет возвращать их без кавычек. Переданные в кавычках значения будут заключены в двойные кавычки. Значение `quoted` автоматически преобразует значения так, чтобы кавычки требовались для значений, содержащих пробелы, символы вроде кавычек и обратных косых черт, а также для значений длиной более 255 байт. Кроме того, оно обеспечивает возврат значений API в нормализованной кодировке. Значение по умолчанию, `unquoted`, позволяет работать со значениями, не беспокоясь о правильном заключении в кавычки для DNS. Большинству пользователей следует использовать `unquoted` или `quoted`, но не `api`. Примечание: код преобразования предполагает, что значения закодированы в UTF-8. Если требуется другая кодировка, используйте `txt_transformation=api` и обрабатывайте кодировку самостоятельно. Варианты: `"api"` `"quoted"` `"unquoted"` ← (по умолчанию)
type string / обязательный	Тип записи DNS для создания или удаления. Варианты: `"A"` `"AAAA"` `"CAA"` `"CNAME"` `"DANE"` `"DS"` `"HINFO"` `"HTTPS"` `"MX"` `"NS"` `"PTR"` `"RP"` `"SOA"` `"SRV"` `"SVCB"` `"TLSA"` `"TXT"`
value string / обязательный	Новое значение при создании записи DNS. При удалении записи необходимо указать все ее значения, иначе она не будет удалена.
zone_id string	Идентификатор изменяемой зоны 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.
Для записей CNAME используйте в значениях абсолютные имена DNS. Абсолютные имена DNS заканчиваются точкой ., например foo.example.com.. Если использовать относительное имя DNS без завершающей точки, значение будет относительным к зоне записи CNAME.

См. также

Поддерживаемые записи DNS: Дополнительные сведения о поддерживаемых типах записей DNS.

Примеры

- name: Add a new.foo.com A record
  community.dns.hetzner_dns_record:
    state: present
    zone: foo.com
    record: new.foo.com
    type: A
    ttl: 7200
    value: 1.1.1.1
    hetzner_token: access_token

- name: Add A record using prefix for www.example.com
  community.dns.hetzner_dns_record:
    state: present
    zone_name: example.com
    prefix: www
    type: A
    value: 198.51.100.25
    hetzner_token: "{{ lookup('env', 'HETZNER_DNS_TOKEN') }}"

- name: Remove a new.foo.com A record
  community.dns.hetzner_dns_record:
    state: absent
    zone_name: foo.com
    record: new.foo.com
    type: A
    ttl: 7200
    value: 2.2.2.2
    hetzner_token: access_token

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

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

Ключ	Описание
zone_id string	Идентификатор зоны. Возвращается: при успешном выполнении Пример: `"23"`

Авторы

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

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

© 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_record_module.html