JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

Name

Get-JS7Schedule

SYNOPSIS

Returns schedules from the JOC Cockpit inventory

SYNTAX

Get-JS7Schedule [[-SchedulePath] <String>] [[-WorkflowPath] <String>] [[-Folder] <String>] [-Recursive] [<CommonParameters>]

DESCRIPTION

Schedules are selected from the JOC Cockpit inventory

* by the path and name of a schedule,
* by the folder of the schedule location including sub-folders,
* by the path and name of a workflow.

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

The following REST Web Service API resources are used:

* /schedules

PARAMETERS

SchedulePath

-SchedulePath <String>
Optionally specifies the path and name of a schedule that should be returned.

One of the parameters -Folder, -SchedulePath or -WorkflowPath has to be specified if no pipelined path properties are provided.

Required?false
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

WorkflowPath

-WorkflowPath <String>

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

Folder

-Folder <String>
Optionally specifies the folder for which schedules should be returned.

One of the parameters -Folder, -SchedulePath or -WorkflowPath has to be specified if no pipelined path properties are provided.

Required?false
Position?3
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 -Folder parameter is used.
By default no sub-folders will be searched for schedules.

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $schedules = Get-JS7Schedule

Returns all schedules available with the JOC Cockpit inventory.

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

PS > $schedules = Get-JS7Schedule -Folder /some_folder -Recursive

Returns all schedules that are configured with the folder "/some_folder" including any sub-folders.

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

PS > $schedule = Get-JS7Schedule -SchedulePath /BusinessDays

Returns the schedule that is stored with the path "/BusinessDays".

-------------------------- EXAMPLE 4 --------------------------

PS > $calendars = Get-JS7Schedule -WorkflowPath /some/path

Returns the schedules that are assigned the given workflow.

  • No labels