Page History
Name
Remove-JS7Notice
SYNOPSIS
Removes a Notice from a Notice Board in the JOC Cockpit
SYNTAX
Remove-JS7Notice [-NoticeBoardPath] <String> [-NoticeId] <String> [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet removes a Notice from a Notice Board in the JOC Cockpit.
The following REST Web Service API resources are used:
* /notice/delete
PARAMETERS
NoticeBoardPath
-NoticeBoardPath <String>
Specifies the path to the Notice Board that include the folder, sub-folders and the name of the Notice Board.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NoticeId
-NoticeId <String>
Specifies the identifier of the Notice to be deleted.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Optionally specifies the identification of the Controller from which to remove Notices.
| Required? | false |
| Position? | 3 |
| Default value | |
| 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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.
| Required? | false |
| Position? | 4 |
| 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 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.
| Required? | false |
| Position? | 5 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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.
| Required? | false |
| Position? | 6 |
| 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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7Notice -Folder /ProductDemo/Sequencing | Remove-JS7Notice
Removes notices from the Notice Boards specified by a folder.
Overview
Content Tools