commands

^

Get-DbaAgentJobCategory

Author Sander Stad (@sqlstad), sqlstad.nl
Availability Windows, Linux, macOS

 

Synopsis

Get-DbaAgentJobCategory retrieves the job categories.

Description

Get-DbaAgentJobCategory makes it possible to retrieve the job categories.

Syntax

Get-DbaAgentJobCategory
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Category] <String[]>]
    [[-CategoryType] <String>]
    [-Force]
    [-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.

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.

Alias
Required False
Pipeline false
Default Value
-Category

The name of the category to filter out. If no category is used all categories will be returned.

Alias
Required False
Pipeline false
Default Value
-CategoryType

The type of category. This can be "LocalJob", "MultiServerJob" or "None". If no category is used all categories types will be returned.

Alias
Required False
Pipeline false
Default Value
Accepted Values LocalJob,MultiServerJob,None
-Force

The force parameter will ignore some errors in the parameters and assume defaults.

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

 

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