commands

^

Get-DbaAgentLog

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

 

Synopsis

Gets the "SQL Agent Error Log" of an instance

Description

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

Syntax

Get-DbaAgentLog
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-LogNumber] <Int32[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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

Returns the entire error log for the SQL Agent on sql01\sharepoint

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

Returns log numbers 3 and 6 for the SQL Agent on sql01\sharepoint

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

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

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server 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 9 where 0 is the current error log and 9 is the oldest.

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

 

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