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

Compare with Current View Page History

« Previous Version 6 Next »

Name

Reset-JS7Agent

SYNOPSIS

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

SYNTAX

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

DESCRIPTION

This cmdlet resets an Agent. In a first step any orders, workflows and other deployable objects are revoked from an Agent.
In a second step the Agent performs a restart and initialiszes 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.

PARAMETERS

AgentId

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

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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any 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 visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.

Required?false
Position?3
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 JobScheduler.

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 JobScheduler.

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

about_JS7

EXAMPLES

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

PS > Reset-JS7Agent -AgentId agent_001

Resets the indicated Agent.

  • No labels