< Back

Get-DbaCustomError

Mon Jan 13, 2020 10:30 am

NAME Get-DbaCustomError



SYNOPSIS

Gets SQL Custom Error Message information for each instance(s) of SQL Server.





SYNTAX

Get-DbaCustomError [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]

<Pscredential>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

The Get-DbaCustomError command gets SQL Custom Error Message information for each instance(s) of SQL Server.





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. 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: Error, CustomError

Author: Garry Bargsley (@gbargsley), http://blog.garrybargsley.com



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-DbaCustomError -SqlInstance localhost



Returns all Custom Error Message(s) on the local default SQL Server instance

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-DbaCustomError -SqlInstance localhost, sql2016



Returns all Custom Error Message(s) for the local and sql2016 SQL Server instances



RELATED LINKS

https://dbatools.io/Get-DbaCustomError