commands

^

Get-DbaErrorLog

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Want to see the source code for this command? Check out Get-DbaErrorLog on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaErrorLog.

Synopsis

Gets the "SQL Error Log" of an instance

Description

Gets the "SQL Error Log" of an instance. Returns all 10 error logs by default.

Syntax

Get-DbaErrorLog
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-LogNumber] <Int32[]>]
    [[-Source] <Object[]>]
    [[-Text] <String>]
    [[-After] <DateTime>]
    [[-Before] <DateTime>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaErrorLog -SqlInstance sql01\sharepoint

Returns every log entry from sql01\sharepoint SQL Server instance.

Example: 2
PS C:\> Get-DbaErrorLog -SqlInstance sql01\sharepoint -LogNumber 3, 6

Returns all log entries for log number 3 and 6 on sql01\sharepoint SQL Server instance.

Example: 3
PS C:\> Get-DbaErrorLog -SqlInstance sql01\sharepoint -Source Logon

Returns every log entry, with a source of Logon, from sql01\sharepoint SQL Server instance.

Example: 4
PS C:\> Get-DbaErrorLog -SqlInstance sql01\sharepoint -LogNumber 3 -Text "login failed"

Returns every log entry for log number 3, with "login failed" in the text, from sql01\sharepoint SQL Server instance.

Example: 5
PS C:\> $servers = "sql2014","sql2016", "sqlcluster\sharepoint"
PS C:\> $servers | Get-DbaErrorLog -LogNumber 0

Returns the most recent SQL Server error logs for "sql2014","sql2016" and "sqlcluster\sharepoint"

Example: 6
PS C:\> Get-DbaErrorLog -SqlInstance sql01\sharepoint -After '2016-11-14 00:00:00'

Returns every log entry found after the date 14 November 2016 from sql101\sharepoint SQL Server instance.

Example: 7
PS C:\> Get-DbaErrorLog -SqlInstance sql01\sharepoint -Before '2016-08-16 00:00:00'

Returns every log entry found before the date 16 August 2016 from sql101\sharepoint SQL Server instance.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required False
Pipeline true (ByValue)
Default Value
-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-LogNumber

An Int32 value that specifies the index number of the error log required.
Error logs are listed 0 through 99, where 0 is the current error log and 99 is potential oldest log file.
SQL Server errorlog rollover defaults to 6, but can be increased to 99. https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/scm-services-configure-sql-server-error-logs

Alias
Required False
Pipeline false
Default Value
-Source

Filter results based on the Source of the error (e.g. Logon, Server, etc.)

Alias
Required False
Pipeline false
Default Value
-Text

Filter results based on a pattern of text (e.g. "login failed", "error: 12345").

Alias
Required False
Pipeline false
Default Value
-After

Filter the results based on datetime value.

Alias
Required False
Pipeline false
Default Value
-Before

Filter the results based on datetime value.

Alias
Required False
Pipeline false
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False