dbatoolsGet-DbaAgentJobCategory
View SourceSynopsis
Retrieves SQL Server Agent job categories with usage counts and filtering options
Description
Returns SQL Server Agent job categories from one or more instances, showing how many jobs are assigned to each category. Job categories help organize and group related SQL Agent jobs for easier management and reporting. This function retrieves both built-in categories (like Database Maintenance, Log Shipping) and custom categories created by DBAs. You can filter by specific category names or types (LocalJob for single-instance jobs, MultiServerJob for MSX/TSX environments, or None for uncategorized jobs) to focus on particular organizational schemes.
Syntax
Get-DbaAgentJobCategory
[-SqlInstance] <DbaInstanceParameter[]>
[[-SqlCredential] <PSCredential>]
[[-Category] <String[]>]
[[-CategoryType] <String>]
[-EnableException]
[<CommonParameters>]
Examples
Example: 1
PS C:\> Get-DbaAgentJobCategory -SqlInstance sql1
Return all the job categories.
Example: 2
PS C:\> Get-DbaAgentJobCategory -SqlInstance sql1 -Category 'Log Shipping'
Return all the job categories that have the name ‘Log Shipping’.
Example: 3
PS C:\> Get-DbaAgentJobCategory -SqlInstance sstad-pc -CategoryType MultiServerJob
Return all the job categories that have a type MultiServerJob.
Required Parameters
-SqlInstance
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.
| Property | Value |
|---|---|
| Alias | |
| Required | True |
| Pipeline | true (ByValue) |
| Default Value |
Optional Parameters
-SqlCredential
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.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
-Category
Specifies one or more job category names to return, filtering the results to only those categories. Accepts multiple values and supports built-in categories like ‘Database Maintenance’, ‘Log
Shipping’, ‘Replication’, and custom categories created by DBAs.
Use this when you need to check specific categories for job assignments or verify custom organizational schemes. If not specified, all job categories are returned.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
-CategoryType
Filters job categories by their deployment type: ‘LocalJob’ for single-instance jobs, ‘MultiServerJob’ for Master Server/Target Server (MSX/TSX) environments, or ‘None’ for uncategorized jobs.
Use this in MSX/TSX configurations to distinguish between locally managed jobs and multi-server jobs, or to identify jobs that haven’t been assigned a proper category. If not specified, all category
types are returned.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | |
| Accepted Values | LocalJob,MultiServerJob,None |
-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.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Outputs
Microsoft.SqlServer.Management.Smo.Agent.JobCategory
Returns one JobCategory object per job category on the SQL Server instance. Custom properties are added to provide connection context and job count information.
Default display properties (via Select-DefaultView):
- ComputerName: The computer name of the SQL Server instance
- InstanceName: The SQL Server instance name
- SqlInstance: The full SQL Server instance name (computer\instance)
- Name: The name of the job category
- ID: The unique identifier of the job category
- CategoryType: The type of category (LocalJob, MultiServerJob, or None)
- JobCount: The number of jobs currently assigned to this category (integer)
Additional properties available (from SMO JobCategory object):
- Parent: Reference to the parent JobServer object
- Urn: The Unified Resource Name that uniquely identifies the job category
- State: The state of the object (Existing, Creating, Dropping, Pending) All properties from the base SMO JobCategory object are accessible by using Select-Object *.