Versions Compared

Key

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

...

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

...

-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 -DateTo DateFrom parameter.

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

...

-Timezone <TimeZoneInfo>
Specifies the timezone time zone to which dates should be converted in the daily plan information.
A timezone 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?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_jobschedulerJobScheduler

EXAMPLES

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

...

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 8 12 --------------------------

...

-------------------------- EXAMPLE 9 13 --------------------------

...