community.dns.hosttech_dns_records inventory — создание инвентаря из записей Hosttech DNS

Примечание

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

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

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

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

Новое в community.dns 2.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

Краткое описание

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

Требования

Следующие компоненты требуются на локальном управляющем узле, который выполняет этот плагин инвентаризации.

lxml

Параметры

Параметр	Комментарии
filters list / elements=dictionary добавлено в community.dns 3.0.0	Список фильтров включения/исключения, позволяющий выбирать или отменять выбор узлов для этого инвентаря. Фильтры обрабатываются последовательно до первого фильтра, которому соответствует `filters[].exclude` или `filters[].include`. Если соответствует `filters[].exclude`, узел исключается; если соответствует `filters[].include`, узел включается. Если ни один фильтр не соответствует, узел включается.
exclude string	Условие Jinja2. Если оно выполняется для узла, этот узел исключается. Можно указать ровно один из параметров `filters[].exclude` и `filters[].include`.
include string	Условие Jinja2. Если оно выполняется для узла, этот узел включается. Можно указать ровно один из параметров `filters[].exclude` и `filters[].include`.
hosttech_password string	Пароль пользователя API Hosttech. Если он указан, необходимо также указать `hosttech_username`. Взаимоисключающий параметр с `hosttech_token`. Конфигурация: Переменная окружения: `ANSIBLE_HOSTTECH_API_PASSWORD` добавлено в community.dns 2.5.0
hosttech_token псевдонимы: api_token string добавлено в community.dns 0.2.0	Пароль пользователя API Hosttech. Взаимоисключающий параметр с `hosttech_username` и `hosttech_password`. Начиная с community.dns 1.2.0 можно использовать псевдоним `api_token`. Конфигурация: Переменная окружения: `ANSIBLE_HOSTTECH_DNS_TOKEN` добавлено в community.dns 2.5.0
hosttech_username string	Имя пользователя API Hosttech. Если оно указано, необходимо также указать `hosttech_password`. Взаимоисключающий параметр с `hosttech_token`. Конфигурация: Переменная окружения: `ANSIBLE_HOSTTECH_API_USERNAME` добавлено в community.dns 2.5.0
plugin string / обязательный	Имя этого плагина. Для распознавания этим плагином в качестве собственного здесь всегда следует указывать `community.dns.hosttech_dns_records`. Варианты: `"community.dns.hosttech_dns_records"`
simple_filters dictionary	Словарь пар значений фильтров. До community.dns 3.0.0 этот параметр назывался `filters`. В community.dns 2.8.0 он был переименован с `filters` на `simple_filters`, а старое имя оставалось доступным в качестве псевдонима до community.dns 3.0.0. Теперь `filters` используется для другого параметра. По умолчанию: `{}`
type list / elements=string	Типы записей, значения которых следует использовать. Варианты: `"A"` ← (по умолчанию) `"AAAA"` ← (по умолчанию) `"CAA"` `"CNAME"` ← (по умолчанию) `"MX"` `"NS"` `"PTR"` `"SPF"` `"SRV"` `"TXT"` По умолчанию: `["A", "AAAA", "CNAME"]`
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"` ← (по умолчанию)
zone_id any	Идентификатор изменяемой зоны DNS. Необходимо указать ровно один из параметров `zone_name` и `zone_id`.
zone_name псевдонимы: zone string	Изменяемая зона DNS. Необходимо указать ровно один из параметров `zone_name` и `zone_id`.

Примечания

Примечание

Специфичные для поставщика параметры hosttech_username, hosttech_password и hosttech_token можно шаблонизировать.
Параметры zone_name и zone_id можно шаблонизировать.

См. также

community.dns.hosttech_dns_record_set_info: Получение наборов записей в службе Hosttech DNS.
community.dns.hosttech_dns_record_info: Получение записей в службе Hosttech DNS.
Поддерживаемые записи DNS: Дополнительная информация о поддерживаемых типах записей DNS.

Примеры

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

plugin: community.dns.hosttech_dns_records
zone_name: domain.ch
simple_filters:
  type:
    - AAAA
filters:
  - include: >-
      '*.' not in inventory_hostname
  - exclude: true

# 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 ANSIBLE_HOSTTECH_DNS_TOKEN environment variable.
hosttech_token: >-
  {{ (lookup('community.sops.sops', 'keys/hosttech.sops.yml') | from_yaml).hosttech_dns_token }}

Авторы

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