Versions Compared

Key

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

...

Get-JobSchedulerJobChain

SYNOPSIS

Returns a number of job chains from the JobScheduler Master.

...

Get-JobSchedulerJobChain [[-JobChainDirectory] <String>] [[-DirectoryJobChain] <String>] [-RecursiveNoSubfolders] [-Compact] [-ActiveNoCache] [-Stopped] [<CommonParameters>]

DESCRIPTION

Job chains are returned retrieved from a JobScheduler Master.
Job chains can be selected either by the folder of the job chain location including sub-folders subfolders or by an individual job chain.

Resulting job chains can be forwarded to other cmdlets for pipelined bulk operations.

PARAMETERS

...

Directory

-JobChain Directory <String>
Optionally specifies the path and name of a job chain that folder for which job chains should be returned. The directory is determined
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 chainfrom the root folder, i.e. the "live" directory.

One of the parameters -Directory or and -JobChain has to be specified.

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

...

JobChain

-Directory JobChain <String>
Optionally specifies the folder for which job chains path and name of a job chain that should be returned. The directory is determined
from the root folder, i.e. the "live" directory
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 and or -JobChain has to be specified.

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

...

NoSubfolders

-Recursive NoSubfolders <SwitchParameter>
Specifies that any sub-folders no subfolders should be looked up. By default no sub-folders any subfolders will be searched for job chains.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)false
Accept wildcard characters?false

...

NoCache

-Compact NoCache <SwitchParameter>
Specifies that fewer attributes of a job chain are returned.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Active

-Active <SwitchParameter>
Specifies that only active ("unstopped") job chains are returnedthe 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 valueFalse
Accept pipeline input?true (ByPropertyName)Accept wildcard characters?false

Stopped

...

...

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)Accept wildcard characters?false

...

PS > $jobChains = Get-JobSchedulerJobChain -Directory / some_path -RecursiveNoSubfolders

Returns all job chains that are configured with the specified path including any sub-foldersroot folder ("live" directory) without consideration of subfolders.

-------------------------- EXAMPLE 3 --------------------------

...

Returns the job chain "job_chain1" from the folder "/test/globals".

-------------------------- EXAMPLE 4 --------------------------

PS > $jobChains = Get-JobSchedulerJobChain -Stopped

Returns all suspended ("stopped") job chains.