functions/Get-DbaRunningJob.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
FUNCTION Get-DbaRunningJob
{
<#
.SYNOPSIS
Returns all non idle agent jobs running on the server.
 
.DESCRIPTION
This function returns agent jobs that active on the SQL Server intance when calling the command. The information is gathered the SMO JobServer.jobs and be returned either in detailed or standard format
 
.PARAMETER SqlServer
SQLServer name or SMO object representing the SQL Server to connect to. This can be a
collection and recieve pipeline input
 
.PARAMETER SqlCredential
PSCredential object to connect as. If not specified, currend Windows login will be used.
 
.PARAMETER Detailed
Returns more information about the running jobs than standard
 
.NOTES
Original Author: Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.LINK
https://dbatools.io/Get-DbaRunningJob
 
.EXAMPLE
Get-DbaRunningJob -SqlServer localhost
Returns any active jobs on the localhost
 
.EXAMPLE
Get-DbaRunningJob -SqlServer localhost -Detailed
Returns a detailed output of any active jobs on the localhost
 
.EXAMPLE
'localhost','localhost\namedinstance' | Get-DbaRunningJob
Returns all active jobs on multiple instances piped into the function
 
#>

[CmdletBinding()]
Param (
[parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)]
[Alias("ServerInstance", "SqlInstance", "SqlServers")]
[string[]]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential,
[switch]$Detailed
)
BEGIN
{
$output = @()
}
PROCESS
{
FOREACH ($Server in $SqlServer)
{
TRY
{
$server = Connect-SqlServer -SqlServer $server -SqlCredential $sqlcredential
}
CATCH
{
Write-Verbose "Failed to connect to: $Server"
continue
}

$jobs = $server.JobServer.jobs | Where-Object { $_.CurrentRunStatus -ne 'Idle' }

IF (!$jobs)
{
Write-Verbose "No Jobs are currently running on: $Server"
}
ELSE
{
foreach ($job in $jobs)
{
$output += [pscustomobject]@{
ServerName = $Server.Name
Name = $job.name
Category = $job.Category
CurrentRunStatus = $job.CurrentRunStatus
CurrentRunStep = $job.CurrentRunStep
HasSchedule = $job.HasSchedule
LastRunDate = $job.LastRunDate
LastRunOutcome = $job.LastRunOutcome
JobStep = $job.JobSteps
}
}
}
}
}
END
{
IF ($Detailed -eq $true)
{
return $output | Sort-Object ServerName
}
ELSE
{
return ($output | Sort-Object ServerName | Select-Object ServerName, Name, Category, CurrentRunStatus, CurrentRunStep)
}
}
}