functions/Get-JobSchedulerTask.ps1
|
function Get-JobSchedulerTask { <# .SYNOPSIS Return information about tasks from the JobScheduler Master. .DESCRIPTION Running and enqueued tasks are returned from a JobScheduler Master. Tasks can be selected either by the folder of the job location including sub-folders or by an individual job. Resulting tasks can be forwarded to the Stop-JobSchedulerTask cmdlet in a bulk operation. .PARAMETER Job Optionally specifies the path and name of a job for which tasks should be returned. If the name of a job is specified then the -Directory parameter is used to determine the job folder. Otherwise the job is assumed to include the full path and name of the job. .PARAMETER JobChain Optionally specifies the path and name of a job chain for which tasks should be returned. If the name of a job chain is specified then the -Directory parameter is used to determine the job chain folder. Otherwise the job chain is assumed to include the full path and name of the job chain. .PARAMETER Directory Optionally specifies the folder with jobs for which tasks should be returned. The directory is determined from the root folder, i.e. the "live" directory. One of the parameters -Directory or -Job has to be specified. .PARAMETER Recursive Specifies that no sub-folders should be looked up for jobs. By default any sub-folders will be searched for jobs with tasks. .PARAMETER Running Specifies that running tasks should be returned. .PARAMETER Enqueued Specifies that enqueued tasks should be returned. By default no enqueued tasks arre returned. .OUTPUTS This cmdlet returns an array of task objects. .EXAMPLE $tasks = Get-JobSchedulerTask Returns all running and enqueued tasks for jobs from any folders recursively. .EXAMPLE $tasks = Get-JobSchedulerTask -Directory /my_jobs -Recursive Returns all running and enqueued tasks that are configured with the folder "my_jobs" recursively. .EXAMPLE $tasks = Get-JobSchedulerTask -Job /test/globals/job1 Returns all tasks for job "job1" from the folder "/test/globals". .LINK about_jobscheduler #> [cmdletbinding()] param ( [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [string] $Job, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [string] $JobChain, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [string] $Directory = '/', [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [switch] $Recursive, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [switch] $Running, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [switch] $Enqueued ) Begin { Approve-JobSchedulerCommand $MyInvocation.MyCommand $stopWatch = Start-JobSchedulerStopWatch $tasks = @() } Process { Write-Debug ".. $($MyInvocation.MyCommand.Name): parameter Directory=$Directory, Job=$Job" if ( !$Directory -and !$Job ) { throw "$($MyInvocation.MyCommand.Name): no directory and no job specified, use -Directory or -Job" } if ( $Directory -and $Directory -ne '/' ) { if ( $Directory.Substring( 0, 1) -ne '/' ) { $Directory = '/' + $Directory } if ( $Directory.Length -gt 1 -and $Directory.LastIndexOf( '/' )+1 -eq $Directory.Length ) { $Directory = $Directory.Substring( 0, $Directory.Length-1 ) } } if ( $Job ) { if ( (Get-JobSchedulerObject-Basename $Job) -ne $Job ) # job name includes a directory { $Directory = Get-JobSchedulerObject-Parent $Job } else { # job name includes no directory if ( $Directory -eq '/' ) { $Job = $Directory + $Job } else { $Job = $Directory + '/' + $Job } } } if ( !$Job -and $Directory -eq '/' ) { $Recursive = $true } if ( !$Runnning -and !$Enqueued ) { $Running = $true } $task = ( Get-JobSchedulerJob -Job $Job -JobChain $JobChain -Directory $Directory -Recursive:$Recursive -Running:$Running -Enqueued:$Enqueued ) if ( $task ) { $tasks += $task } } End { if ( $tasks.count ) { Write-Verbose ".. $($MyInvocation.MyCommand.Name): $($tasks.count) tasks found" $tasks } else { Write-Verbose ".. $($MyInvocation.MyCommand.Name): no tasks found" } Trace-JobSchedulerStopWatch $MyInvocation.MyCommand.Name $stopWatch } } |