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

on_existing

string

Этот параметр определяет поведение, если набор записей уже существует, но отличается от указанного набора. При сравнении для всех записей типа type, соответствующих prefix или record, используются value и ttl.

Если задано значение replace, запись будет обновлена (state=present) или удалена (state=absent). Это прежнее поведение overwrite=true.

Если задано значение keep_and_fail, модуль завершится с ошибкой и не изменит записи. Это прежнее поведение overwrite=false, если state=present.

Если задано значение keep_and_warn, модуль выдаст предупреждение и не изменит записи.

Если задано значение keep, модуль не изменит записи. Это прежнее поведение overwrite=false, если state=absent.

Если state=absent и значение не равно replace, необходимо указать value.

Варианты:

• "replace" ← (по умолчанию)
• "keep_and_fail"
• "keep_and_warn"
• "keep"

prefix

string

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

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

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

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

record

string

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

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

state

string / обязательный

Указывает состояние ресурсной записи.

Варианты:

• "present"
• "absent"

ttl

integer

TTL новой записи в секундах.

По умолчанию: 3600

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

Варианты:

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

value

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

Новое значение при создании DNS-записи.

Допускаются списки YAML или несколько значений, разделённых запятыми.

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

Необходимо указать, если state=present или если on_existing не равно replace.

Игнорируется, если state=absent и on_existing=replace.

zone_id

integer

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

ID изменяемой 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

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

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

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

zone_id

integer

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

ID зоны.

Возвращается: success

Пример: 23