theforeman.foreman.foreman – Источник инвентаризации Foreman
Примечание
Этот плагин входит в состав коллекции theforeman.foreman (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install theforeman.foreman.
Для использования в плейбуке укажите: theforeman.foreman.foreman.
Описание
- Получение хостов инвентаризации из Foreman.
- Использует файл конфигурации YAML, который заканчивается
foreman.(yml|yaml).
Требования
Ниже перечислены требования, необходимые на локальном узле контроллера, выполняющем эту инвентаризацию.
- requests >= 1.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| batch_size целое число | По умолчанию: 250 | Количество хостов в пакете, которые будут получены из API Foreman за один вызов | |
| cache логическое значение |
| записи ini: [inventory] переменная среды:ANSIBLE_INVENTORY_CACHE | Переключатель для включения/выключения кэширования исходных данных инвентаризации. Для работы требуется настройка плагина кэша. |
| cache_connection строка | записи ini: [defaults] [inventory] переменная среды:ANSIBLE_CACHE_PLUGIN_CONNECTION переменная среды:ANSIBLE_INVENTORY_CACHE_CONNECTION | Данные или путь к соединению кэша. Подробности см. в документации плагина кэша. | |
| cache_plugin строка | По умолчанию: "memory" | записи ini: [defaults] [inventory] переменная среды:ANSIBLE_CACHE_PLUGIN переменная среды:ANSIBLE_INVENTORY_CACHE_PLUGIN | Плагин кэша для использования исходных данных инвентаризации. |
| cache_prefix строка | По умолчанию: "ansible_inventory_" | записи ini: [default] [inventory] переменная среды:ANSIBLE_CACHE_PLUGIN_PREFIX переменная среды:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX | Префикс для использования в файлах/таблицах плагина кэша |
| cache_timeout целое число | По умолчанию: 3600 | записи ini: [defaults] [inventory] переменная среды:ANSIBLE_CACHE_PLUGIN_TIMEOUT переменная среды:ANSIBLE_INVENTORY_CACHE_TIMEOUT | Срок действия кэша в секундах |
| compose словарь | По умолчанию: {} | Создание переменных из выражений jinja2. | |
| foreman строка | Конфигурация, связанная с сервером Foreman, устаревшая. Вы можете передать use_reports_api в этом словаре, чтобы включить API отчетов. Только для обратной совместимости. | ||
| group_prefix строка | По умолчанию: "foreman_" | Префикс, применяемый к группам Foreman | |
| groups словарь | По умолчанию: {} | Добавление хостов в группу на основе условных выражений Jinja2. | |
| host_filters строка | Это можно использовать для ограничения списка возвращаемых хостов | ||
| hostnames список / элементы=строка | По умолчанию: ["name"] | Список шаблонов в порядке приоритета для составления inventory_hostname. Если шаблон возвращает пустую строку или значение None, он игнорируется. | |
| keyed_groups список / элементы=строка | По умолчанию: [] | Добавление хостов в группы на основе значений переменной. | |
| leading_separator логическое значение добавлен в 2.11 ansible.builtin |
| Используйте вместе с keyed_groups. По умолчанию, у ключевой группы, у которой нет префикса или разделителя, имя начинается с подчеркивания. Это потому, что префикс по умолчанию равен "", а разделитель по умолчанию равен "_". Установите этот параметр в значение False, чтобы опустить ведущее подчеркивание (или другой разделитель), если префикс не задан. Если имя группы получено из отображения, разделитель по-прежнему используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для ключевой группы в пустую строку. | |
| legacy_hostvars логическое значение |
| Включить/выключить. Если true, плагин создаст устаревшие hostvars, присутствующие в скрипте foreman. Помещает hostvars в словарь с ключами `foreman`, `foreman_facts` и `foreman_params` | |
| max_timeout целое число | По умолчанию: 600 | Таймаут перед переходом к старому API хоста при использовании конечной точки report_data во время опроса. | |
| password строка / обязательно | переменная среды:FOREMAN_PASSWORD | Пароль пользователя, который получает доступ к серверу Foreman. | |
| plugin строка / обязательно |
| токен, гарантирующий, что это исходный файл для плагина foreman. | |
| poll_interval целое число | По умолчанию: 10 | Интервал опроса между двумя вызовами конечной точки report_data во время опроса. | |
| report словарь | Конфигурация, специфичная для API отчетов, устаревшая. Вы можете передать параметры, специфичные для API отчетов, в виде части этого словаря вместо основной конфигурации. Только для обратной совместимости. | ||
| strict логическое значение |
| Если yes сделать недопустимые записи ошибкой, иначе пропустить и продолжить.Так как можно использовать факты в выражениях, они могут быть не всегда доступны, и мы игнорируем эти ошибки по умолчанию. | |
| url строка | По умолчанию: "http://localhost:3000" | переменная среды:FOREMAN_SERVER переменная среды:FOREMAN_SERVER_URL переменная среды:FOREMAN_URL | URL сервера Foreman. |
| use_extra_vars логическое значение добавлен в 2.11 ansible.builtin |
| записи ini: [inventory_plugins] переменная среды:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Объединить дополнительные переменные в доступные переменные для составления (наивысший приоритет). |
| use_reports_api логическое значение |
| Использовать API отчетов. | |
| user строка / обязательно | переменная среды:FOREMAN_USER переменная среды:FOREMAN_USERNAME | Имя пользователя, получающего доступ к серверу Foreman. | |
| validate_certs логическое значение |
| переменная среды:FOREMAN_VALIDATE_CERTS | Проверять ли сертификаты TLS сервера Foreman. |
| vars_prefix строка | По умолчанию: "foreman_" | Префикс, применяемый к переменным хоста, не включает факты и параметры | |
| want_content_facet_attributes логическое значение |
| Переключатель. Если true, инвентаризация получит детали представления содержимого, к которому привязан хост. | |
| want_facts логическое значение |
| Переключатель. Если True, плагин получит факты хоста с сервера. | |
| want_host_group логическое значение |
| Переключатель. Если true, инвентаризация получит host_groups и создаст группировки для них. | |
| want_hostcollections логическое значение |
| Переключатель. Если true, плагин создаст группы Ansible для коллекций хостов | |
| want_ipv4 логическое значение |
| Переключатель. Если true, инвентаризация получит IPv4 адрес хоста. | |
| want_ipv6 логическое значение |
| Переключатель. Если true, инвентаризация получит IPv6 адрес хоста. | |
| want_location логическое значение |
| Переключатель. Если true, инвентаризация получит расположение, к которому принадлежит хост, и создаст группировки для него. | |
| want_organization логическое значение |
| Переключатель. Если true, инвентаризация получит организацию, к которой принадлежит хост, и создаст группировки для нее. | |
| want_params логическое значение |
| Переключатель. Если true, инвентаризация получит информацию 'all_parameters' в качестве переменных хоста. |
| want_smart_proxies boolean |
| Переключатель. Если значение true, инвентаризация получит смарт-прокси, к которому зарегистрирован хост. | |
| want_subnet boolean |
| Переключатель. Если значение true, инвентаризация получит подсеть. | |
| want_subnet_v6 boolean |
| Переключатель. Если значение true, инвентаризация получит ipv6 подсеть. |
Примеры
# my.foreman.yml
plugin: theforeman.foreman.foreman
url: https://foreman.example.com
user: ansibleinventory
password: changeme
host_filters: 'organization="Web Engineering"'
# shortname.foreman.yml
plugin: theforeman.foreman.foreman
url: https://foreman.example.com
user: ansibleinventory
password: changeme
hostnames:
- name.split('.')[0]
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/theforeman/foreman/foreman_inventory.html
