Name
Restart-JS7JOCService
SYNOPSIS
Restarts a JOC Cockpit background service in the current JOC Cockpit instance
SYNTAX
Restart-JS7JOCService [-Service] <String> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
A number of JOC Cockpit services such as the cluster service, history service and daily plan service are available
with a currently active JOC Cockpit instance. Forcing a restart is an altenative to switching over to a standby
JOC Cockpit instance as e.g. offered with the Switch-JS7JOCInstance cmdlet.
Note that restart of a JOC Cockpit service can only be performed when connected to the
currently active JOC Cockpit instance.
The following REST Web Service API resources are used:
* /joc/cluster/restart
PARAMETERS
Service
-Service <String>
Specifies the the service to be restarted which is one of:
* CLUSTER
* HISTORY
* DAILYPLAN
* CLEANUP
* MONITOR
| 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 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? | 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 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? | 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 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? | 4 |
| 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 > Restart-JS7JOCService -Service 'HISTORY'
Restarts the history service that will check for state transitions of any orders in a Controller and add the information to the history.
Overview
Content Tools