commands

^

Get-DbaAgentJob

Author Garry Bargsley (@gbargsley), http://blog.garrybargsley.com
Availability Windows, Linux, macOS

 

Synopsis

Gets SQL Agent Job information for each instance(s) of SQL Server.

Description

The Get-DbaAgentJob returns connected SMO object for SQL Agent Job information for each instance(s) of SQL Server.

Syntax

Get-DbaAgentJob
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Job] <String[]>]
    [[-ExcludeJob] <String[]>]
    [[-Database] <String[]>]
    [[-Category] <String[]>]
    [[-ExcludeCategory] <String[]>]
    [-ExcludeDisabledJobs]
    [-IncludeExecution]
    [[-Type] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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.

Example: 8
PS C:\> Get-DbaAgentJob -SqlInstance sqlserver2014a -Database msdb

Finds all jobs on sqlserver2014a that T-SQL job steps associated with msdb database

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
-Job

The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeJob

The job(s) to exclude - this list is auto-populated from the server.

Alias
Required False
Pipeline false
Default Value
-Database

Return jobs with T-SQL job steps associated with specific databases

Alias
Required False
Pipeline false
Default Value
-Category

Return jobs associated with specific category

Alias
Required False
Pipeline false
Default Value
-ExcludeCategory

Categories to exclude - jobs associated with these categories will not be returned.

Alias
Required False
Pipeline false
Default Value
-ExcludeDisabledJobs

Switch will exclude disabled jobs from the output.

Alias
Required False
Pipeline false
Default Value False
-IncludeExecution

Include Execution details if the job is currently running

Alias
Required False
Pipeline false
Default Value False
-Type

The type of job: MultiServer or Local. Defaults to both MultiServer and Local.

Alias
Required False
Pipeline false
Default Value @("MultiServer", "Local")
Accepted Values MultiServer,Local
-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-DbaAgentJob on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaAgentJob.