functions/Get-DbaRunningJob.ps1
|
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 instance when calling the command. The information is gathered the SMO JobServer.jobs and be returned either in detailed or standard format. .PARAMETER SqlInstance The SQL Server instance to connect to. .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER 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. .NOTES Tags: Process, Session, ActivityMonitor, Agent, Job Author: Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/ Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Get-DbaRunningJob .EXAMPLE Get-DbaRunningJob -SqlInstance localhost Returns any active jobs on localhost. .EXAMPLE Get-DbaRunningJob -SqlInstance localhost -Detailed Returns a detailed output of any active jobs on 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", "SqlServer", "SqlServers")] [DbaInstanceParameter[]]$SqlInstance, [Alias("Credential")] [PSCredential]$SqlCredential, [Alias('Silent')] [switch]$EnableException ) process { foreach ($instance in $SqlInstance) { try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $sqlcredential } catch { Stop-Function -Message "Failed to connect to: $Server." -Target $server -ErrorRecord $_ -Continue } $jobs = $server.JobServer.jobs | Where-Object { $_.CurrentRunStatus -ne 'Idle' } if (!$jobs) { Write-Message -Level Verbose -Message "No Jobs are currently running on: $Server." } else { foreach ($job in $jobs) { [pscustomobject]@{ ComputerName = $server.ComputerName InstanceName = $server.ServiceName SqlInstance = $server.DomainInstanceName Name = $job.name Category = $job.Category CurrentRunStatus = $job.CurrentRunStatus CurrentRunStep = $job.CurrentRunStep HasSchedule = $job.HasSchedule LastRunDate = $job.LastRunDate LastRunOutcome = $job.LastRunOutcome JobStep = $job.JobSteps } } } } } } |