Spec-Zone.ru › Ansible

community.dns.hetzner_dns_records инвентаризация – Создание инвентаризации из записей DNS Hetzner

Примечание

Этот плагин инвентаризации входит в состав коллекции community.dns (версия 3.0.5).

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

Для установки используйте: ansible-galaxy collection install community.dns.

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

Новая функция в community.dns 2.0.0

  • Описание
  • Параметры
  • Примечания
  • См. также
  • Примеры

Описание

  • Для того, чтобы Ansible смог распознать файл YAML как инвентаризацию для этого плагина, файл инвентаризации должен содержать plugin: community.dns.hetzner_dns_records и его имя файла должно заканчиваться на hetzner_dns.yaml или hetzner_dns.yml
  • Записи сопоставляются по префиксу / имени записи и значению.
  • Этот плагин позволяет создавать инвентаризацию из записей DNS Hetzner.

Параметры

Параметр

Комментарии

filters

список / элементы=словарь

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

Список фильтров включения/исключения, позволяющий выбирать/отключать хосты для этого инвентаря.

Фильтры обрабатываются последовательно до первого фильтра, где filters[].exclude или filters[].include совпадают. В случае совпадения filters[].exclude, хост исключается, а в случае совпадения filters[].include, хост включается. Если ни один фильтр не совпадает, хост включается.

exclude

строка

Условие Jinja2. Если оно совпадает для хоста, этот хост исключается.

Можно указать только одно из filters[].exclude и filters[].include.

include

строка

Условие Jinja2. Если оно совпадает для хоста, этот хост включается.

Можно указать только одно из filters[].exclude и filters[].include.

hetzner_token

алиасы: api_token

строка / обязательно

Токен для API Hetzner.

Если не указан, будет считан из переменной окружения HETZNER_DNS_TOKEN.

Настройка:

  • Переменная окружения: HETZNER_DNS_TOKEN

plugin

строка / обязательно

Имя этого плагина. Должно всегда быть установлено в community.dns.hetzner_dns_records для распознавания плагина как собственного.

Варианты:

  • "community.dns.hetzner_dns_records"

simple_filters

словарь

Словарь пар значений фильтров.

Этот параметр раньше назывался filters до community.dns 3.0.0. Он был переименован из filters в simple_filters в community.dns 2.8.0, и старое имя было доступно как псевдоним до community.dns 3.0.0. filters теперь используется для чего-то другого.

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

type

список / элементы=строка

Типы записей, значения которых использовать.

Варианты:

  • "A" ← (по умолчанию)
  • "AAAA" ← (по умолчанию)
  • "CAA"
  • "CNAME" ← (по умолчанию)
  • "DANE"
  • "DS"
  • "HINFO"
  • "MX"
  • "NS"
  • "RP"
  • "SOA"
  • "SRV"
  • "TLSA"
  • "TXT"

Значение по умолчанию: ["A", "AAAA", "CNAME"]

txt_character_encoding

строка

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

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

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

Варианты:

  • "decimal" ← (по умолчанию)
  • "octal"

txt_transformation

строка

Определяет, как преобразуются значения 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

строка

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

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

zone_name

алиасы: zone

строка

Зона DNS для изменения.

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

Примечания

Примечание

  • Параметр hetzner_token, специфичный для поставщика, может быть шаблонизирован.
  • Параметры zone_name и zone_id могут быть шаблонизированы.

См. также

См. также

community.dns.hetzner_dns_record_set_info

Получение наборов записей в сервисе Hetzner DNS.

community.dns.hetzner_dns_record_info

Получение записей в сервисе Hetzner DNS.

Примеры

# filename must end with hetzner_dns.yaml or hetzner_dns.yml

plugin: community.dns.hetzner_dns_records
zone_name: domain.de
simple_filters:
  type:
    - TXT
filters:
  - include: >-
      not ansible_host.startswith('v=')
  - exclude: true
txt_transformation: unquoted

# You can also configure the token by putting secret value into this file,
# but this is discouraged. Use a lookup like below, or leave it away and
# set it with the HETZNER_DNS_TOKEN environment variable.
hetzner_token: >-
    {{ (lookup('community.sops.sops', 'keys/hetzner.sops.yml') | from_yaml).hetzner_dns_token }}

Авторы

  • Markus Bergholz (@markuman)
  • 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/hetzner_dns_records_inventory.html

Spec-Zone.ru

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