W3cubDocs

/Ansible

win_eventlog_entry - Write entries to Windows event logs

New in version 2.4.

Synopsis

  • Write log entries to a given event log from a specified source.

Options

parameter required default choices comments
category
 no
A numeric task category associated with the category message file for the log source.
entry_type
 no
  • Error
  • FailureAudit
  • Information
  • SuccessAudit
  • Warning
Indicates the entry being written to the log is of a specific type.
event_id
 yes
The numeric event identifier for the entry.
Value must be between 0 and 65535.
log
 yes
Name of the event log to write an entry to.
message
 yes
The message for the given log entry.
raw_data
 no
Binary data associated with the log entry.
Value must be a comma-separated array of 8-bit unsigned integers (0 to 255).
source
 yes
Name of the log source to indicate where the entry is from.

Examples

- name: Write an entry to a Windows event log
  win_eventlog_entry:
    log: MyNewLog
    source: NewLogSource1
    event_id: 1234
    message: This is a test log entry.

- name: Write another entry to a different Windows event log
  win_eventlog_entry:
    log: AnotherLog
    source: MyAppSource
    event_id: 5000
    message: An error has occurred.
    entry_type: Error
    category: 5
    raw_data: 10,20

Notes

Note

  • This module will always report a change when writing an event entry.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/win_eventlog_entry_module.html