You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

Name

Reset-JS7Agent

SYNOPSIS

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

SYNTAX

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

DESCRIPTION

This cmdlet resets a Standalone Agent. In a first step any orders, workflows and other deployable objects are revoked from the Agent.
In a second step the Agent performs a restart and initializes its journal.
In a final step the Controller reconnects to the Agent and deploys any required deployable objects.

It is recommended to first check the state of orders prior to resetting the Agent and to complete or to cancel any attached orders.
Consider that orders have to be re-submitted to an Agent after reset.

The following REST Web Service API resources are used:

* /agent/reset

PARAMETERS

AgentId

-AgentId <String>
Specifies the unique identifier of an Agent.

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

ControllerId

-ControllerId <String>
Specifies the identification of the Controller for which Agents are reset.

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 an Agent, 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 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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any 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 visible with 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 visible with 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-JS7Agent -AgentId 'agent_001'

Resets the indicated Agent.

  • No labels