Модуль ansible.builtin.set_stats — определение и отображение статистики текущего запуска Ansible

Примечание

Этот модуль входит в ansible-core и включен во все установки Ansible. В большинстве случаев можно использовать краткое имя модуля set_stats, даже не указывая ключевое слово collections. Однако для удобства перехода к документации модуля и во избежание конфликтов с другими коллекциями, в которых может быть модуль с таким же именем, рекомендуется использовать полное имя коллекции (FQCN) ansible.builtin.set_stats.

Краткое описание
Параметры
Атрибуты
Примечания
Примеры

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

Этот модуль позволяет задавать и накапливать статистику в текущем запуске Ansible — отдельно для каждого узла или для всех узлов запуска.
Этот модуль также поддерживается для целевых узлов под управлением Windows.

Примечание

Этому модулю соответствует плагин действий.

Параметры

Параметр	Комментарии
aggregate логический	Определяет, будет ли переданное значение добавлено к существующему значению статистики `true` или заменит его `false`. Возможные значения: `false` `true` ← (по умолчанию)
data словарь / обязательный	Словарь, в котором каждому ключу соответствует статистика (или переменная), за которой нужно следить.
per_host логический	Определяет, будет ли статистика собираться отдельно для каждого узла или для всех узлов запуска. Возможные значения: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action	Поддержка: частичная Плагин действий выполняет часть работы, но для фактического создания переменных он полагается на ядро; эту часть переопределить нельзя.	Указывает, что этому модулю соответствует плагин действий, поэтому некоторые части параметров можно выполнить на контроллере.
async	Поддержка: нет	Поддерживает использование с ключевым словом `async`
become	Поддержка: нет	Можно использовать вместе с ключевыми словами become.
bypass_host_loop	Поддержка: нет	Принудительно запускает задачу «глобально», не выполняя её отдельно на каждом узле. В этом случае не учитываются шаблонизация для отдельных узлов, а также параметры serial, throttle и другие особенности циклов. Условия будут работать так, как если бы использовалось `run_once`; для переменных будут взяты значения с первого доступного узла. Это действие обычно не работает вне стратегий с пошаговым выполнением.
bypass_task_loop	Поддержка: нет	Для этих задач игнорируются ключевые слова `loop` и `with_`.
check_mode	Поддержка: полная	Может выполняться в режиме проверки и возвращать прогноз изменения состояния, не изменяя целевой узел. Если режим не поддерживается, действие будет пропущено.
connection	Поддержка: нет	Использует настроенные сведения о подключении к целевому узлу для выполнения на нём кода.
core	Поддержка: частичная Хотя часть этого действия реализована в ядре, другие части по-прежнему доступны в виде обычных плагинов и могут быть частично переопределены.	Это функция «ядра», реализованная не так, как большинство действий задач, поэтому её нельзя переопределить с помощью системы плагинов.
delegation	Поддержка: нет	Можно использовать вместе с delegate_to и связанными ключевыми словами.
diff_mode	Поддержка: нет	В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в режиме check_mode).
ignore_conditional	Поддержка: нет	На действие не распространяется условное выполнение, поэтому оно игнорирует ключевое слово `when:`.
platform	Платформы: все	Целевые ОС и семейства ОС, с которыми можно работать.
tags	Поддержка: полная	Позволяет использовать ключевое слово «tags» для управления выбором этого действия для выполнения.
until	Поддержка: нет	Указывает, учитывает ли это действие ключевые слова until, retry и poll.

Примечания

Примечание

Чтобы отображалась пользовательская статистика, необходимо задать show_custom_stats в разделе [defaults] файла ansible.cfg либо установить переменную окружения ANSIBLE_SHOW_CUSTOM_STATS в значение true. Подробности см. в плагине обратного вызова ansible.builtin.default.

Примеры

- name: Aggregating packages_installed stat per host
  ansible.builtin.set_stats:
    data:
      packages_installed: 31
    per_host: yes

- name: Aggregating random stats for all hosts using complex arguments
  ansible.builtin.set_stats:
    data:
      one_stat: 11
      other_stat: "{{ local_var * 2 }}"
      another_stat: "{{ some_registered_var.results | map(attribute='ansible_facts.some_fact') | list }}"
    per_host: no

- name: Setting stats (not aggregating)
  ansible.builtin.set_stats:
    data:
      the_answer: 42
    aggregate: no

Авторы

Brian Coca (@bcoca)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ansible/builtin/set_stats_module.html