commands

^

Copy-DbaAgentJobCategory

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

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

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.

Syntax

Copy-DbaAgentJobCategory -Source <DbaInstanceParameter>
    [-SourceSqlCredential <PSCredential>] -Destination <DbaInstanceParameter[]>
    [-DestinationSqlCredential <PSCredential>]
    [-JobCategory <String[]>]
    [-AgentCategory <String[]>]
    [-OperatorCategory <String[]>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Copy-DbaAgentJobCategory -Source <DbaInstanceParameter>
    [-SourceSqlCredential <PSCredential>] -Destination <DbaInstanceParameter[]>
    [-DestinationSqlCredential <PSCredential>]
    [-CategoryType <String[]>]
    [-JobCategory <String[]>]
    [-AgentCategory <String[]>]
    [-OperatorCategory <String[]>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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.

Required Parameters

-Source

Source SQL Server. You must have sysadmin access and server version must be SQL Server version 2000 or higher.

Alias
Required True
Pipeline false
Default Value
-Destination

Destination SQL Server. You must have sysadmin access and the server must be SQL Server 2000 or higher.

Alias
Required True
Pipeline false
Default Value

Optional Parameters

-SourceSqlCredential

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.

Alias
Required False
Pipeline false
Default Value
-DestinationSqlCredential

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.

Alias
Required False
Pipeline false
Default Value
-CategoryType

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.

Alias
Required False
Pipeline false
Default Value
Accepted Values Job,Alert,Operator
-JobCategory

This parameter is auto-populated for command-line completion and can be used to copy only specific job categories.

Alias
Required False
Pipeline false
Default Value
-AgentCategory

This parameter is auto-populated for command-line completion and can be used to copy only specific agent categories.

Alias
Required False
Pipeline false
Default Value
-OperatorCategory

This parameter is auto-populated for command-line completion and can be used to copy only specific operator categories.

Alias
Required False
Pipeline false
Default Value
-Force

If this switch is enabled, the Category will be dropped and recreated on Destination.

Alias
Required False
Pipeline false
Default Value False
-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.

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.

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.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Copy-DbaAgentJobCategory on GitHub.
Want to see the Bill Of Health for this command? Check out Copy-DbaAgentJobCategory.