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

hosttech_password

string

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

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

Несовместим с hosttech_token.

hosttech_token

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

string

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

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

Несовместим с hosttech_username и hosttech_password.

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

hosttech_username

string

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

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

Несовместим с hosttech_token.

prefix

string

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

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

Это часть record перед zone_name. Например, если изменяемая запись для зоны example.com — www.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"
• "MX"
• "NS"
• "PTR"
• "SPF"
• "SRV"
• "TXT"

what

string

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

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

Варианты:

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

zone_id

integer

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

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

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

zone_name

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

string

Изменяемая 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

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

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

При повторном запуске с теми же аргументами вне режима проверки результат второго вызова указывает на отсутствие изменений.

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

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, здесь будет указано минимальное значение.

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

Пример: 3600

ttls

list / elements=integer

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

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

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

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

type

string

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

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

Пример: "A"

value

list / elements=string

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

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

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

sets

list / elements=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, здесь будет указано минимальное значение.

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

Пример: 3600

ttls

list / elements=integer

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

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

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

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

type

string

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

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

Пример: "A"

value

list / elements=string

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

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

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

zone_id

integer

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

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

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

Пример: 23