< Back
Invoke-DbaCycleErrorLog
Post
NAME Invoke-DbaCycleErrorLog
SYNOPSIS
Cycles the current instance or agent log.
SYNTAX
Invoke-DbaCycleErrorLog [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Type] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Cycles the current error log for the instance (SQL Server) and/or SQL Server Agent.
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
-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.You must have sysadmin access and server version must be SQL
Server version 2000 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<String>]
The log to cycle.
Accepts: instance or agent.
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: Log, Cycle
Author: Shawn Melton (@wsmelton), https://wsmelton.github.io
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Invoke-DbaCycleLog -SqlInstance sql2016 -Type agent
Cycles the current error log for the SQL Server Agent on SQL Server instance sql2016
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Invoke-DbaCycleLog -SqlInstance sql2016 -Type instance
Cycles the current error log for the SQL Server instance on SQL Server instance sql2016
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Invoke-DbaCycleLog -SqlInstance sql2016
Cycles the current error log for both SQL Server instance and SQL Server Agent on SQL Server instance sql2016
RELATED LINKS
https://dbatools.io/Invoke-DbaCycleLog
SYNOPSIS
Cycles the current instance or agent log.
SYNTAX
Invoke-DbaCycleErrorLog [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Type] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Cycles the current error log for the instance (SQL Server) and/or SQL Server Agent.
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
-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.You must have sysadmin access and server version must be SQL
Server version 2000 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<String>]
The log to cycle.
Accepts: instance or agent.
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: Log, Cycle
Author: Shawn Melton (@wsmelton), https://wsmelton.github.io
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Invoke-DbaCycleLog -SqlInstance sql2016 -Type agent
Cycles the current error log for the SQL Server Agent on SQL Server instance sql2016
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Invoke-DbaCycleLog -SqlInstance sql2016 -Type instance
Cycles the current error log for the SQL Server instance on SQL Server instance sql2016
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Invoke-DbaCycleLog -SqlInstance sql2016
Cycles the current error log for both SQL Server instance and SQL Server Agent on SQL Server instance sql2016
RELATED LINKS
https://dbatools.io/Invoke-DbaCycleLog