You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Name

Stop-JS7DailyPlanOrder

SYNOPSIS

Cancels daily plan orders from a number of JS7 Controllers

SYNTAX

Stop-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-SchedulePath] <String>] [[-Folder] <String>] [-Recursive] [[-ControllerId] <String>] [-Late] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [-Pending] [-InProgress] [-Running] [-Blocked] [-Finished] [-Failed] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Cancels daily plan orders from a number of JS7 Controllers.

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the order ID of the daily plan order that should be cancelled.

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

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

SchedulePath

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

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

Folder

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

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

Recursive

-Recursive <SwitchParameter>
When used with the -Folder parameter then any sub-folders of the specified folder will be looked up.

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

ControllerId

-ControllerId <String>
Specifies the Controller to which daily plan orders have been submitted and should be cancelled.

Without this parameter daily plan orders are cancelled from any Controllers that are deployed the
workflows that are indicated with the respective parameters.

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

Late

-Late <SwitchParameter>
Specifies that daily plan orders are cancelled that are late or that started later than expected.

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

DateFrom

-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders should be cancelled.
Consider that a UTC date has to be provided.

Default: Begin of the current day as a UTC date

Required?false
Position?6
Default value(Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

DateTo

-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be cancelled.
Consider that a UTC date has to be provided.

Default: End of the current day as a UTC date

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

RelativeDateFrom

-RelativeDateFrom <String>
Specifies a relative date starting from which daily plan orders should be cancelled, 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.

This parameter takes precedence over the -DateFrom parameter.

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

RelativeDateTo

-RelativeDateTo <String>
Specifies a relative date until which daily plan orders should be cancelled, 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.

This parameter takes precedence over the -DateTo parameter.

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

Pending

-Pending <SwitchParameter>

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

InProgress

-InProgress <SwitchParameter>

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

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

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

AuditComment

-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.

The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any interventions.

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

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.

Required?false
Position?11
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.

This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.

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

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > Stop-JS7DailyPlanOrder -DateFrom "2020-12-31"

Cancels any daily plan orders for the given date.

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

PS > Stop-JS7DailyPlanOrder -DateTo (Get-Date).AddDays(3)

Cancels any daily plan orders starting from today until a date three days from now.

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

PS > Stop-JS7DailyPlanOrder -OrderId "#2020-11-19#P0000000498-orderSampleWorfklow2a"

Cancels the order with the given order ID from the daily plan.

-------------------------- EXAMPLE 4 --------------------------

PS > Stop-JS7DailyPlanOrder -WorkflowPath /some_folder/some_workflow

Cancels the daily plan orders for the indicated workflow in today's daily plan.

  • No labels