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

hosttech_password

строка

Пароль пользователя API Hosttech.

Если параметр указан, необходимо также указать hosttech_username.

Взаимоисключающий параметр с hosttech_token.

hosttech_token

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

строка

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

Пароль пользователя API Hosttech.

Взаимоисключающий параметр с hosttech_username и hosttech_password.

Начиная с community.dns 1.2.0, можно использовать псевдоним api_token.

hosttech_username

строка

Имя пользователя API Hosttech.

Если параметр указан, необходимо также указать hosttech_password.

Взаимоисключающий параметр с hosttech_token.

prefix

строка

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

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

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

record

строка

Полная запись DNS, которую необходимо получить.

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

txt_character_encoding

строка

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

Указывает, следует ли интерпретировать числовые escape-последовательности (\xyz) как восьмеричные или десятичные числа. Используется только при txt_transformation=quoted.

В community.dns 3.0.0 значение по умолчанию изменилось на decimal. Ранее значением по умолчанию было 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, которую необходимо получить.

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

Варианты:

• "A"
• "AAAA"
• "CAA"
• "CNAME"
• "MX"
• "NS"
• "PTR"
• "SPF"
• "SRV"
• "TXT"

what

строка

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

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

Варианты:

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

zone_id

целое число

Идентификатор изменяемой зоны DNS.

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

zone_name

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

строка

Изменяемая зона DNS.

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

action_group

Группа действий: community.dns.hosttech

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

Используйте group/community.dns.hosttech в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

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

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

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

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

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

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

idempotent

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

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

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

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

records

список / элементы=словарь

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

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

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

extra

словарь

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

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

Пример: {"comment": ""}

prefix

строка

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

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

Пример: "sample"

record

строка

Имя записи.

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

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

ttl

целое число

TTL.

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

Пример: 3600

type

строка

Тип записи DNS.

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

Пример: "A"

value

строка

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

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

Пример: "1.2.3.4"

zone_id

целое число

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

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

Пример: 23