< Back
Copy-DbaAgentJobCategory
Post
NAME Copy-DbaAgentJobCategory
SYNOPSIS
Copy-DbaAgentJobCategory migrates SQL Agent categories from one SQL Server to another. This is similar to
sp_add_category.
https://msdn.microsoft.com/en-us/library/ms181597.aspx
SYNTAX
Copy-DbaAgentJobCategory -Source <DbaInstanceParameter> [-SourceSqlCredential <Pscredential>] -Destination
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-DestinationSqlCredential <Pscredential>]
[-JobCategory <System.String[]>] [-AgentCategory <System.String[]>] [-OperatorCategory <System.String[]>] [-Force
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
Copy-DbaAgentJobCategory -Source <DbaInstanceParameter> [-SourceSqlCredential <Pscredential>] -Destination
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-DestinationSqlCredential <Pscredential>]
[-CategoryType <System.String[]>] [-JobCategory <System.String[]>] [-AgentCategory <System.String[]>]
[-OperatorCategory <System.String[]>] [-Force <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
By default, all SQL Agent categories for Jobs, Operators and Alerts are copied.
The -OperatorCategories parameter is auto-populated for command-line completion and can be used to copy only
specific operator categories.
The -AgentCategories parameter is auto-populated for command-line completion and can be used to copy only specific
agent categories.
The -JobCategories parameter is auto-populated for command-line completion and can be used to copy only specific
job categories.
If the category already exists on the destination, it will be skipped unless -Force is used.
PARAMETERS
-AgentCategory [<System.String[]>]
This parameter is auto-populated for command-line completion and can be used to copy only specific agent
categories.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CategoryType [<System.String[]>]
Specifies the Category Type to migrate. Valid options are "Job", "Alert" and "Operator". When CategoryType is
specified, all categories from the selected type will be migrated. For granular migrations, use the three
parameters below.
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
-Force [<Switch>]
If this switch is enabled, the Category will be dropped and recreated on Destination.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-JobCategory [<System.String[]>]
This parameter is auto-populated for command-line completion and can be used to copy only specific job
categories.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-OperatorCategory [<System.String[]>]
This parameter is auto-populated for command-line completion and can be used to copy only specific operator
categories.
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, Agent
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-DbaAgentJobCategory -Source sqlserver2014a -Destination sqlcluster
Copies all operator categories from sqlserver2014a to sqlcluster using Windows authentication. If operator
categories with the same name exist on sqlcluster, they will be skipped.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Copy-DbaAgentJobCategory -Source sqlserver2014a -Destination sqlcluster -OperatorCategory PSOperator
-SourceSqlCredential $cred -Force
Copies a single operator category, the PSOperator operator category from sqlserver2014a to sqlcluster using SQL
credentials to authenticate to sqlserver2014a and Windows credentials for sqlcluster. If an operator category with
the same name exists on sqlcluster, it will be dropped and recreated because -Force was used.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Copy-DbaAgentJobCategory -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
Shows what would happen if the command were executed using force.
RELATED LINKS
https://dbatools.io/Copy-DbaAgentJobCategory
SYNOPSIS
Copy-DbaAgentJobCategory migrates SQL Agent categories from one SQL Server to another. This is similar to
sp_add_category.
https://msdn.microsoft.com/en-us/library/ms181597.aspx
SYNTAX
Copy-DbaAgentJobCategory -Source <DbaInstanceParameter> [-SourceSqlCredential <Pscredential>] -Destination
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-DestinationSqlCredential <Pscredential>]
[-JobCategory <System.String[]>] [-AgentCategory <System.String[]>] [-OperatorCategory <System.String[]>] [-Force
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
Copy-DbaAgentJobCategory -Source <DbaInstanceParameter> [-SourceSqlCredential <Pscredential>] -Destination
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-DestinationSqlCredential <Pscredential>]
[-CategoryType <System.String[]>] [-JobCategory <System.String[]>] [-AgentCategory <System.String[]>]
[-OperatorCategory <System.String[]>] [-Force <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
By default, all SQL Agent categories for Jobs, Operators and Alerts are copied.
The -OperatorCategories parameter is auto-populated for command-line completion and can be used to copy only
specific operator categories.
The -AgentCategories parameter is auto-populated for command-line completion and can be used to copy only specific
agent categories.
The -JobCategories parameter is auto-populated for command-line completion and can be used to copy only specific
job categories.
If the category already exists on the destination, it will be skipped unless -Force is used.
PARAMETERS
-AgentCategory [<System.String[]>]
This parameter is auto-populated for command-line completion and can be used to copy only specific agent
categories.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CategoryType [<System.String[]>]
Specifies the Category Type to migrate. Valid options are "Job", "Alert" and "Operator". When CategoryType is
specified, all categories from the selected type will be migrated. For granular migrations, use the three
parameters below.
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
-Force [<Switch>]
If this switch is enabled, the Category will be dropped and recreated on Destination.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-JobCategory [<System.String[]>]
This parameter is auto-populated for command-line completion and can be used to copy only specific job
categories.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-OperatorCategory [<System.String[]>]
This parameter is auto-populated for command-line completion and can be used to copy only specific operator
categories.
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, Agent
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-DbaAgentJobCategory -Source sqlserver2014a -Destination sqlcluster
Copies all operator categories from sqlserver2014a to sqlcluster using Windows authentication. If operator
categories with the same name exist on sqlcluster, they will be skipped.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Copy-DbaAgentJobCategory -Source sqlserver2014a -Destination sqlcluster -OperatorCategory PSOperator
-SourceSqlCredential $cred -Force
Copies a single operator category, the PSOperator operator category from sqlserver2014a to sqlcluster using SQL
credentials to authenticate to sqlserver2014a and Windows credentials for sqlcluster. If an operator category with
the same name exists on sqlcluster, it will be dropped and recreated because -Force was used.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Copy-DbaAgentJobCategory -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
Shows what would happen if the command were executed using force.
RELATED LINKS
https://dbatools.io/Copy-DbaAgentJobCategory