---
title: "Invoke-DbaCycleErrorLog"
description: "Cycles the current SQL Server error log and/or SQL Agent error log to start fresh log files"
url: "https://dbatools.io/Invoke-DbaCycleErrorLog/"
availability: "Windows, Linux, macOS"
tags: ["Instance", "ErrorLog", "Logging"]
author: "Shawn Melton (@wsmelton), wsmelton.github.io"
source: "https://github.com/dataplat/dbatools/blob/master/public/Invoke-DbaCycleErrorLog.ps1"
last_updated: "2024-01-01"
---

# Invoke-DbaCycleErrorLog

## Synopsis

Cycles the current SQL Server error log and/or SQL Agent error log to start fresh log files

## Description

Archives the current error log files and creates new ones for SQL Server instance and/or SQL Agent. This operation is typically performed during maintenance windows to manage log file sizes and establish clean baselines for troubleshooting. When cycled, the current error log becomes the archived log (errorlog.1) and a new error log starts capturing events.

## Syntax

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

```

## Examples

### Example 1: Cycles the current error log for the SQL Server Agent on SQL Server instance sql2016

```powershell
PS C:\> Invoke-DbaCycleErrorLog -SqlInstance sql2016 -Type agent
```

### Example 2: Cycles the current error log for the SQL Server instance on SQL Server instance sql2016

```powershell
PS C:\> Invoke-DbaCycleErrorLog -SqlInstance sql2016 -Type instance
```

### Example 3: Cycles the current error log for both SQL Server instance and SQL Server Agent on SQL Server instance sql2016

```powershell
PS C:\> Invoke-DbaCycleErrorLog -SqlInstance 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.

| Property | Value |
| --- | --- |
| 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.

| Property | Value |
| --- | --- |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Type

Specifies which error log to cycle: 'instance' for SQL Server instance log, 'agent' for SQL Agent log.  
When omitted, cycles both logs simultaneously which is the typical maintenance approach.  
Use specific values when you need to manage log sizes independently or troubleshoot specific services.

| Property | Value |
| --- | --- |
| 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.

| Property | Value |
| --- | --- |
| 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.

| Property | Value |
| --- | --- |
| 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.

| Property | Value |
| --- | --- |
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |  |

## Outputs

**PSCustomObject**

Returns one object per instance processed with error log cycling results.

**Properties:**

- ComputerName: The computer name of the SQL Server instance
- InstanceName: The SQL Server instance name
- SqlInstance: The full SQL Server instance name (computer\instance)
- LogType: String array of log types that were cycled (contains 'instance', 'agent', or both)
- IsSuccessful: Boolean indicating if the error log cycling was successful
- Notes: Exception object if operation failed, null if successful

---

Part of [dbatools](https://dbatools.io/), a free and open source PowerShell module for SQL Server administration. Full command index: https://dbatools.io/commands/