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

Примечание

Этот плагин инвентаризации входит в коллекцию community.dns (версия 3.0.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
Записи сопоставляются по префиксу / имени записи и значению.
Этот плагин позволяет создать инвентарь из записей DNS Hosttech.

Требования

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

lxml

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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`.
hosttech_password строка	Пароль пользователя Hosttech API. Если указан, также должен быть указан `hosttech_username`. Взаимоисключающее с `hosttech_token`. Настройка: Переменная окружения: `ANSIBLE_HOSTTECH_API_PASSWORD` добавлен в community.dns 2.5.0
hosttech_token псевдонимы: api_token строка добавлен в community.dns 0.2.0	Пароль пользователя Hosttech API. Взаимоисключающее с `hosttech_username` и `hosttech_password`. С версии community.dns 1.2.0 можно использовать псевдоним `api_token`. Настройка: Переменная окружения: `ANSIBLE_HOSTTECH_DNS_TOKEN` добавлен в community.dns 2.5.0
hosttech_username строка	Имя пользователя пользователя Hosttech API. Если указано, должен быть указан `hosttech_password`. Взаимоисключающее с `hosttech_token`. Настройка: Переменная окружения: `ANSIBLE_HOSTTECH_API_USERNAME` добавлен в community.dns 2.5.0
plugin строка / обязательно	Имя этого плагина. Для распознавания плагина им как своим, должно всегда устанавливаться значение `community.dns.hosttech_dns_records`. Варианты: `"community.dns.hosttech_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"` ← (по умолчанию) `"MX"` `"NS"` `"PTR"` `"SPF"` `"SRV"` `"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"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

zone_id any	Идентификатор зоны DNS для изменения. Должно быть указано ровно одно из `zone_name` и `zone_id`.
zone_name aliases: zone string	Зона DNS для изменения. Должно быть указано ровно одно из `zone_name` и `zone_id`.

Примечания

Примечание

Зависимые от поставщика hosttech_username, hosttech_password, и hosttech_token параметры могут быть шаблонизированы.
Параметры zone_name и zone_id могут быть шаблонизированы.

См. также

community.dns.hosttech_dns_record_set_info: Получение наборов записей в службе DNS Hosttech.
community.dns.hosttech_dns_record_info: Получение записей в службе DNS Hosttech.

Примеры

# 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/dns/hosttech_dns_records_inventory.html