< Back
Get-DbaAgentJob
Post
NAME Get-DbaAgentJob
SYNOPSIS
Gets SQL Agent Job information for each instance(s) of SQL Server.
SYNTAX
Get-DbaAgentJob [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Job] <System.String[]>] [[-ExcludeJob] <System.String[]>] [[-Database] <System.String[]>]
[[-Category] <System.String[]>] [-ExcludeDisabledJobs <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Get-DbaAgentJob returns connected SMO object for SQL Agent Job information for each instance(s) of SQL Server.
PARAMETERS
-Category [<System.String[]>]
Return jobs associated with specific category
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
Return jobs with T-SQL job steps associated with specific databases
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
-ExcludeDisabledJobs [<Switch>]
Switch will exclude disabled jobs from the output.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeJob [<System.String[]>]
The job(s) to exclude - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.String[]>]
The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be
processed.
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: Job, Agent
Author: Garry Bargsley (@gbargsley), http://blog.garrybargsley.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost
Returns all SQL Agent Jobs on the local default SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost, sql2016
Returns all SQl Agent Jobs for the local and sql2016 SQL Server instances
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost -Job BackupData, BackupDiff
Returns all SQL Agent Jobs named BackupData and BackupDiff from the local SQL Server instance.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost -ExcludeJob BackupDiff
Returns all SQl Agent Jobs for the local SQL Server instances, except the BackupDiff Job.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost -ExcludeDisabledJobs
Returns all SQl Agent Jobs for the local SQL Server instances, excluding the disabled jobs.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>$servers | Get-DbaAgentJob | Out-GridView -PassThru | Start-DbaAgentJob -WhatIf
Find all of your Jobs from SQL Server instances in the $servers collection, select the jobs you want to start then
see jobs would start if you ran Start-DbaAgentJob
-------------------------- EXAMPLE 7 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance sqlserver2014a | Where-Object Category -eq "Report Server" | Export-DbaScript
-Path "C:\\temp\\sqlserver2014a_SSRSJobs.sql"
Exports all SSRS jobs from SQL instance sqlserver2014a to a file.
RELATED LINKS
https://dbatools.io/Get-DbaAgentJob
SYNOPSIS
Gets SQL Agent Job information for each instance(s) of SQL Server.
SYNTAX
Get-DbaAgentJob [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Job] <System.String[]>] [[-ExcludeJob] <System.String[]>] [[-Database] <System.String[]>]
[[-Category] <System.String[]>] [-ExcludeDisabledJobs <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Get-DbaAgentJob returns connected SMO object for SQL Agent Job information for each instance(s) of SQL Server.
PARAMETERS
-Category [<System.String[]>]
Return jobs associated with specific category
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
Return jobs with T-SQL job steps associated with specific databases
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
-ExcludeDisabledJobs [<Switch>]
Switch will exclude disabled jobs from the output.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeJob [<System.String[]>]
The job(s) to exclude - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.String[]>]
The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be
processed.
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: Job, Agent
Author: Garry Bargsley (@gbargsley), http://blog.garrybargsley.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost
Returns all SQL Agent Jobs on the local default SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost, sql2016
Returns all SQl Agent Jobs for the local and sql2016 SQL Server instances
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost -Job BackupData, BackupDiff
Returns all SQL Agent Jobs named BackupData and BackupDiff from the local SQL Server instance.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost -ExcludeJob BackupDiff
Returns all SQl Agent Jobs for the local SQL Server instances, except the BackupDiff Job.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance localhost -ExcludeDisabledJobs
Returns all SQl Agent Jobs for the local SQL Server instances, excluding the disabled jobs.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>$servers | Get-DbaAgentJob | Out-GridView -PassThru | Start-DbaAgentJob -WhatIf
Find all of your Jobs from SQL Server instances in the $servers collection, select the jobs you want to start then
see jobs would start if you ran Start-DbaAgentJob
-------------------------- EXAMPLE 7 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance sqlserver2014a | Where-Object Category -eq "Report Server" | Export-DbaScript
-Path "C:\\temp\\sqlserver2014a_SSRSJobs.sql"
Exports all SSRS jobs from SQL instance sqlserver2014a to a file.
RELATED LINKS
https://dbatools.io/Get-DbaAgentJob