PowerShell CLI 2.0 - Cmdlets - Set-JS7DailyPlanOrder

Name

Set-JS7DailyPlanOrder

SYNOPSIS

Updates daily plan orders

SYNTAX

Set-JS7DailyPlanOrder [-OrderId] <String> [[-ControllerId] <String>] [[-ScheduledFor] <DateTime>] [[-RelativeScheduledFor] <String>] [[-ScheduledDate] <DateTime>] [[-RelativeScheduledDate] <String>] [[-RelativeScheduledTime] <String>] [[-Cycle] <PSObject>] [[-Variables] <Hashtable>] [[-RemoveVariables] <String[]>] [[-StartPosition] <String>] [[-EndPositions] <String[]>] [[-BlockPosition] <String>] [-ForceJobAdmission] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The daily plan orders are updated for absolute or relative start times

The following REST Web Service API resources are used:

* /daily_plan/orders/modify

PARAMETERS

OrderId

-OrderId <String>
Specifies the Order ID of an existing daily plan order that should be updated.

ControllerId

-ControllerId <String>
Specifies the identification of the Controller to which orders will be submitted.

ScheduledFor

-ScheduledFor <DateTime>
Optionally specifies the date and time that the order should start.

One of the arguments -ScheduledFor or -RelativeScheduledFor has to be used.

RelativeScheduledFor

-RelativeScheduledFor <String>
Specifies a relative date for which the daily plan order should be started, e.g.

* +1d, +2d: one day later, two days later
* +1w, +2w: one week later, two weeks later
* +1M, +2M: one month later, two months later
* +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 argument is used alternatively to the -ScheduledFor argument.

ScheduledDate

-ScheduledDate <DateTime>
Optionally specifies a time for which the order will be started on the given day.
The order will use the date specified by the -ScheduledFor or -RelativeScheduledFor arguments, and it will use the time specified by this argument.

The time is specified from a string in the hh:mm:ss format like this:

* 23:12:59

Only one of the arguments -ScheduledTime and -RelativeScheduledTime can be used.

RelativeScheduledDate

-RelativeScheduledDate <String>

RelativeScheduledTime

-RelativeScheduledTime <String>
Optionally specifies an offset to the existing time for which the order will be started on the given day.
The order will use the existing date to which the offset specified by this argument will be added or from which it will be substracted.

The time offset is specified from a string in the hh:mm:ss format like this:

* Adding 2 hours and 45 minutes to the start time: +02:45:00
* Subtracting 9 hours and 30 minutes from the start time: -09:30:00

Cycle

-Cycle <PSObject>
Specifies the cycle if a cyclic order is updated.

In addition to the order's start time specified by the -ScheduledFor argument such orders hold a cycle definition.

The value for the -Cycle argument can be created like this:

$cycle = New-Object PSCustomObject
Add-Member -Membertype NoteProperty -Name 'begin' -value '15:30:00' -InputObject $cycle
Add-Member -Membertype NoteProperty -Name 'end' -value '18:45:00' -InputObject $cycle
Add-Member -Membertype NoteProperty -Name 'repeat' -value '00:30:00' -InputObject $cycle

Variables

-Variables <Hashtable>
Optionally specifies a hashtable of Variables

A hashtable object holds pairs of names and values. It can be created like this:
$variables = @{ 'var_1'='some string'; 'var_2' = 23; 'var_3' = true}

RemoveVariables

-RemoveVariables <String[]>
Optionally specifies a list of variables that should be removed from the order.

StartPosition

-StartPosition <String>
Optionally specifies the label of the first instruction in the workflow that the order should execute.

EndPositions

-EndPositions <String[]>
Optionally specifies the list of labels corresponding to instructions in the workflow that the order should terminate with.

BlockPosition

-BlockPosition <String>
Optionally specifies the label of a block instruction in the workflow that the order should be started for.
The order will terminate with the end of the block instruction.

If the -StartPosition argument is used then the order will start from the indicated position in the block instruction.
If end positions are specified then the order will terminate with one of the end positions inside the block instruction.

ForceJobAdmission

-ForceJobAdmission <SwitchParameter>

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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

AuditTimeSpent

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

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

AuditTicketLink

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

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

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $orders = Get-JS7DailyPlanOrder
Set-JS7DailyPlanOrder -OrderId $orders[0].orderId -ScheduledFor $orders[0].plannedStartTime -RelativeScheduledTime '+03:00:00'

Moves the start time of a non-cyclic order of the current daily plan date 3 hours forward.

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

PS > $orders = Get-JS7DailyPlanOrder
Set-JS7DailyPlanOrder -OrderId $orders[0].orderId -ScheduledFor $orders[0].plannedStartTime -RelativeScheduledTime '-03:00:00' -Cycle $orders[0].period

Moves the start time of a cyclic order of the current daily plan date 3 hours back.