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

Примечание

Этот модуль входит в коллекцию ansible.windows (версия 3.6.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install ansible.windows.

Чтобы использовать её в плейбуке, укажите: ansible.windows.win_eventlog.

Добавлено в ansible.windows 2.6.0

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

Краткое описание

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

Параметры

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

См. также

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

Примеры

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

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

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

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

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

- name: Set retention policy for MyNewLog to 15 days
  ansible.windows.win_eventlog:
    name: MyNewLog
    retention_days: 15
    state: present

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

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

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

Авторы

Andrew Saraceni (@andrewsaraceni)

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

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