Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
288 changes: 144 additions & 144 deletions Docs/Clear-EVXLog.md
Original file line number Diff line number Diff line change
@@ -1,144 +1,144 @@
---
external help file: PSEventViewer-help.xml
Module Name: PSEventViewer
online version: https://github.com/EvotecIT/PSEventViewer
schema: 2.0.0
---
# Clear-EVXLog
## SYNOPSIS
Clears Windows Event Log channels through the native engine.

Supports local or remote channels, explicit credentials, and an optional native EVTX backup. Failures are terminating and retain their Windows error code.

## SYNTAX
### __AllParameterSets
```powershell
Clear-EVXLog [-LogName] <string[]> [-MachineName <string[]>] [-BackupPath <string>] [-Credential <pscredential>] [-Authentication <EventLogAuthentication>] [-TimeoutMs <int>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Clears Windows Event Log channels through the native engine.

Supports local or remote channels, explicit credentials, and an optional native EVTX backup. Failures are terminating and retain their Windows error code.

## EXAMPLES

### EXAMPLE 1
```powershell
Clear-EVXLog -LogName Application -BackupPath C:\Backups\Application.evtx
```

Windows writes the backup before clearing the channel.

## PARAMETERS

### -Authentication
Authentication package for the remote session.

```yaml
Type: EventLogAuthentication
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Default, Negotiate, Kerberos, Ntlm

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -BackupPath
Optional backup EVTX path. This requires exactly one LogName.

```yaml
Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Credential
Credentials for the remote session.

```yaml
Type: PSCredential
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LogName
Channel names to clear.

```yaml
Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -MachineName
Remote computer. Omit for local.

```yaml
Type: String[]
Parameter Sets: __AllParameterSets
Aliases: ComputerName, ServerName
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -TimeoutMs
Maximum time for remote RPC preflight and session establishment.

```yaml
Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

- `System.String[]`

## OUTPUTS

- `EventViewerX.EventLogClearResult`

## RELATED LINKS

- None
---
external help file: PSEventViewer-help.xml
Module Name: PSEventViewer
online version: https://github.com/EvotecIT/PSEventViewer
schema: 2.0.0
---
# Clear-EVXLog
## SYNOPSIS
Clears Windows Event Log channels through the native engine.
Supports local or remote channels, explicit credentials, and an optional native EVTX backup. Failures are terminating and retain their Windows error code.
## SYNTAX
### __AllParameterSets
```powershell
Clear-EVXLog [-LogName] <string[]> [-MachineName <string[]>] [-BackupPath <string>] [-Credential <pscredential>] [-Authentication <EventLogAuthentication>] [-TimeoutMs <int>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Clears Windows Event Log channels through the native engine.
Supports local or remote channels, explicit credentials, and an optional native EVTX backup. Failures are terminating and retain their Windows error code.
## EXAMPLES
### EXAMPLE 1
```powershell
Clear-EVXLog -LogName Application -BackupPath C:\Backups\Application.evtx
```
Windows writes the backup before clearing the channel.
## PARAMETERS
### -Authentication
Authentication package for the remote session.
```yaml
Type: EventLogAuthentication
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Default, Negotiate, Kerberos, Ntlm
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -BackupPath
Optional backup EVTX path. This requires exactly one LogName.
```yaml
Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Credential
Credentials for the remote session.
```yaml
Type: PSCredential
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -LogName
Channel names to clear.
```yaml
Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -MachineName
Remote computer. Omit for local.
```yaml
Type: String[]
Parameter Sets: __AllParameterSets
Aliases: ComputerName, ServerName
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -TimeoutMs
Maximum time for remote RPC preflight and session establishment.
```yaml
Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
- `System.String[]`
## OUTPUTS
- `EventViewerX.EventLogClearResult`
## RELATED LINKS
- None
64 changes: 0 additions & 64 deletions Docs/ConvertTo-EVXProviderDefinition.md

This file was deleted.

5 changes: 2 additions & 3 deletions Docs/Custom-Providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ $provider = @{
}
}

$definition = $provider | ConvertTo-EVXProviderDefinition
$validation = $definition | Test-EVXProviderDefinition
$validation = $provider | Test-EVXProviderDefinition
if (-not $validation.IsValid) {
$validation.Errors
throw 'Provider definition is invalid.'
Expand Down Expand Up @@ -377,7 +376,7 @@ active package repairs missing registration or modified extracted files and
reports `Repaired`.

```powershell
Get-EVXProviderPackage |
Get-EVXProvider -InstalledPackage |
Where-Object ProviderName -eq Contoso.Scanner |
Select-Object ProviderName, PackageVersion, IsActive, IsRegistered,
IsSigned, SignerThumbprint, PackagePath
Expand Down
4 changes: 2 additions & 2 deletions Docs/EventViewerX-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,9 +266,9 @@ var query = new NamedEventQuery(new[] {
MachineNames = new string?[] { "DC01", "DC02" }
};

await foreach (EventObjectSlim item in NamedEventEngine.ReadAsync(query)) {
await foreach (NamedEventRecord item in NamedEventEngine.ReadAsync(query)) {
Console.WriteLine(
$"{item.Type} {item.EventID} {item.GatheredFrom}");
$"{item.NamedEventName} {item.EventId} {item.MachineName}");
}
```

Expand Down
Loading