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

Примечание

Этот модуль является частью коллекции community.windows (версия 2.3.0).

У вас может уже быть установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

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

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

Обзор

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

Параметры

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

См. также

community.windows.win_eventlog_entry: Запись записей в журналы событий Windows.

Примеры

- 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

END_OF_DOCUMENT_MARKER

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

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

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

Авторы

Andrew Saraceni (@andrewsaraceni)

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

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