commands

^

Invoke-DbaCycleErrorLog

Author Shawn Melton (@wsmelton), https://wsmelton.github.io
Availability Windows, Linux, macOS

 

Synopsis

Cycles the current instance or agent log.

Description

Cycles the current error log for the instance (SQL Server) and/or SQL Server Agent.

Syntax

Invoke-DbaCycleErrorLog
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Type] <String>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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

Required Parameters

-SqlInstance

The target SQL Server instance or instances.You must have sysadmin access and server version must be SQL Server version 2000 or higher.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-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
-Type

The log to cycle. Accepts: instance or agent.

Alias
Required False
Pipeline false
Default Value
Accepted Values instance,agent
-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
-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

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