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

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

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

Обзор

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

Параметры

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

Примеры

- 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	Количество записей, присутствующих в журнале событий.	успех	int	50
exists	Существует ли журнал событий или нет.	успех	boolean	True
maximum_size_kb	Максимальный размер журнала в КБ.	успех	int	512
name	Имя журнала событий.	всегда	строка	MyNewLog
overflow_action	Действие, которое журнал выполняет при достижении максимального размера.	успех	строка	OverwriteOlder
retention_days	Минимальное количество дней, в течение которых записи сохраняются в журнале.	успех	int	7
sources	Список текущих источников для журнала.	успех	список	['MyNewLog', 'NewLogSource1', 'NewLogSource2']
sources_changed	Список измененных источников (например, созданных/пересозданных, удаленных) для журнала; пусто, если источники не изменены.	всегда	список	['NewLogSource2']

Состояние

Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантирует обратную совместимость.

Для получения помощи в разработке модулей, если вы захотите, пожалуйста, прочтите Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.

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