| Author | Sander Stad (@sqlstad), sqlstad.nl |
| Availability | Windows, Linux, macOS |
Want to see the source code for this command? Check out New-DbaAgentJobCategory on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaAgentJobCategory.
Creates new SQL Server Agent job categories for organizing and managing jobs.
Creates custom job categories in SQL Server Agent to help organize and classify jobs by function, department, or priority level. Job categories provide a way to group related jobs together for easier management and reporting, replacing the need to manually create categories through SQL Server Management Studio. You can specify whether the category is for local jobs, multi-server jobs, or general use, with LocalJob being the default type.
New-DbaAgentJobCategory
[-SqlInstance] <DbaInstanceParameter[]>
[[-SqlCredential] <PSCredential>]
[-Category] <String[]>
[[-CategoryType] <String>]
[-Force]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> New-DbaAgentJobCategory -SqlInstance sql1 -Category 'Category 1'
Creates a new job category with the name 'Category 1'.
PS C:\> New-DbaAgentJobCategory -SqlInstance sql1 -Category 'Category 2' -CategoryType MultiServerJob
Creates a new job category with the name 'Category 2' and assign the category type for a multi server job.
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2000 or greater.
| Alias | |
| Required | True |
| Pipeline | true (ByValue) |
| Default Value |
Specifies the name of the SQL Agent job category to create. Accepts multiple category names when you need to create several categories at once.
Use descriptive names that reflect job functions like 'Database Maintenance', 'ETL Jobs', or 'Reporting' to help organize jobs by purpose or department.
| Alias | |
| Required | True |
| Pipeline | false |
| Default Value |
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 |
Defines the scope and purpose of the job category. Valid options are "LocalJob" for jobs that run on the local instance, "MultiServerJob" for jobs in multi-server environments, or "None" for
general-purpose categories.
Defaults to "LocalJob" when not specified, which is appropriate for most standalone SQL Server instances.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | |
| Accepted Values | LocalJob,MultiServerJob,None |
Suppresses confirmation prompts during category creation. Sets the confirmation preference to bypass interactive confirmation requests.
Use this when automating category creation in scripts where manual confirmation is not desired or possible.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
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 |
Shows what would happen if the command were to run. No actions are actually performed.
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |
Prompts you for confirmation before executing any changing operations within the command.
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |