Name

Show-JobSchedulerCalendar

SYNOPSIS

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

SYNTAX

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

DESCRIPTION

This cmdlet is an alias for Get-JobSchedulerCalendar -Display -NoOutputs

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 but effectively 100 random entries.

The limit should be set high enough so that entries are not lost.

Default: 100

Required?false
Position?5
Default value100
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 value1
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

about_jobscheduler

EXAMPLES

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

PS > Show-JobSchedulerCalendar

Shows start dates for the next 24 hrs.

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

PS > Show-JobSchedulerCalendar -Days 3

Shows the start dates for the next 3 days.

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

PS > Show-JobSchedulerCalendar -FromDate 2016-06-01 -ToDate 2016-06-30

Shows the start dates between the specified dates.

  • No labels