community.general.icinga2 inventory – Источник инвентаризации Icinga2

Примечание

Этот плагин инвентаризации является частью коллекции community.general collection (версия 9.5.0).

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

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

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

Новое в community.general 3.7.0

Краткое описание
Параметры
Примеры

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

Получение узлов инвентаризации из API Icinga2.
Использует файл конфигурации в качестве источника инвентаризации; он должен заканчиваться на .icinga2.yml или .icinga2.yaml.

Параметры

Параметр	Комментарии
compose dictionary added in community.general 4.4.0	Создать переменные из выражений jinja2. Default: `{}`
group_by_hostgroups boolean added in community.general 8.4.0	Использует группы хостов Icinga2 в качестве групп. Choices: `false` `true` ← (default)
groups dictionary added in community.general 4.4.0	Добавить хосты в группу на основе условных выражений Jinja2. Default: `{}`
host_filter string	Допустимый фильтр хостов Icinga2 API. Оставьте пустым для отсутствия фильтрации
inventory_attr string added in community.general 4.2.0	Позволяет переопределить имя инвентаря на основе различных атрибутов. Это позволяет изменить способ использования лимитов. Текущее значение по умолчанию, `address`, иногда не является уникальным или отсутствует. Рекомендуется использовать `name` вместо него. Choices: `"name"` `"display_name"` `"address"` ← (default)
keyed_groups list / elements=dictionary added in community.general 4.4.0	Добавить хосты в группу на основе значений переменной. Default: `[]`
default_value string added in ansible-core 2.12	Значение по умолчанию, когда значение переменной хоста является пустой строкой. Эта опция взаимоисключающая с `keyed_groups[].trailing_separator`.
key string	Ключ из входного словаря, используемый для генерации групп
parent_group string	Родительская группа для группировки по ключу
prefix string	Имя группы с ключом будет начинаться с этого префикса Default: `""`
separator string	Разделитель, используемый для построения имени группы с ключом Default: `"_"`
trailing_separator boolean added in ansible-core 2.12	Установите этот параметр на `False` чтобы опустить `keyed_groups[].separator` после переменной хоста, когда значение является пустой строкой. Эта опция взаимоисключающая с `keyed_groups[].default_value`. Choices: `false` `true` ← (default)
leading_separator boolean added in ansible-core 2.11	Используйте в сочетании с keyed_groups. По умолчанию, имя группы с ключом, у которой нет префикса или разделителя, будет начинаться со знака подчеркивания. Это связано с тем, что префикс по умолчанию - это “” и разделитель по умолчанию - это “_”. Установите этот параметр в False, чтобы опустить начальный символ подчеркивания (или другой разделитель), если префикс не задан. Если имя группы получено из отображения, разделитель все еще используется для объединения элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для группы с ключом в пустую строку. Choices: `false` `true` ← (default)
password string / required	Пароль для запроса к API.
plugin string / required	Название плагина. Choices: `"community.general.icinga2"`
strict boolean added in community.general 4.4.0	Если `yes` сделать неверные записи фатальной ошибкой, в противном случае пропустить и продолжить. Поскольку можно использовать факты в выражениях, они могут не всегда быть доступны, и мы игнорируем эти ошибки по умолчанию. Choices: `false` ← (default) `true`
url string / required	Корневой URL API Icinga2.

use_extra_vars boolean added in ansible-core 2.11	Объединить дополнительные переменные с доступными переменными для композиции (наивысший приоритет). Варианты: `false` ← (default) `true` Конфигурация: Запись INI: [inventory_plugins] use_extra_vars = false Переменная среды: `ANSIBLE_INVENTORY_USE_EXTRA_VARS`
user string / required	Имя пользователя для запроса к API.
validate_certs boolean	Включает или отключает проверку SSL-сертификатов. Варианты: `false` `true` ← (default)

Примеры

# my.icinga2.yml
plugin: community.general.icinga2
url: http://localhost:5665
user: ansible
password: secure
host_filter: \"linux-servers\" in host.groups
validate_certs: false  # only do this when connecting to localhost!
inventory_attr: name
groups:
  # simple name matching
  webservers: inventory_hostname.startswith('web')

  # using icinga2 template
  databaseservers: "'db-template' in (icinga2_attributes.templates|list)"

compose:
  # set all icinga2 attributes to a host variable 'icinga2_attrs'
  icinga2_attrs: icinga2_attributes

  # set 'ansible_user' and 'ansible_port' from icinga2 host vars
  ansible_user: icinga2_attributes.vars.ansible_user
  ansible_port: icinga2_attributes.vars.ansible_port | default(22)

Авторы

Cliff Hults (@BongoEADGC6)

Подсказка

Записи конфигурации для каждого типа имеют порядок приоритета от низкого к высокому. Например, переменная, которая находится ниже в списке, переопределит переменную, находящуюся выше.

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

© 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/general/icinga2_inventory.html