Get-DbaAgentJobStep

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

Synopsis

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

Description

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

Syntax

Get-DbaAgentJobStep
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Job] <String[]>]
    [[-ExcludeJob] <String[]>]
    [[-InputObject] <Job[]>]
    [-ExcludeDisabledJobs]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAgentJobStep -SqlInstance localhost

Returns all SQL Agent Job Steps on the local default SQL Server instance

Example: 2

PS C:\> Get-DbaAgentJobStep -SqlInstance localhost, sql2016

Returns all SQL Agent Job Steps for the local and sql2016 SQL Server instances

Example: 3

PS C:\> Get-DbaAgentJobStep -SqlInstance localhost -Job BackupData, BackupDiff

Returns all SQL Agent Job Steps for the jobs named BackupData and BackupDiff from the local SQL Server instance.

Example: 4

PS C:\> Get-DbaAgentJobStep -SqlInstance localhost -ExcludeJob BackupDiff

Returns all SQL Agent Job Steps for the local SQL Server instances, except for the BackupDiff Job.

Example: 5

PS C:\> Get-DbaAgentJobStep -SqlInstance localhost -ExcludeDisabledJobs

Returns all SQL Agent Job Steps for the local SQL Server instances, excluding the disabled jobs.

Example: 6

PS C:\> $servers | Get-DbaAgentJobStep

Find all of your Job Steps from SQL Server instances in the $servers collection

Optional 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.

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

-Job

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

-ExcludeJob

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

-InputObject

Job objects to process. This can be piped from Get-DbaAgentJob.

-ExcludeDisabledJobs

Switch will exclude disabled jobs from the output.

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