Name
Get-JobSchedulerDailyPlan
SYNOPSIS
Returns the daily plan items for job streams, jobs and orders of JobScheduler.
SYNTAX
Get-JobSchedulerDailyPlan [[-JobChain] <String>] [[-OrderId] <String>] [[-Job] <String>] [[-JobStream] <String>] [[-Directory] <String>] [-Recursive] [[-RegEx] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [-Late] [-Successful] [-Failed] [-Incomplete] [-Planned] [-IsJobStream] [<CommonParameters>]
DESCRIPTION
The daily plan items for job streams, jobs and orders are returned.
PARAMETERS
JobChain
-JobChain <String>
Optionally specifies the path and name of a job chain for which daily plan items 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? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
OrderId
-OrderId <String>
Optionally specifies the path and ID of an order for which daily plan items should be returned.
If an order ID is specified then the -Directory parameter is used to determine the folder.
Otherwise the -OrderId parameter is assumed to include the full path and ID of the order.
| Required? | false |
| Position? | 2 |
| 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 daily plan items 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? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
JobStream
-JobStream <String>
Optionally specifies the name of a job stream for which daily plan items should be returned.
Job streams are unique across folders and are specified by name.
Therefore the -Directory parameter is ignored if this parameter is used.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the folder for which daily plan items should be returned. The directory is determined
from the root folder, i.e. the "live" directory and should start with a "/".
| Required? | false |
| Position? | 5 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
When used with the -Directory parameter then any sub-folders of the specified directory will be looked up.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RegEx
-RegEx <String>
Specifies a regular expression that filters the items to be returned.
This applies to jobs, job chains, orders and job streams that are filtered by path including their name.
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan items should be returned.
Consider that a UTC date has to be provided.
Default: Begin of the current day as a UTC date
| Required? | false |
| Position? | 7 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateTo
-DateTo <DateTime>
Optionally specifies the date until which daily plan items should be returned.
Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 8 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateFrom
-RelativeDateFrom <String>
Specifies a relative date starting from which daily plan items should be returned, e.g.
* -1d, -2d: one day ago, two days ago
* +1d, +2d: one day later, two days later
* -1w, -2w: one week ago, two weeks ago
* +1w, +2w: one week later, two weeks later
* -1M, -2M: one month ago, two months ago
* +1M, +2M: one month later, two months later
* -1y, -2y: one year ago, two years ago
* +1y, +2y: one year later, two years later
Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 9 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateTo
-RelativeDateTo <String>
Specifies a relative date until which daily plan items should be returned, e.g.
* -1d, -2d: one day ago, two days ago
* +1d, +2d: one day later, two days later
* -1w, -2w: one week ago, two weeks ago
* +1w, +2w: one week later, two weeks later
* -1M, -2M: one month ago, two months ago
* +1M, +2M: one month later, two months later
* -1y, -2y: one year ago, two years ago
* +1y, +2y: one year later, two years later
Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 10 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Timezone
-Timezone <TimeZoneInfo>
Specifies the time zone to which dates should be converted in the daily plan information.
A time zone can e.g. be specified like this:
Get-JSDailyPlan -Timezone (Get-Timezone -Id 'GMT Standard Time')
All dates in JobScheduler are UTC and can be converted e.g. to the local time zone like this:
Get-JSDailyPlan -Timezone (Get-Timezone)
Default: Dates are returned in UTC.
| Required? | false |
| Position? | 11 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Late
-Late <SwitchParameter>
Specifies that daily plan items are returned that are late or that started later than expected.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Successful
-Successful <SwitchParameter>
Specifies that daily plan items are returned completed successfully.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Failed
-Failed <SwitchParameter>
Specifies that daily plan items are returned that completed with errors.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Incomplete
-Incomplete <SwitchParameter>
Specifies that daily plan items are returned for jobs, orders, job streams that did not yet complete.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Planned
-Planned <SwitchParameter>
Specifies that daily plan items are returned that did not yet start.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
IsJobStream
-IsJobStream <SwitchParameter>
Limits results to Job Streams only.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $items = Get-JobSchedulerDailyPlan
Returns daily plan items for the current day.
-------------------------- EXAMPLE 2 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -RegEx '^/sos'
Returns today's daily plan for any items from the /sos folder.
-------------------------- EXAMPLE 3 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -RegEx 'report'
Returns today's daily plan for items that contain the string 'report' in the path.
-------------------------- EXAMPLE 4 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -Timezone (Get-Timezone)
Returns today's daily plan for any jobs with dates being converted to the local timezone.
-------------------------- EXAMPLE 5 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -Timezone (Get-Timezone -Id 'GMT Standard Time')
Returns today's daily plan for any jobs with dates being converted to the GMT timezone.
-------------------------- EXAMPLE 6 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -DateTo (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(4).ToUniversalTime()
Returns the daily plan items for the next 3 days until midnight.
-------------------------- EXAMPLE 7 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -RelativeDateFrom -7d
Returns the daily plan for the last seven days. The daily plan is reported starting from midnight UTC.
-------------------------- EXAMPLE 8 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -RelativeDateFrom -7d+01:00
Returns the daily plan for the last seven days. The daily plan is reported starting from 1 hour after midnight UTC.
-------------------------- EXAMPLE 9 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -RelativeDateFrom -7d+TZ
Returns the daily plan for the last seven days. The daily plan is reported starting from midnight in the same timezone that is used with the -Timezone parameter.
-------------------------- EXAMPLE 10 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -RelativeDateFrom -1w
Returns the daily plan for the last week.
-------------------------- EXAMPLE 11 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -Failed -Late
Returns today's daily plan items for jobs that failed or are late, i.e. that did not start at the expected point in time.
-------------------------- EXAMPLE 12 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -JobChain /sos/dailyplan/CreateDailyPlan
Returns the daily plan items for any orders of the given job chain.
-------------------------- EXAMPLE 13 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -IsJobStream -Planned
Returns the daily plan items for job streams that are planned for the current day.