Page History
Name
Revoke-JS7DeployableItem
SYNOPSIS
Revokes deployable inventory items
SYNTAX
Revoke-JS7DeployableItem [-Folder] <String> [-ObjectName] <String> [-ObjectType] <String> [-DeployablesVersions] <Object[]> [-ControllerId] <String[]> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet revokes deployable inventory items.
Inventory items are preferably retrieved using the Get-JS7DeployableItem cmdlet. The output can be piped to this cmdlet.
The following REST Web Service API resources are used:
* /inventory/deployment/revoke
PARAMETERS
Folder
-Folder <String>
Specifies the folder in which the inventory objects is located.
Required? | true |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
ObjectName
-ObjectName <String>
Specifies the name of an inventory item that should be revoked.
Required? | true |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
ObjectType
-ObjectType <String>
Specifies the type of object to be revoked.
The following object types are available
* WORKFLOW
* FILEORDERSOURCE
* JOBRESOURCE
* NOTICEBOARD
* LOCK
Required? | true |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
DeployablesVersions
-DeployablesVersions <Object[]>
Specifies an array of object versions that include the commitId attribute required to revoke a specific version of an inventory item.
Required? | true |
Position? | 4 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
ControllerId
-ControllerId <String[]>
Required? | true |
Position? | 5 |
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? | 6 |
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? | 7 |
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? | 8 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7DeployableItem -Folder /ProductDemo -Recursive | Revoke-JS7Deployabletem -ControllerId 'controller'
Reads inventory items from the given folder recursively and revokes the objects from the specified Controller.