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? | false |
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? | false |
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? | false |
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? | false |
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.
The limit should be set high enough so that entries are not lost.
Default: 100
| Required? | false |
| Position? | 5 |
| Default value | 100 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Days
-Days <Int32>
Optionally specifies the number of days starting from the current time for which
start dates are returned.
Default: 1
| Required? | false |
| Position? | 6 |
| Default value | 1 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | false |
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? | false |
Display
-Display <SwitchParameter>
Specifies that formatted output is displayed.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NoOutputs
-NoOutputs <SwitchParameter>
Specifies that no output is created, i.e. no objects are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $startDates = Get-JobSchedulerCalendar
Returns start dates for the next 24 hrs.
-------------------------- EXAMPLE 2 --------------------------
PS > $startDates = Get-JobSchedulerCalendar -Days 3
Returns the start dates for the next 3 days.
-------------------------- EXAMPLE 3 --------------------------
PS > $startDates = Get-JobSchedulerCalendar -FromDate 2016-06-01 -ToDate 2016-06-30
Returns the start dates between the specified dates.
-------------------------- EXAMPLE 4 --------------------------
PS > $startDates = Get-JobSchedulerCalendar -JobChain /holidays/some_job_chain -ToDate 2016-06-30
Returns the start dates between the current date and the specified dates for any orders of the given job chain.
-------------------------- EXAMPLE 5 --------------------------
PS > Get-JobSchedulerCalendar -Display
Displays formatted output.