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	Варианты: absent clear present ←	Желаемое состояние журнала и/или источников. Если `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	success	Количество записей, присутствующих в журнале событий. Пример: 50
exists boolean	success	Существует ли журнал событий или нет. Пример: True
maximum_size_kb int	success	Максимальный размер журнала в КБ. Пример: 512
name string	всегда	Имя журнала событий. Пример: МойНовыйЖурнал
overflow_action string	success	Действие журнала при достижении максимального размера. Пример: OverwriteOlder
retention_days int	success	Минимальное количество дней, в течение которых записи сохраняются в журнале. Пример: 7
sources list	success	Список текущих источников для журнала. Пример: ['МойНовыйЖурнал', 'НовыйИсточникЖурнала1', 'НовыйИсточникЖурнала2']
sources_changed list	всегда	Список измененных источников (например, пересозданных, удаленных) для журнала; он пуст, если источники не изменены. Пример: ['НовыйИсточникЖурнала2']

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Для получения списка других модулей, которые также поддерживаются сообществом 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.6/modules/win_eventlog_module.html