community.windows.win_eventlog – Управление журналами событий Windows

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Для использования в playbook, укажите: community.windows.win_eventlog.

Обзор
Параметры
См. также
Примеры
Значения возврата

Обзор

Позволяет добавлять, очищать и удалять локальные журналы событий Windows, а также создавать и удалять источники в заданном журнале событий. Также позволяет задавать параметры для каждого журнала и источника.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
category_file путь		Для одного или нескольких указанных источников путь к файлу ресурсов пользовательской категории.
maximum_size строка		Максимальный размер журнала событий. Значение должно быть между 64 КБ и 4 ГБ и кратно 64 КБ. Размер можно указать в КБ, МБ или ГБ (например, 128 КБ, 16 МБ, 2,5 ГБ).
message_file путь		Для одного или нескольких указанных источников путь к файлу ресурсов пользовательских сообщений.
name строка / обязательно		Имя журнала событий, который нужно управлять.
overflow_action строка	Варианты: DoNotOverwrite OverwriteAsNeeded OverwriteOlder	Действие, которое выполняется журналом, когда он достигнет максимального размера. Для `DoNotOverwrite`, все существующие записи сохраняются, и новые записи не сохраняются. Для `OverwriteAsNeeded`, каждая новая запись перезаписывает самую старую запись. Для `OverwriteOlder`, новые записи журнала перезаписывают записи, старше, чем значение `retention_days`.
parameter_file путь		Для одного или нескольких указанных источников путь к файлу ресурсов пользовательских параметров.
retention_days целое число		Минимальное количество дней, в течение которых записи событий должны оставаться в журнале. Этот параметр используется только когда `overflow_action` равен `OverwriteOlder`.
sources список / элементы=строка		Список из одного или нескольких источников, присутствие/отсутствие которых в журнале необходимо гарантировать. Когда `category_file`, `message_file` и/или `parameter_file` указаны, эти значения применяются ко всем источникам.
state строка	Варианты: absent clear present ←	Желаемое состояние журнала и/или источников. Когда `sources` заполнен, состояние проверяется для источников. Когда `sources` не заполнен, состояние проверяется для указанного журнала. Если `state` равен `clear`, записи журнала событий очищаются для целевого журнала.

См. также

community.windows.win_eventlog_entry: Официальная документация по модулю community.windows.win_eventlog_entry.

Примеры

- name: Add a new event log with two custom sources
  community.windows.win_eventlog:
    name: MyNewLog
    sources:
      - NewLogSource1
      - NewLogSource2
    state: present

- name: Change the category and message resource files used for NewLogSource1
  community.windows.win_eventlog:
    name: MyNewLog
    sources:
      - NewLogSource1
    category_file: C:\NewApp\CustomCategories.dll
    message_file: C:\NewApp\CustomMessages.dll
    state: present

- name: Change the maximum size and overflow action for MyNewLog
  community.windows.win_eventlog:
    name: MyNewLog
    maximum_size: 16MB
    overflow_action: DoNotOverwrite
    state: present

- name: Clear event entries for MyNewLog
  community.windows.win_eventlog:
    name: MyNewLog
    state: clear

- name: Remove NewLogSource2 from MyNewLog
  community.windows.win_eventlog:
    name: MyNewLog
    sources:
      - NewLogSource2
    state: absent

- name: Remove MyNewLog and all remaining sources
  community.windows.win_eventlog:
    name: MyNewLog
    state: absent

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Возвращаемое значение	Описание
entries целое число	success	Количество записей в журнале событий. Пример: 50
exists булево	success	Существует ли журнал событий. Пример: True
maximum_size_kb целое число	success	Максимальный размер журнала в КБ. Пример: 512
name строка	всегда	Имя журнала событий. Пример: MyNewLog
overflow_action строка	success	Действие, выполняемое журналом при достижении максимального размера. Пример: OverwriteOlder
retention_days целое число	success	Минимальное количество дней, в течение которых записи сохраняются в журнале. Пример: 7
sources список / элементы=строка	success	Список текущих источников для журнала. Пример: ['MyNewLog', 'NewLogSource1', 'NewLogSource2']
sources_changed список / элементы=строка	всегда	Список изменённых источников (например, созданных/пересозданных, удалённых) для журнала; пусто, если источники не изменены. Пример: ['NewLogSource2']

Авторы

Andrew Saraceni (@andrewsaraceni)

© 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/community/windows/win_eventlog_module.html