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

Примечание

Этот модуль входит в коллекцию community.dns (версия 3.5.5).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.dns. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.dns.hosttech_dns_record.

Новое в community.dns 2.0.0

Обзор
Требования
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Обзор

Создаёт и удаляет отдельные записи DNS в службе Hosttech DNS.
Если нужно не добавлять или удалять значения, а заменять их, измените набор записей, а не отдельную запись. Это особенно важно при работе с записями CNAME и SOA. Для работы с наборами записей используйте модуль community.dns.hosttech_dns_record_set.
Записи сопоставляются по префиксу / имени записи и значению.
Этот модуль заменяет hosttech_dns_record из community.dns версий до 2.0.0.

Требования

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

lxml

Параметры

Параметр	Комментарии
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	Префикс записи 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 string / обязательный	Новое значение при создании записи DNS. При удалении записи необходимо указать все её значения, иначе она не будет удалена.
zone_id integer	Идентификатор изменяемой зоны 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	Поддержка: полная	При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или которую он опрашивает, существенно не изменилась.

См. также

Поддерживаемые записи DNS: Дополнительная информация о поддерживаемых типах записей DNS.

Примеры

- name: Add a new.foo.com A record
  community.dns.hosttech_dns_record:
    state: present
    zone: foo.com
    record: new.foo.com
    type: A
    ttl: 7200
    value: 1.1.1.1
    hosttech_token: access_token

- name: Remove a new.foo.com A record
  community.dns.hosttech_dns_record:
    state: absent
    zone_name: foo.com
    record: new.foo.com
    type: A
    ttl: 7200
    value: 2.2.2.2
    hosttech_token: access_token

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
zone_id integer	Идентификатор зоны. Возвращается: при успешном выполнении Пример: `23`

Авторы

Felix Fontein (@felixfontein)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/dns/hosttech_dns_record_module.html