Модуль community.dns.hosttech_dns_record_sets – Сводное синхронизирование записей DNS в службе Hosttech DNS

Примечание

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

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

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

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

Добавлен в community.dns 2.0.0

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

Описание

Сводное синхронизирование записей DNS в службе Hosttech DNS.
Возможно проигнорировать определенные записи, указав record_sets[].ignore=true для этой записи.
Модуль позволяет устанавливать, изменять и удалять несколько записей DNS одновременно.
Этот модуль заменяет hosttech_dns_records из community.dns версии до 2.0.0.
С опцией prune также возможно удалять существующие записи, которые не указаны в параметрах модуля. Это позволяет синхронизировать ожидаемое состояние зоны DNS с ожидаемым состоянием.

Требования

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

lxml

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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`.
prune булево	Если установлено в `true`, удалит все существующие записи в зоне, которые не указаны в `record_sets`. Варианты: `false` ← (по умолчанию) `true`
record_sets псевдонимы: records список / элементы=словарь / обязательный	Записи, которые должны присутствовать в зоне.
ignore булево	Если установлено в `true`, `record_sets[].value` будут проигнорированы. Это полезно, когда `prune=true`, но вы не хотите удалять определённые записи, не зная их текущее значение. Варианты: `false` ← (по умолчанию) `true`
prefix строка	Префикс записи DNS. Это часть `record_sets[].record` перед `zone_name`. Например, если запись, которую нужно изменить, это `www.example.com` для зоны `example.com`, префикс — `www`. Если запись в этом примере будет `example.com`, префикс будет `''` (пустая строка). Должен быть указан ровно один из `record_sets[].record` и `record_sets[].prefix`.
record строка	Полная запись DNS для создания или удаления. Должен быть указан ровно один из `record_sets[].record` и `record_sets[].prefix`.
ttl целое число	Время жизни (TTL) новой записи в секундах. По умолчанию: `3600`
type строка / обязательный	Тип записи DNS для создания или удаления. Варианты: `"A"` `"AAAA"` `"CAA"` `"CNAME"` `"MX"` `"NS"` `"PTR"` `"SPF"` `"SRV"` `"TXT"`
value список / элементы=строка	Новое значение при создании записи DNS. Разрешены списки YAML или несколько значений, разделённых запятыми. При удалении записи все значения для записи должны быть указаны, иначе она не будет удалена. Должно быть указано, если `record_sets[].ignore=false`.
txt_character_encoding строка добавлен в community.dns 2.5.0	Как обрабатывать числовые последовательности экранирования (`\xyz`) — как восьмеричные или десятичные числа. Используется только при `txt_transformation=quoted`. По умолчанию изменено на `decimal` в community.dns 3.0.0. Раньше по умолчанию было `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"` ← (по умолчанию)
zone_id integer	ID зоны 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	Поддержка: полная	Возвращает подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), при использовании режима сравнения.

Примеры

- name: Make sure some records exist and have the expected values
  community.dns.hosttech_dns_record_sets:
    zone_name: foo.com
    records:
      - prefix: new
        type: A
        ttl: 7200
        value:
          - 1.1.1.1
          - 2.2.2.2
      - prefix: new
        type: AAAA
        ttl: 7200
        value:
          - "::1"
      - record: foo.com
        type: TXT
        value:
          - test
    hosttech_token: access_token

- name: Synchronize DNS zone with a fixed set of records
  # If a record exists that is not mentioned here, it will be deleted
  community.dns.hosttech_dns_record_sets:
    zone_id: 23
    purge: true
    records:
      - prefix: ''
        type: A
        value: 127.0.0.1
      - prefix: ''
        type: AAAA
        value: "::1"
      - prefix: ''
        type: NS
        value:
          - ns-1.hoster.com
          - ns-2.hoster.com
          - ns-3.hoster.com
    hosttech_token: access_token

Значения возврата

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

Ключ	Описание
zone_id integer	ID зоны. Возвращено: success Пример: `23`

Авторы

Felix Fontein (@felixfontein)

Ссылки на сборку

© 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_sets_module.html