PowerShell CLI 2.0 - Cmdlets - Remove-JS7DailyPlanSubmission

Name

Remove-JS7DailyPlanSubmission

SYNOPSIS

Removes daily plan submissions from a JS7 Controller

SYNTAX

Remove-JS7DailyPlanSubmission [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes daily plan submissions from a JS7 Controller.

The following REST Web Service API resources are used:

* /daily_plan/submissions/delete

PARAMETERS

ControllerId

-ControllerId <String>
Specifies the Controller from which daily plan submissions should be removed.

DateFrom

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

Default: Beginning of the current day as a UTC date

DateTo

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

Default: End of the current day as a UTC date

RelativeDateFrom

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

RelativeDateTo

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

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 > Remove-JS7DailyPlanSubmission -DateFrom "2020-12-31"

Removes daily plan submissions for the given date.

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

PS > Remove-JS7DailyPlanSubmission -DateTo (Get-Date).AddDays(3)

Removes any daily plan submissions starting from today until a date three days from now.