Name
Restore-JS7Folder
SYNOPSIS
Restores a removed folder from the JOC Cockpit inventory
SYNTAX
Restore-JS7Folder [-Path] <String> [[-NewPath] <String>] [[-Prefix] <String>] [[-Suffix] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet restores a folder and its contents that have perviously been removed provided
that the deletion of objects has not yet been committed with one of the cmdlets:
* For deployable objects use of the cmdlet the Publish-JS7DeployableItem cmdlet with the -Delete switch commits permanent deletion.
* For releasable objects use of the cmdlet the Publish-JS7ReleasableItem cmdlet with the -Delete switch commits permanent deletion.
The following REST Web Service API resources are used:
* /inventory/trash/restore
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 |
NewPath
-NewPath <String>
Optionally specifies the new path for the restored folder. If this parameter is not used then the original path will be restored.
If a path with the same hierarchy and name exists then the removed path cannot be restored. You could consider using the -Prefix
and -Suffix parameters to create unique folder names.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Prefix
-Prefix <String>
Optionally specifies a prefix that is prepended to the restored path. If the same path already exists then incremental numbers will be added
to the prefix until a unique path is created.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Suffix
-Suffix <String>
Optionally specifies a suffix that is appended to the restored path. If the same path already exists then incremental numbers will be added
to the suffix until a unique path is created.
| Required? | false |
| Position? | 4 |
| 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? | 5 |
| 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? | 6 |
| 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? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Restore-JS7Folder -Path /some/path
Restores the specified folder in the JOC Cockpit inventory.
Overview
Content Tools