Set Event Log Retentions
Set the rollover interval for the configured event log file.
Privileges
Elevated - run as administrator.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| LogName | String | Yes | The name of the log where the retention interval will be set. |
| When maximum event log size is reached | Selection | Yes | Selection of options to perform when the maximum event log sized is reached. |
| Retain Days | Number | No | The number of days to retain the log data. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number |
Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Log Name | String | Yes | Application |
| When maximum event log size is reached | Selector | Yes | Overwrite events as Needed (oldest events first) |
| Retain Days | Number | Yes | 7 |