Versions Compared

Key

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

...

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>]

...

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

JobStream

-JobStream <String>

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?45
Default value/
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

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

RegEx

-RegEx <String>
Specifies a regular expression that filters the paths to be returned.
This applies to jobs, job chains, orders and job streams that are filtered by path.

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

...

-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?57
Default value(Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime()
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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?68
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 history 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

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 history 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

This parameter takes precedence over the -DateTo parameter.

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

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the daily plan information.
A timezone 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?711
Default value(Get-Timezone -Id 'UTC')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-------------------------- 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 3 5 --------------------------

...

-------------------------- EXAMPLE 4 6 --------------------------

...

-------------------------- EXAMPLE 5 7 --------------------------

...

-------------------------- EXAMPLE 6 8 --------------------------

...

-------------------------- EXAMPLE 7 9 --------------------------

...