< Back
Copy-DbaCustomError
Post
NAME Copy-DbaCustomError
SYNOPSIS
Copy-DbaCustomError migrates custom errors (user defined messages), by the custom error ID, from one SQL Server to
another.
SYNTAX
Copy-DbaCustomError [-Source] <DbaInstanceParameter> [[-SourceSqlCredential] <Pscredential>] [-Destination]
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-DestinationSqlCredential] <Pscredential>]
[[-CustomError] <System.Object[]>] [[-ExcludeCustomError] <System.Object[]>] [-Force <Switch>] [-EnableException
<Switch>] [<CommonParameters>]
DESCRIPTION
By default, all custom errors are copied. The -CustomError parameter is auto-populated for command-line completion
and can be used to copy only specific custom errors.
If the custom error already exists on the destination, it will be skipped unless -Force is used. The us_english
version must be created first. If you drop the us_english version, all the other languages will be dropped for
that specific ID as well.
PARAMETERS
-CustomError [<System.Object[]>]
The custom error(s) to process. This list is auto-populated from the server. If unspecified, all custom errors
will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Destination [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
Destination SQL Server. You must have sysadmin access and the server must be SQL Server 2000 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-DestinationSqlCredential [<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
-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
-ExcludeCustomError [<System.Object[]>]
The custom error(s) to exclude. This list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
If this switch is enabled, the custom error will be dropped and recreated if it already exists on Destination.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Source [<DbaInstanceParameter>]
Source SQL Server. 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
-SourceSqlCredential [<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
<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: Migration, CustomError
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
Requires: sysadmin access on SQL Servers
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -Destination sqlcluster
Copies all server custom errors from sqlserver2014a to sqlcluster using Windows credentials. If custom errors with
the same name exist on sqlcluster, they will be skipped.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -SourceSqlCredential $scred -Destination sqlcluster
-DestinationSqlCredential $dcred -CustomError 60000 -Force
Copies only the custom error with ID number 60000 from sqlserver2014a to sqlcluster using SQL credentials for
sqlserver2014a and Windows credentials for sqlcluster. If a custom error with the same name exists on sqlcluster,
it will be updated because -Force was used.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -Destination sqlcluster -ExcludeCustomError 60000 -Force
Copies all the custom errors found on sqlserver2014a except the custom error with ID number 60000 to sqlcluster.
If a custom error with the same name exists on sqlcluster, it will be updated because -Force was used.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
Shows what would happen if the command were executed using force.
RELATED LINKS
https://dbatools.io/Copy-DbaCustomError
SYNOPSIS
Copy-DbaCustomError migrates custom errors (user defined messages), by the custom error ID, from one SQL Server to
another.
SYNTAX
Copy-DbaCustomError [-Source] <DbaInstanceParameter> [[-SourceSqlCredential] <Pscredential>] [-Destination]
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-DestinationSqlCredential] <Pscredential>]
[[-CustomError] <System.Object[]>] [[-ExcludeCustomError] <System.Object[]>] [-Force <Switch>] [-EnableException
<Switch>] [<CommonParameters>]
DESCRIPTION
By default, all custom errors are copied. The -CustomError parameter is auto-populated for command-line completion
and can be used to copy only specific custom errors.
If the custom error already exists on the destination, it will be skipped unless -Force is used. The us_english
version must be created first. If you drop the us_english version, all the other languages will be dropped for
that specific ID as well.
PARAMETERS
-CustomError [<System.Object[]>]
The custom error(s) to process. This list is auto-populated from the server. If unspecified, all custom errors
will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Destination [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
Destination SQL Server. You must have sysadmin access and the server must be SQL Server 2000 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-DestinationSqlCredential [<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
-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
-ExcludeCustomError [<System.Object[]>]
The custom error(s) to exclude. This list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
If this switch is enabled, the custom error will be dropped and recreated if it already exists on Destination.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Source [<DbaInstanceParameter>]
Source SQL Server. 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
-SourceSqlCredential [<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
<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: Migration, CustomError
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
Requires: sysadmin access on SQL Servers
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -Destination sqlcluster
Copies all server custom errors from sqlserver2014a to sqlcluster using Windows credentials. If custom errors with
the same name exist on sqlcluster, they will be skipped.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -SourceSqlCredential $scred -Destination sqlcluster
-DestinationSqlCredential $dcred -CustomError 60000 -Force
Copies only the custom error with ID number 60000 from sqlserver2014a to sqlcluster using SQL credentials for
sqlserver2014a and Windows credentials for sqlcluster. If a custom error with the same name exists on sqlcluster,
it will be updated because -Force was used.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -Destination sqlcluster -ExcludeCustomError 60000 -Force
Copies all the custom errors found on sqlserver2014a except the custom error with ID number 60000 to sqlcluster.
If a custom error with the same name exists on sqlcluster, it will be updated because -Force was used.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Copy-DbaCustomError -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
Shows what would happen if the command were executed using force.
RELATED LINKS
https://dbatools.io/Copy-DbaCustomError