setup - Сбор фактов о удалённых хостах
Обзор
- Этот модуль автоматически вызывается playbook'ами для сбора полезных переменных об удалённых хостах, которые могут быть использованы в playbook'ах. Он также может быть выполнен напрямую
/usr/bin/ansibleдля проверки доступных переменных для хоста. Ansible предоставляет много фактов о системе автоматически. - Этот модуль также поддерживает Windows-цели.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| fact_path (добавлено в 1.3) | По умолчанию: "/etc/ansible/facts.d" | Путь, используемый для локальных фактов ansible (*.fact) - файлы в этой директории будут выполнены (если исполняемые) и их результаты будут добавлены к фактам ansible_local, если файл не исполняемый, он будет прочитан. Обратитесь к примечаниям для вариантов Windows. (с версии 2.1) Формат файла/результатов может быть json или ini-формат |
| filter | По умолчанию: "*" | Если задано, возвращаются только факты, соответствующие этому шаблону (fnmatch) с подстановкой символов. |
| gather_subset (добавлено в 2.1) | По умолчанию: "all" | Если задано, ограничивает дополнительные собираемые факты заданным подмножеством. Возможные значения: all, min, hardware, network, virtual, ohai и facter Можно указать список значений для задания большего подмножества. Значения также могут быть использованы с начальным ! для указания, что это конкретное подмножество не должно собираться. Например: !hardware, !network, !virtual, !ohai, !facter. Если указано !all, то собирается только подмножество min. Чтобы избежать сбора даже подмножества min, укажите подмножества !all и !min. Чтобы собрать только конкретные факты, используйте !all, !min и укажите конкретные подмножества фактов. Используйте параметр filter, если вы не хотите отображать некоторые собранные факты. |
| gather_timeout (добавлено в 2.2) | По умолчанию: 10 | Установить время ожидания по умолчанию в секундах для сбора отдельных фактов. |
Примечания
Примечание
- В последующих выпусках будет добавлено больше фактов ansible. Если установлены facter или ohai, переменные из этих программ также будут запечатлены в файл JSON для использования в шаблонах. Эти переменные имеют префиксы
facter_иohai_, что позволяет легко определить их источник. Все переменные передаются вызывающему модулю. Использование фактов ansible и отказ от установки facter и ohai позволяет избежать зависимости от Ruby на удалённых системах. (См. также facter и ohai.) - Параметр filter фильтрует только подключаемые ключи первого уровня ниже ansible_facts.
- Если целевой хост — Windows, у вас пока нет возможности использовать
filter, так как это обеспечивается более простым исполнением модуля. - Если целевой хост — Windows, вы теперь можете использовать
fact_path. Убедитесь, что этот путь существует на целевом хосте. Файлы в этом пути ДОЛЖНЫ быть скриптами PowerShell (*.ps1) и их вывод должен быть форматируемым в JSON (Ansible позаботится об этом). Проверьте вывод своих скриптов. Этот параметр был добавлен в Ansible 2.1. - Этот модуль также поддерживает Windows-цели.
Примеры
# Display facts from all hosts and store them indexed by I(hostname) at C(/tmp/facts). # ansible all -m setup --tree /tmp/facts # Display only facts regarding memory found by ansible on all hosts and output them. # ansible all -m setup -a 'filter=ansible_*_mb' # Display only facts returned by facter. # ansible all -m setup -a 'filter=facter_*' # Collect only facts returned by facter. # ansible all -m setup -a 'gather_subset=!all,!any,facter' # Display only facts about certain interfaces. # ansible all -m setup -a 'filter=ansible_eth[0-2]' # Restrict additional gathered facts to network and virtual (includes default minimum facts) # ansible all -m setup -a 'gather_subset=network,virtual' # Collect only network and virtual (excludes default minimum facts) # ansible all -m setup -a 'gather_subset=!all,!any,network,virtual' # Do not call puppet facter or ohai even if present. # ansible all -m setup -a 'gather_subset=!facter,!ohai' # Only collect the default minimum amount of facts: # ansible all -m setup -a 'gather_subset=!all' # Collect no facts, even the default minimum subset of facts: # ansible all -m setup -a 'gather_subset=!all,!min' # Display facts from Windows hosts with custom facts stored in C(C:\custom_facts). # ansible windows -m setup -a "fact_path='c:\custom_facts'"
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будет вноситься обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как core, что означает, что он поддерживается Командой ядра Ansible. Для получения дополнительной информации см. Техническое обслуживание и поддержка модулей.
Для списка других модулей, которые также поддерживаются Командой ядра Ansible, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этой статье базы знаний
Автор
- Команда ядра Ansible
- Michael DeHaan
- David O’Brien @david_obrien davidobrien1985
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/setup_module.html
