...
Name
Get-JobSchedulerJobChain
SYNOPSIS
Returns a number of job chains from the JobScheduler Master.
SYNTAX
Get-JobSchedulerJobChain [[-JobChain] <String>] [[-Directory] <String>] [-JobChain <String>] -NoSubfolders -NoCache <CommonParameters>Recursive] [-Compact] [-Active] [-Stopped] [<CommonParameters>]
DESCRIPTION
Job chains are retrieved returned from a JobScheduler Master.
Job chains can be selected either by the folder of the job chain location including subfolders sub-folders or by an individual job
chain.
Resulting job chains can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
...
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? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? |
...
| false |
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? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? |
...
| false |
Recursive
-NoSubfolders Recursive <SwitchParameter>
Specifies that no subfolders any sub-folders should be looked up. By default any subfolders no sub-folders will be searched for job chains.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Compact
-Compact <SwitchParameter>
Specifies that fewer attributes of a job chain are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Active
-NoCache Active <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? falseonly active ("unstopped") job chains are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Stopped
-Stopped <SwitchParameter>
Specifies that only suspended ("stopped") job chains are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>$jobChains PS > $jobChains = Get-JobSchedulerJobChain
Returns all job chains.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$jobChains PS > $jobChains = Get-JobSchedulerJobChain -Directory /some_path -NoSubfoldersRecursive
Returns all job chains that are configured with the root folder ("live" directory)
without consideration of subfoldersspecified path including any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$jobChains PS > $jobChains = Get-JobSchedulerJobChain -JobChain /test/globals/job_chain1
Returns the job chain "job_chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 4 --------------------------
PS > $jobChains = Get-JobSchedulerJobChain -Stopped
Returns all suspended ("stopped") job chains.