Get-LogProperties.md

external help file	PSDiagnostics-help.xml
Locale	en-US
Module Name	PSDiagnostics
ms.date	12/12/2022
online version	https://learn.microsoft.com/powershell/module/psdiagnostics/get-logproperties?view=powershell-7.6&WT.mc_id=ps-gethelp
schema	2.0.0
title	Get-LogProperties

Get-LogProperties

SYNOPSIS

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: System.Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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.

INPUTS

System.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.

NOTES

RELATED LINKS

Set-LogProperties

Enable-PSTrace

Disable-PSTrace