Get-ErrorLog

DBSystems: Gets SQL Server error logs

Script

#Requires -Version 5.0
#Requires -Modules SQLServer

[CmdLetBinding()]
Param(
    [Parameter(Mandatory = $true)]   
    [string]$ServerInstance,    
    [pscredential]$ServerCredential,
    [datetime]$After,
    [datetime]$Before,
    [switch]$Ascending,
    [ValidateSet('Midnight', 'Yesterday', 'LastWeek','LastMonth')]
    [string]$Since,
    [int]$ConnectionTimeout = 30,
    [ValidateSet('*','Date','Source','Text','ServerInstance')]
    [string[]]$Properties = @('Date','Source','Text','ServerInstance')
)

function Get-SqlServerInstanceInternal {
    [CmdLetBinding()]
    Param(
        [Parameter(Mandatory = $true)]   
        [string]$ServerInstance,    
        [pscredential]$ServerCredential,
        [int]$ConnectionTimeout = 30
    )
    try {
        [hashtable]$cmdArgs = @{
            'ErrorAction' = 'Stop'
            'Confirm' = $false
            'ServerInstance' = $ServerInstance
            'ConnectionTimeout' = $ConnectionTimeout
        }
        if ($null -ne $ServerCredential) {
            $cmdArgs.Add('Credential', $ServerCredential)
        }
        return Get-SqlInstance @cmdArgs
    } catch {
        throw
    }
}

Import-Module SQLServer

try {
    if ($Properties -contains '*') {
        $Properties = @('*')
    }
    
    $instance = Get-SqlServerInstanceInternal -ServerInstance $ServerInstance -ServerCredential $ServerCredential -ConnectionTimeout $ConnectionTimeout

    [hashtable]$cmdArgs = @{
        'ErrorAction' = 'Stop'
        'InputObject' = $instance
        'Ascending' = $Ascending.ToBool()
    }
    
    if ($null -ne $After) {
        $cmdArgs.Add("After", $After)
    }
    if ($null -ne $Before) {
        $cmdArgs.Add("Before", $Before)
    }
    if (-not $After -and -not $Before -and -not [string]::IsNullOrWhiteSpace($Since)) {
        $cmdArgs.Add("Since", $Since)
    }  
    
    $result = Get-SqlErrorLog @cmdArgs | Select-Object $Properties
    Write-Output $result
} catch {
    throw
}

Customize

ServerInstance string

Specifies the name of the target computer including the instance name, e.g. MyServer\Instance

ServerCredential pscredential

Specifies a PSCredential object for the connection to the SQL Server. ServerCredential is ONLY used for SQL Logins. When you are using Windows Authentication you don't specify -Credential. It is picked up from your current login.

After datetime

Specifies that this cmdlet only gets error logs generated after the given time

Before datetime

Specifies that this cmdlet only gets error logs generated before the given time

Ascending switch

Off

Indicates that the cmdlet sorts the collection of error logs by the log date in ascending order

Since string

Specifies an abbreviation for the Timespan parameter

ConnectionTimeout int

Specifies the time period to retry the command on the target server

Properties string

List of properties to expand, comma separated e.g. Name,Status. Use * for all properties