Spec-Zone.ru › Ansible 2.7

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, то собирается только минимальное подмножество. Чтобы избежать сбора даже минимального подмножества, укажите !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'

- name: Collect only facts returned by facter
  setup:
    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]
  • Этот модуль поддерживается командой Ansible Core. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

  • Команда Ansible Core
  • Майкл ДеХан
  • Дэвид О’Брайен @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.7/modules/setup_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API