JS7 JobScheduler

Space shortcuts

Page tree

Name

Reset-JS7Subagent

SYNOPSIS

Resets a Subagent to revoke current orders, workflows etc. and to initialize the Subagent

SYNTAX

Reset-JS7Subagent [-SubagentId] <String> [[-ControllerId] <String>] [-Force] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet resets a Subagent. In a first step any orders, workflows and other deployable objects are revoked from the Subagent.
In a second step the Subagent performs a restart.

In case of a Director Agents in a final step the Controller reconnects to the Agent and deploys any required deployable objects.
In case of a Subagent in a final step the Director Agent connects to the Subagent.

It is recommended to first check the state of orders prior to resetting the Subagent and to complete or to cancel any orders running in a Subagent.

Consider that orders have to be continued if they failed due to reset of a Subagent.

The following REST Web Service API resources are used:

* /agents/inventory/cluster/subagent/reset

PARAMETERS

SubagentId

-SubagentId <String>
Specifies a unique identifier for a Subagent. This identifier cannot be modified during the lifetime of a Subagent.
In order to modify the Subagent identifier the Subagent has to be removed and added.

Required?true
Position?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

ControllerId

-ControllerId <String>
Specifies the identification of the Controller from which Subagents are removed.

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Force

-Force <SwitchParameter>
This switch should be used with care as it kills any tasks running with a Subagent.
In case of a Director Agent this switch revokes any orders and workflows
from the Agent and forces the Agent to drop its journal and to restart.

The purpose of this switch is to seize an Agent that is assigned a different Controller or Cluster Agent or that holds
information in its journal that is no longer applicable, for example if the Agent ID should be modified.

Required?false
Position?named
Default valueFalse
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?3
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?4
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

-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?5
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

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Reset-JS7Subagent -SubagentId 'subagent_001'

Resets the indicated Subgent.

  • No labels