Модуль community.dns.hetzner_dns_record – Добавление или удаление одной записи в службе 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_record.

Новое в community.dns 2.0.0

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

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

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

Параметры

Параметр	Комментарии
hetzner_token псевдонимы: api_token строка / обязательно	Токен для API Hetzner. Если не указан, будет считан из переменной окружения `HETZNER_DNS_TOKEN`.
prefix строка	Префикс записи DNS. Это часть `record` перед `zone_name`. Например, если запись, которую нужно изменить, это `www.example.com` для зоны `example.com`, префикс – `www`. Если запись в этом примере была бы `example.com`, префикс был бы `''` (пустая строка). Должен быть указан ровно один из `record` и `prefix`.
record строка	Полная запись DNS для создания или удаления. Должен быть указан ровно один из `record` и `prefix`.
state строка / обязательно	Указывает состояние записи ресурса. Варианты: `"present"` `"absent"`
ttl целое число	TTL для новой записи, в секундах. Это не используется для удаления записей.
txt_character_encoding строка добавлено в community.dns 2.5.0	Обрабатывать ли числовые escape-последовательности (`\xyz`) как восьмеричные или десятичные числа. Это используется только когда `txt_transformation=quoted`. Значение по умолчанию изменено на `decimal` в community.dns 3.0.0. Ранее значением по умолчанию было `octal`. Значение `decimal` совместимо с RFC 1035. Варианты: `"decimal"` ← (по умолчанию) `"octal"`
txt_transformation строка	Определяет, как значения записей 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 строка / обязательно	Тип записи DNS для создания или удаления. Варианты: `"A"` `"AAAA"` `"CAA"` `"CNAME"` `"DANE"` `"DS"` `"HINFO"` `"MX"` `"NS"` `"RP"` `"SOA"` `"SRV"` `"TLSA"` `"TXT"`
value строка / обязательно	Новое значение при создании записи DNS. При удалении записи должны быть указаны все значения записи, иначе она не будет удалена.
zone_id строка	ID зоны 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`), когда режим diff включен.

Примечания

Примечание

Для записей CNAME используйте абсолютные имена DNS для значений. Абсолютные имена DNS заканчиваются trailing period ., например foo.example.com.. Если вы используете относительное имя DNS без trailing period, значение будет относиться к зоне CNAME записи.

Примеры

- 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: 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 строка	ID зоны. Возвращается: успех Пример: `"23"`

Авторы

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