...
Get-JobSchedulerTask
SYNOPSIS
Return information about Retrieves a number of tasks from the JobScheduler Master.
SYNTAX
Get-JobSchedulerTask [[-JobDirectory] <String>] [[-JobChainJob] <String>] [[-Directory] <String>NoRunningTasks] [-RecursiveNoEnqueuedTasks] [-RunningNoSubfolders] [-EnqueuedUseCache] [<CommonParameters>]
DESCRIPTION
Running and enqueued tasks are returned retrieved from a JobScheduler Master.
Tasks can be selected either by the folder of the job location including sub-folders subfolders or by an individual job.
Resulting tasks can be forwarded to the Stop-JobSchedulerTask cmdlet in a bulk operation.
PARAMETERS
...
Directory
-Job Directory <String>
Optionally specifies the path and name of a job folder with jobs 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. The directory is determined
from the root folder, i.e. the "live" directory.
One of the parameters -Directory and -Job has to be specified.
| Required? | false |
| Position? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Job
-JobChain Job <String>
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.
One of the parameters -Directory and -Job has to be specified.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
NoRunningTasks
-Directory <String>
Optionally specifies the folder with jobs for which NoRunningTasks <SwitchParameter>
Specifies that no running 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 specifiedstopped. By default running tasks will be stopped.
| Required? | false |
| Position? | 3named |
| Default value | /False |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
NoEnqueuedTasks
-Recursive NoEnqueuedTasks <SwitchParameter>
Specifies that no sub-folders enqueued tasks should be looked up for jobsstopped. By default any sub-folders enqueued tasks will be searched for jobs with tasksstopped.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
NoSubfolders
-Running NoSubfolders <SwitchParameter>
Specifies that running tasks should be returnedno subfolders should be looked up for jobs. By default any subfolders will be searched for jobs with tasks.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
UseCache
-Enqueued UseCache <SwitchParameter>
Specifies that enqueued tasks should be returned. By default no enqueued tasks arre returnedthe cache for JobScheduler objects is used. By default the chache is not used
as in most use cases the current information about running tasks is required from the JobScheduler Master.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
Returns all running and enqueued tasks for all jobs from any folders recursively.
-------------------------- EXAMPLE 2 --------------------------
PS > $tasks = Get-JobSchedulerTask -Directory / my_jobs -RecursiveNoSubfolders
Returns all running and enqueued tasks that are configured with the root folder ("my_jobs" recursivelylive" directory) without consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
...