Name
Get-JobSchedulerJobChain
SYNOPSIS
Returns job chains from the JobScheduler Master.
SYNTAX
Get-JobSchedulerJobChain [[-JobChain] <String>] [[-Directory] <String>] [-Recursive] [-Compact] [-Active] [-Stopped] [<CommonParameters>]
DESCRIPTION
Job chains are returned from a JobScheduler Master.
Job chains can be selected either by the folder of the job chain location including sub-folders or by an individual job chain.
Resulting job chains can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
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? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up. By default 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
-Active <SwitchParameter>
Specifies that only 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 --------------------------
PS > $jobChains = Get-JobSchedulerJobChain
Returns all job chains.
-------------------------- EXAMPLE 2 --------------------------
PS > $jobChains = Get-JobSchedulerJobChain -Directory /some_path -Recursive
Returns all job chains that are configured with the specified path including any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
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.