Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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/delete

...

-AgentId <String[]>
Specifies a the unique identifier for an of the Standaone Agent or Cluster Agent.

More than one Agent can be specified
by separating Agent IDs by a comma.

...

-ControllerId <String>
Specifies the identification of the Controller from which Agents are the Standalone Agent or Cluster Agent is removed.

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...