< Back
Get-DbaAgentLog
Post
NAME Get-DbaAgentLog
SYNOPSIS
Gets the "SQL Agent Error Log" of an instance
SYNTAX
Get-DbaAgentLog [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-LogNumber] <System.Int32[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets the "SQL Agent Error Log" of an instance. Returns all 10 error logs by default.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-LogNumber [<System.Int32[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Logging
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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"
RELATED LINKS
https://dbatools.io/Get-DbaAgentLog
SYNOPSIS
Gets the "SQL Agent Error Log" of an instance
SYNTAX
Get-DbaAgentLog [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-LogNumber] <System.Int32[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets the "SQL Agent Error Log" of an instance. Returns all 10 error logs by default.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-LogNumber [<System.Int32[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Logging
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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"
RELATED LINKS
https://dbatools.io/Get-DbaAgentLog