Name
Get-JobSchedulerLock
SYNOPSIS
Returns job information from the JobScheduler Master.
SYNTAX
Get-JobSchedulerLock [[-Lock] <String>] [[-Directory] <String>] [-Recursive] [<CommonParameters>]
DESCRIPTION
Jobs are returned from a JobScheduler Master. Jobs can be selected by name, folder, status etc. including sub-folders.
The job information retured includes volatile status information and the permanent configuration.
The cmdlet optionally returns the task history and logs of recent task executions.
Resulting jobs can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
Lock
-Lock <String>
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up when used with the -Directory parameter.
By default no sub-folders will be looked up for jobs.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $jobs = Get-JobSchedulerJob
Returns all jobs from all directories recursively.
-------------------------- EXAMPLE 2 --------------------------
PS > $jobs = Get-JobSchedulerJob -Directory /test
Returns all jobs that are configured with the folder "test" without consideration of sub-folders.
-------------------------- EXAMPLE 3 --------------------------
PS > $jobs = Get-JobSchedulerJob -Directory /test -Recursive
Returns all jobs that are configured with the folder "test" include jobs from any sub-folders.
-------------------------- EXAMPLE 4 --------------------------
PS > $jobs = Get-JobSchedulerJob -JobChain /test/globals/job_chain1
Returns the jobs that are associated with the job chain "job_chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 5 --------------------------
PS > $jobs = Get-JobSchedulerJob -Job /test/globals/job1
Returns the job "job1" from the folder "/test/globals".
-------------------------- EXAMPLE 6 --------------------------
PS > $jobs = Get-JobSchedulerJob -Stopped
Returns any stopped jobs.
-------------------------- EXAMPLE 7 --------------------------
PS > $jobs = Get-JobSchedulerJob -Directory /test -Pending -Running
Returns any pending or running jobs from the "/test" directory.