Page History
...
Remove-JS7Agent
SYNOPSIS
Removes an a Standalone Agent or Cluster Agent from a Controller and from the JOC Cockpit inventory
SYNTAX
Remove-JS7Agent [-AgentId] <String[]> [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet removes an Agent. a Standalone Agent or Cluster Agent from its Controller and from the JOC Cockpit inventory.
It is required to complete or to cancel any orders attached the Agent
prior to removing the Agent.
The following REST Web Service API resources are used:
* /agent/removedelete
PARAMETERS
AgentId
-AgentId <String><String[]>
Specifies a the unique identifier of the Standaone Agent or Cluster Agent.
More than one Agent can be specified by separating Agent IDs by a comma.
| 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 the Standalone Agent or Cluster Agent is removed 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? | truefalse |
| Position? | 12 |
| 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? | 23 |
| 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? | 34 |
| 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? | 45 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
PS > Remove-JS7Agent -AgentId 'agent_001' -ControllerId 'testsuite'
Removes the indicated Agent from the given Controller.
-------------------------- EXAMPLE 2 --------------------------
PS > Remove-JS7Agent -AgentId 'agent_001','agent_002' -ControllerId 'testsuite'
Removes the indicated Agents from the given Controller.
Overview
Content Tools