Edit

Share via

Get-LogProperties

  • Reference
Module:
PSDiagnostics

Retrieves the properties of a Windows event log.

Syntax

Get-LogProperties
   [-Name] <Object>
   [<CommonParameters>]

Description

This cmdlet is only available on the Windows platform.

This cmdlet gets the configuration settings of a Windows event log. This cmdlet is used by the Enable-PSTrace and Disable-PSTrace cmdlets.

Examples

Example 1: Get the configuration settings of the Windows PowerShell event log

Get-LogProperties 'Windows PowerShell'

Name       : Windows PowerShell
Enabled    : True
Type       : Admin
Retention  : False
AutoBackup : False
MaxLogSize : 15728640

Parameters

-Name

The name of the event provider.

Type:Object
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

You can pipe a string containing the name of a log provider to this cmdlet.

Outputs

Microsoft.PowerShell.Diagnostics.LogDetails

This cmdlet returns a LogDetails object.

The PSDiagnostics module adds the LogDetails class to the Microsoft.PowerShell.Diagnostics namespace.