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

prefix

string

Префикс записи DNS.

Это часть record перед zone_name. Например, если изменяемая запись — www.example.com для зоны example.com, префикс — www. Если бы запись в этом примере была example.com, префиксом было бы '' (пустая строка).

Если what равно single_record или all_types_for_record, необходимо указать ровно один из параметров record и prefix.

record

string

Полная запись DNS, которую нужно получить.

Если what равно single_record или all_types_for_record, необходимо указать ровно один из параметров record и prefix.

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, которую нужно получить.

Обязательно, если what равно single_record.

Варианты:

• "A"
• "AAAA"
• "CAA"
• "CNAME"
• "DANE"
• "DS"
• "HINFO"
• "HTTPS"
• "MX"
• "NS"
• "PTR"
• "RP"
• "SOA"
• "SRV"
• "SVCB"
• "TLSA"
• "TXT"

what

string

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

Обратите внимание, что структура возвращаемого значения зависит от этого параметра.

Варианты:

• "single_record" ← (по умолчанию)
• "all_types_for_record"
• "all_records"

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

Поддержка: не применимо

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

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

idempotent

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

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

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

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

records

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

Список полученных записей.

Возвращается: при успехе, если what не равно single_record

Пример: [{"extra": {}, "record": "sample.example.com", "ttl": 3600, "type": "A", "value": "1.2.3.4"}]

extra

dictionary

Дополнительные сведения о записях.

Возвращается: при успехе

Пример: {"created": "2021-07-09T11:18:37Z", "modified": "2021-07-09T11:18:37Z"}

prefix

string

Префикс записи.

Возвращается: при успехе

Пример: "sample"

record

string

Имя записи.

Возвращается: при успехе

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

ttl

integer

TTL.

Возвращает none, если используется TTL зоны по умолчанию.

Возвращается: при успехе

Пример: 3600

type

string

Тип записи DNS.

Возвращается: при успехе

Пример: "A"

value

string

Значение записи DNS.

Возвращается: при успехе

Пример: "1.2.3.4"

zone_id

string

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

Возвращается: при успехе

Пример: "23"