Page History
...
Revokes a Cluster Agent and any related Subagents from a Controller
...
This cmdlet revokes a Cluster Agent and any related Subagents from a Controller.
The Cluster Agent configuration remains in place with the inventory and can later on
be deployed to the given Controller.
The following REST Web Service API resources are used:
* /agents/inventory/cluster/revoke
...
-AgentId <String[]>
Specifies a the unique identifier for a of the Cluster Agent. This identifier cannot be modified during the lifetime of an Agent
More than one Cluster 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 <String>
Specifies the identification of the Controller from which Cluster Agents are revoked.
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 |
...
PS > Revoke-JS7ClusterAgent -AgentId 'agent_001' -ControllerId 'testsuite'
...