Name
Get-JobSchedulerJobStream
SYNOPSIS
Returns Job Streams from the JOC Cockpit inventory.
SYNTAX
Get-JobSchedulerJobStream [[-JobStream] <String>] [[-Directory] <String>] [-Recursive] [<CommonParameters>]
DESCRIPTION
Job Streams are returned from a JOC Cockpit inventory. Job streams can be selected by name and folder.
PARAMETERS
JobStream
-JobStream <String>
Optionally specifies the name of a job stream.
One of the parameters -Directory or -JobStream 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 streams 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 if the -Directory parameter is used.
By default no sub-folders will be searched for job streams.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $jobStreams = Get-JobSchedulerJobStream -Directory /test
Returns all job streams that are configured with the folder "test".
-------------------------- EXAMPLE 2 --------------------------
PS > $jobStreams = Get-JobSchedulerJobStream
Returns all job streams.
-------------------------- EXAMPLE 3 --------------------------
PS > $jobStream = Get-JobSchedulerJobStream -JobStream SampleJobStream
Returns the job stream with the indicated name.