Versions Compared

Key

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

...

Get-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-SchedulePath] <String>] [[-Folder] <String>] [-Recursive] [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [-Late] [-SuccessfulPlanned] [-FailedPending] [-InProgress] [-PlannedRunning] [-Blocked] [-Finished] [-Failed] [<CommonParameters>]

DESCRIPTION

The daily plan orders for workfows are returned.

PARAMETERS

OrderId

-OrderId <String>

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

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which daily plan orders should be returned.

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

...

-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan orders should be returned.

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

...

-Folder <String>
Optionally specifies the folder with workflows for which daily plan orders should be returned.

Required?false
Position?34
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

ControllerId

-ControllerId <String>

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

DateFrom

-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders 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?46
Default value(Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-DateTo <DateTime>
Optionally specifies the date until which daily plan orders 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?57
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-RelativeDateFrom <String>
Specifies a relative date starting from which daily plan orders 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?68
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-RelativeDateTo <String>
Specifies a relative date until which daily plan orders 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 DateTo parameter.

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

...

-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?810
Default value(Get-Timezone -Id 'UTC')
Accept pipeline input?falsetrue (ByPropertyName)
Accept wildcard characters?false

...

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

...

Planned

-Successful Planned <SwitchParameter>
Specifies that daily plan orders are returned completed successfullythat did not yet start.

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

...

Pending

-Failed <SwitchParameter>
Specifies that daily plan orders are returned that completed with errors. Pending <SwitchParameter>

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

...

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

Planned

Running

-Running <SwitchParameter>

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

Blocked

-Blocked <SwitchParameter>

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

Finished

-Finished <SwitchParameter>

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

Failed

-Failed -Planned <SwitchParameter>
Specifies that daily plan orders are returned that did not yet startcompleted with errors.

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

...