PowerShell CLI 2.0 - Cmdlets - Restore-JS7Agent

Name

Restore-JS7Agent

SYNOPSIS

Reassigns Agents to a JS7 Controller

SYNTAX

Restore-JS7Agent [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet reassigns Agents to a JS7 Controller. Any Agents that previously have been
added with the Set-JS7Agent cmdlet are assgined a Controller. This operation is not required
for normal operation, however, if Controller's journal has to be dropped then the Controller
will loose the information about assigned Agents.

Use of this cmdlet restores the Agent assignment for the given Controller.

The following REST Web Service API resources are used:

* /agents/reassign

PARAMETERS

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.

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.

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.

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Restore-JS7Agent

Reassigns any Agents to the current Controller.