Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook укажите: community.dns.hosttech_dns_record.

Новая в community.dns 2.0.0

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

Обзор

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

Требования

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

  • lxml

Параметры

Параметр

Комментарии

hosttech_password

string

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

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

Взаимоисключающий с hosttech_token.

hosttech_token

aliases: api_token

string

added in community.dns 0.2.0

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

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

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

hosttech_username

string

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

Если указан, 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 / required

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

Варианты:

  • "present"
  • "absent"

ttl

integer

Время жизни (TTL) для новой записи в секундах.

Это не используется для удаления записей.

Значение по умолчанию: 3600

txt_character_encoding

string

added in community.dns 2.5.0

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

Значение по умолчанию изменилось на decimal в community.dns 3.0.0. Ранее значением по умолчанию было octal. Значение decimal совместимо с RFC 1035.

Варианты:

  • "decimal" ← (default)
  • "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" ← (default)

type

string / required

Тип записи DNS для создания или удаления.

Варианты:

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

value

string / required

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

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

zone_id

integer

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

Должен быть указан ровно один из zone_name и zone_id.

zone_name

aliases: 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).

Примеры

- 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

целое число

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

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

Пример: 23

Авторы

  • Felix Fontein (@felixfontein)

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

  • Система отслеживания ошибок
  • Репозиторий (исходные коды)
  • Задайте вопрос (DNS)
  • Отправить отчет об ошибке
  • Запросить новую функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API