Class: Ansible::Ruby::Modules::Win_eventlog

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_eventlog.rb

Overview

Allows the addition, clearing and removal of local Windows event logs, and the creation and removal of sources from a given event log. Also allows the specification of settings per log and source.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#category_file ⇒ String?

Returns For one or more sources specified, the path to a custom category resource file.

Returns:

  • (String, nil) —

    For one or more sources specified, the path to a custom category resource file.



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 24

attribute :category_file

#maximum_size ⇒ String?

Returns The maximum size of the event log.,Value must be between 64KB and 4GB, and divisible by 64KB.,Size can be specified in KB, MB or GB (e.g. 128KB, 16MB, 2.5GB).

Returns:

  • (String, nil) —

    The maximum size of the event log.,Value must be between 64KB and 4GB, and divisible by 64KB.,Size can be specified in KB, MB or GB (e.g. 128KB, 16MB, 2.5GB).



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 36

attribute :maximum_size

#message_file ⇒ String?

Returns For one or more sources specified, the path to a custom event message resource file.

Returns:

  • (String, nil) —

    For one or more sources specified, the path to a custom event message resource file.



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 28

attribute :message_file

#name ⇒ String

Returns Name of the event log to manage.

Returns:

  • (String) —

    Name of the event log to manage.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 12

attribute :name

#overflow_action ⇒ :OverwriteOlder, ...

Returns The action for the log to take once it reaches its maximum size.,For C(OverwriteOlder), new log entries overwrite those older than the C(retention_days) value.,For C(OverwriteAsNeeded), each new entry overwrites the oldest entry.,For C(DoNotOverwrite), all existing entries are kept and new entries are not retained.

Returns:

  • (:OverwriteOlder, :OverwriteAsNeeded, :DoNotOverwrite, nil) —

    The action for the log to take once it reaches its maximum size.,For C(OverwriteOlder), new log entries overwrite those older than the C(retention_days) value.,For C(OverwriteAsNeeded), each new entry overwrites the oldest entry.,For C(DoNotOverwrite), all existing entries are kept and new entries are not retained.



40
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 40

attribute :overflow_action

#parameter_file ⇒ String?

Returns For one or more sources specified, the path to a custom parameter resource file.

Returns:

  • (String, nil) —

    For one or more sources specified, the path to a custom parameter resource file.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 32

attribute :parameter_file

#retention_days ⇒ Integer?

Returns The minimum number of days event entries must remain in the log.,This option is only used when C(overflow_action) is C(OverwriteOlder).

Returns:

  • (Integer, nil) —

    The minimum number of days event entries must remain in the log.,This option is only used when C(overflow_action) is C(OverwriteOlder).



44
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 44

attribute :retention_days

#sources ⇒ Array<String>, ...

Returns A list of one or more sources to ensure are present/absent in the log.,When C(category_file), C(message_file) and/or C(parameter_file) are specified, these values are applied across all sources.

Returns:

  • (Array<String>, String, nil) —

    A list of one or more sources to ensure are present/absent in the log.,When C(category_file), C(message_file) and/or C(parameter_file) are specified, these values are applied across all sources.



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 20

attribute :sources

#state ⇒ :absent, ...

Returns Desired state of the log and/or sources.,When C(sources) is populated, state is checked for sources.,When C(sources) is not populated, state is checked for the specified log itself.,If C(state) is C(clear), event log entries are cleared for the target log.

Returns:

  • (:absent, :clear, :present, nil) —

    Desired state of the log and/or sources.,When C(sources) is populated, state is checked for sources.,When C(sources) is not populated, state is checked for the specified log itself.,If C(state) is C(clear), event log entries are cleared for the target log.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_eventlog.rb', line 16

attribute :state