Purge Event Log

  • Article

Applies To: Opalis 6.3

The Purge Event Log object will clear all the events in any of the Windows Event Logs. The Purge Event Log object allows you to backup the logs to an evt file before they are purged. This object uses a satellite license.

The Purge Event Log can be used in conjunction with Monitor Event Log Capacity object to automatically purge the event log when the disk space used by the event log goes beyond a sustainable level.

Configuring the Purge Event Log Object

To configure the Purge Event Log object you will need to know the specific Windows Event Log that you want to purge. For example, the Application or Security event logs. You will also need to know the computer where the event log is located.

To configure the Purge Event Log object

  1. From the Objects pane, drag a Purge Event Log object to the active Policy.

  2. Double-click the Purge Event Log object icon. The Properties dialog opens.

  3. For information about the settings on the Details tab see the following table.

  4. For information about the settings on the General tab, the Run Behavior tab, and other tabs if applicable, see Common Tabs.

Details Tab

Element Configuration Instructions

Computer

Type the computer where the event log is located. Type localhost to specify the Action Server where the Policy is being processed. You can also use the ellipsis ( ... ) button to browse for the computer.

Log name

Type the name of the Windows Event Log that you are purging. You can also use the ellipsis ( ... ) button to browse for the event log. Browsing is only available if you have specified a valid Computer.

Backup the log before purging it

Select to backup the event log to an evt file prior to purging it.

When purging an event log on a remote computer, the backup of the log will be created at the specified location on the remote computer using the specified File name.

File name

Type the name of the backup file.

If the backup exists

Select the action that you want to take if a backup file with the same name already exists:

  • Create a file with a unique name - Select to append a value to the filename to create a unique name that does not conflict with an existing name.

  • Overwrite - Select to overwrite the existing file with the backup that is being created.

  • Fail - Select to cause the Purge Event Log object to fail if the filename already exists.

Purge Event Log Published Data

The following table lists the element names and descriptions of the data published by this object. For information about the published data elements that are common to all objects, see Policy Workflow Rules.

Element Name Description

Event log name

The name of the event log that was purged.

Computer

The computer where the event log was purged.

Backup filename

The full path of the file where the event log was saved before purging.

Number of Entries

The number of entries that were purged.