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

Новое в версии 2.4.

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

Обзор

Позволяет добавлять, очищать и удалять локальные журналы событий 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`, записи журнала событий очищаются для целевого журнала.

См. также

win_eventlog_entry – Запись записей в журналы событий Windows: Официальная документация модуля win_eventlog_entry.

Примеры

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

- name: Change the category and message resource files used for NewLogSource1
  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
  win_eventlog:
    name: MyNewLog
    maximum_size: 16MB
    overflow_action: DoNotOverwrite
    state: present

- name: Clear event entries for MyNewLog
  win_eventlog:
    name: MyNewLog
    state: clear

- name: Remove NewLogSource2 from MyNewLog
  win_eventlog:
    name: MyNewLog
    sources:
      - NewLogSource2
    state: absent

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

Возвращаемые значения

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

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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Andrew Saraceni (@andrewsaraceni)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/win_eventlog_module.html