Page History
...
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 attached 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
...
-SubagentId <String>
Specifies a unique identifier for a Subagent. This identifier cannot be modified during the lifetime of an Agenta Subagent.
In order to modify the Agent Subagent identifier the Agent Subagent has to be removed and added.
...
-ControllerId <String>
Specifies the identification of the Controller from which Agents Subagents are removed.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 4 |
| Default value | 0 |
| 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 JobSchedulerJS7.
This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-------------------------- EXAMPLE 1 --------------------------
PS > Reset-JS7Subagent -AgentId SubagentId 'subagent_001'
Resets the indicated AgentSubgent.
Overview
Content Tools