< Back
Get-DbaAgentJobStep
Post
NAME Get-DbaAgentJobStep
SYNOPSIS
Gets SQL Agent Job Step information for each instance(s) of SQL Server.
SYNTAX
Get-DbaAgentJobStep [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Job] <System.Object[]>] [[-ExcludeJob] <System.Object[]>] [-ExcludeDisabledJobs <Switch>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Get-DbaAgentJobStep returns connected SMO object for SQL Agent Job Step for each instance(s) of SQL Server.
PARAMETERS
-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.Object[]>]
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.Object[]>]
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: Klaas Vandenberghe (@PowerDbaKlaas), http://powerdba.eu
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Get-DbaAgentJobStep
SYNOPSIS
Gets SQL Agent Job Step information for each instance(s) of SQL Server.
SYNTAX
Get-DbaAgentJobStep [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Job] <System.Object[]>] [[-ExcludeJob] <System.Object[]>] [-ExcludeDisabledJobs <Switch>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Get-DbaAgentJobStep returns connected SMO object for SQL Agent Job Step for each instance(s) of SQL Server.
PARAMETERS
-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.Object[]>]
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.Object[]>]
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: Klaas Vandenberghe (@PowerDbaKlaas), http://powerdba.eu
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Get-DbaAgentJobStep