Name
Get-JobSchedulerJob
SYNOPSIS
Returns a number of jobs from the JobScheduler Master.
SYNTAX
Get-JobSchedulerJob [[-Directory] <String>] [[-JobChain] <String>] [[-Job] <String>] [-WithLog] [-NoSubfolders] [-Stopped] [-RunningTasks] [-EnqueuedTasks] [-NoCache] [<CommonParameters>]
DESCRIPTION
Jobs are retrieved from a JobScheduler Master.
Jobs can be selected either by the folder of the job location including subfolders or by an individual job.
Resulting jobs can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
Directory
-Directory <String>
Optionally specifies the folder for which jobs should be returned. The directory is determined
from the root folder, i.e. the "live" directory.
One of the parameters -Directory, -JobChain or -Job has to be specified.
| Required? | false |
| Position? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
JobChain
-JobChain <String>
Optionally specifies the path and name of a job chain that includes jobs.
If the name of a job chain is specified then the -Directory parameter is used to determine the folder.
Otherwise the -JobChain parameter is assumed to include the full path and name of the job chain.
One of the parameters -Directory, -JobChain or -Job has to be specified.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Job
-Job <String>
Optionally specifies the path and name of a job.
If the name of a job is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Job parameter is assumed to include the full path and name of the job.
One of the parameters -Directory, -JobChain or -Job has to be specified.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WithLog
-WithLog <SwitchParameter>
Specifies the task log to be returned.
This operation is time-consuming and should be restricted to selecting individual jobs.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
NoSubfolders
-NoSubfolders <SwitchParameter>
Specifies that no subfolders should be looked up. By default any subfolders will be searched for jobs.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Stopped
-Stopped <SwitchParameter>
Specifies that only stopped jobs should be returned.
This parameter cannot be combined with -JobChain, -RunningTasks, -EnqueuedTasks.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RunningTasks
-RunningTasks <SwitchParameter>
Specifies that only jobs with running tasks should be returned.
This parameter cannot be combined with -Stopped and -EnqueuedTasks.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
EnqueuedTasks
-EnqueuedTasks <SwitchParameter>
Specifies that only jobs with enqueued tasks should be returned.
This parameter cannot be combined with -Stopped and -RunningTasks.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
NoCache
-NoCache <SwitchParameter>
Specifies that the cache for JobScheduler objects is ignored.
This results in the fact that for each Get-JobScheduler* cmdlet execution the response is
retrieved directly from the JobScheduler Master and is not resolved from the cache.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $jobs = Get-JobSchedulerJob
Returns all jobs.
-------------------------- EXAMPLE 2 --------------------------
PS > $jobs = Get-JobSchedulerJob -Directory / -NoSubfolders
Returns all jobs that are configured with the root folder ("live" directory) without consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
PS > $jobs = Get-JobSchedulerJob -JobChain /test/globals/job_chain1
Returns the jobs that are associated with job chain job_chain1 from the folder "/test/globals".
-------------------------- EXAMPLE 4 --------------------------
PS > $jobs = Get-JobSchedulerJob -Job /test/globals/job1
Returns the job "job1" from the folder "/test/globals".