Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

Get-JobSchedulerCalendar

SYNOPSIS

Shows the next start dates for jobs and orders of JobScheduler Master.

SYNTAX

Get-JobSchedulerCalendar [-Directory <String>] [-JobChain <String>] [-Order <String>] [-Job <String>] [-Limit
<Int32>] [-Days <Int32>] [-FromDate <DateTime>] [-ToDate <DateTime>] -Display -NoOutputs [<CommonParameters>
]

DESCRIPTION

The next start date for jobs and orders is calculated by JobScheduler Master.
This cmdlet returns a list of start date objects that indicate the next start time.

PARAMETERS

Directory

-Directory <String>
Optionally specifies the folder for which order and job start times should be returned. The directory is determined
from the root folder, i.e. the "live" directory.

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

JobChain

-JobChain <String>
Optionally specifies the path and name of a job chain for which order start times 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.

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

Order

-Order <String>
Optionally specifies the path and name of an order for which start times should be returned.
If the name of an order is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Order parameter is assumed to include the full path and name of the order.

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Job

-Job <String>
Optionally specifies the path and name of a job for which start times should be returned.
If the name of a job is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Job parameter is assumed to include the full path and name of the job.

Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Limit

-Limit <Int32>
Limits the number of entries that are returned in order avoid too large a result.
Because calender entries are not sorted according to time but by object, this command does not return
the next 100 entries for a specific job or job chain but effectively 100 entries from which the
specified jobs and job chains are selected.

...

Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Days

-Days <Int32>
Optionally specifies the number of days starting from the current time for which
start dates are returned.

...

Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

FromDate

-FromDate <DateTime>
Optionally specifies the date starting from which start dates are calculated.

Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ToDate

-ToDate <DateTime>
Optionally specifies the date for which the calculation of start dates ends.

Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Display

-Display <SwitchParameter>
Specifies that formatted output is displayed.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

NoOutputs

-NoOutputs <SwitchParameter>
Specifies that no output is created, i.e. no objects are returned.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

about_jobscheduler

EXAMPLES

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

...