< Back
Get-DbaAgentJobCategory
Post
NAME Get-DbaAgentJobCategory
SYNOPSIS
Get-DbaAgentJobCategory retrieves the job categories.
SYNTAX
Get-DbaAgentJobCategory [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Category] <System.String[]>] [[-CategoryType] <String>] [-Force <Switch>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Get-DbaAgentJobCategory makes it possible to retrieve the job categories.
PARAMETERS
-Category [<System.String[]>]
The name of the category to filter out. If no category is used all categories will be returned.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CategoryType [<String>]
The type of category. This can be "LocalJob", "MultiServerJob" or "None".
If no category is used all categories types will be returned.
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>]
The force parameter will ignore some errors in the parameters and assume defaults.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<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
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
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: Agent, Job, JobCategory
Author: Sander Stad (@sqlstad), sqlstad.nl
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Get-DbaAgentJobCategory
SYNOPSIS
Get-DbaAgentJobCategory retrieves the job categories.
SYNTAX
Get-DbaAgentJobCategory [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Category] <System.String[]>] [[-CategoryType] <String>] [-Force <Switch>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Get-DbaAgentJobCategory makes it possible to retrieve the job categories.
PARAMETERS
-Category [<System.String[]>]
The name of the category to filter out. If no category is used all categories will be returned.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CategoryType [<String>]
The type of category. This can be "LocalJob", "MultiServerJob" or "None".
If no category is used all categories types will be returned.
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>]
The force parameter will ignore some errors in the parameters and assume defaults.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<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
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
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: Agent, Job, JobCategory
Author: Sander Stad (@sqlstad), sqlstad.nl
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Get-DbaAgentJobCategory