Skip to end of metadata
Go to start of metadata

NAME

Get-JobSchedulerJobChain

SYNOPSIS

Returns a number of job chains from the JobScheduler Master.

SYNTAX

Get-JobSchedulerJobChain [-Directory <String>] [-JobChain <String>] -NoSubfolders -NoCache <CommonParameters>

DESCRIPTION

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

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

PARAMETERS

Directory

-Directory <String>
Optionally specifies the folder for which job chains should be returned. The directory is determined
from the root folder, i.e. the "live" directory.

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

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 should be returned.
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 or -JobChain has to be specified.

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

NoSubfolders

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

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 --------------------------

C:\PS>$jobChains = Get-JobSchedulerJobChain

Returns all job chains.

-------------------------- EXAMPLE 2 --------------------------

C:\PS>$jobChains = Get-JobSchedulerJobChain -Directory / -NoSubfolders

Returns all job chains that are configured with the root folder ("live" directory)
without consideration of subfolders.

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

C:\PS>$jobChains = Get-JobSchedulerJobChain -JobChain /test/globals/job_chain1

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

  • No labels
Write a comment…