setup - Сбор фактов о удалённых хостах
Описание
- Этот модуль автоматически вызывается playbooks для сбора полезных переменных о удалённых хостах, которые могут быть использованы в playbooks. Он также может быть выполнен напрямую
/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, что означает, что разработчики этого модуля гарантируют, что не будут внесены несовместимые изменения интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.5/modules/setup_module.html
