Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

Get-JobSchedulerJob

SYNOPSIS

Returns a number of jobs from the JobScheduler Master.

SYNTAX

Get-JobSchedulerJob [-Directory <String>] [-JobChain <String>] [-Job <String>] -WithLog -NoSubfolders [-Stopp
ed] -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.

...

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

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.

...

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

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.

...

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

WithLog

-WithLog <SwitchParameter>
Specifies the task log to be returned.

...

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?

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
Accept pipeline input? false
Accept wildcard characters?

Stopped

-Stopped <SwitchParameter>
Specifies that only stopped jobs should be returned.

...

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?

RunningTasks

-RunningTasks <SwitchParameter>
Specifies that only jobs with running tasks should be returned.

...

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?

EnqueuedTasks

-EnqueuedTasks <SwitchParameter>
Specifies that only jobs with enqueued tasks should be returned.

...

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?

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
Accept pipeline input? false
Accept wildcard characters?

about_jobscheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

...