Модуль community.dns.hetzner_dns_record_set_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

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

Префикс 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

добавлено в 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

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

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

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

idempotent

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

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

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

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

set

dictionary

Полученный набор записей. Если набор записей не существует, он пуст.

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

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

prefix

string

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

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

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

Пример: "sample"

record

string

Имя записи.

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

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

ttl

integer

TTL.

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

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

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

Пример: 3600

ttls

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

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

Каждое уникальное значение TTL будет указано один раз; значения расположены в порядке возрастания.

Возвращается: если имеется более одного уникального значения TTL

Пример: [300, 3600]

type

string

Тип DNS-записи.

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

Пример: "A"

value

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

Значение набора DNS-записей.

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

Пример: ["1.2.3.4", "1.2.3.5"]

sets

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

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

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

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

prefix

string

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

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

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

Пример: "sample"

record

string

Имя записи.

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

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

ttl

integer

TTL.

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

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

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

Пример: 3600

ttls

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

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

Каждое уникальное значение TTL будет указано один раз; значения расположены в порядке возрастания.

Возвращается: если имеется более одного уникального значения TTL

Пример: [300, 3600]

type

string

Тип DNS-записи.

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

Пример: "A"

value

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

Значение набора DNS-записей.

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

Пример: ["1.2.3.4", "1.2.3.5"]

zone_id

string

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

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

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

Пример: "23"