Page History
Name
Remove-JS7Folder
SYNOPSIS
Removes a folder from the JOC Cockpit inventory.
SYNTAX
Remove-JS7Folder [-Path] <String> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet marks for deletion a folder and its contents, i.e. deployable and releasable objects
in the JOC Cockpit inventory.
The objects from the folder are not immediately erased, instead this change has to be committed:
* For deployable objects use of the cmdlet the Publish-JS7DeployableObject cmdlet with the -Delete switch is required.
* For releasable objects use of the cmdlet the Publish-JS7ReleasableObject cmdlet with the -Delete switch is required.
PARAMETERS
Path
-Path <String>
Specifies the folder and optionally sub-folders to be removed.
Required? | true |
Position? | 1 |
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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.
Required? | false |
Position? | 2 |
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? | 3 |
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 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? | 4 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Remove-JS7Folder -Path /some/path
Removes the specified folder from the JOC Cockpit inventory.