:TERMINATE

Use the :TERMINATE script statement to end an agent, the agents of an agent group, a work process, or a communication process. To use this statement, you require the C (cancel) right for server processes (SERV type at object level) or agents (HOST type at object level). For more information, see Defining the Authorizations Page.

To end the connection to an agent temporarily, use :DISCONNECT. The agent reconnects when the next status check signal is sent. For more information, see :DISCONNECT.
To terminate all work processes and communication processes of your AE system, use :SHUTDOWN. For more information, see :SHUTDOWN.

Syntax

: TERMINATE [Connection], Name

Parameters

Parameter	Description	Format	Allowed Values	Default Value
Connection (Optional)	Type of connection to terminate. If omitted, place a comma before the Name parameter.	AE name, script literal, or script variable	HOST — Agent HOSTGROUP — All agents in an agent group SERVER — Work process or communication process	HOST
Name	Name of the agent, agent group, work process, or communication process to terminate	Script literal or script variable	n.a.	n.a.

Examples

The following example terminates a work process.

: TERMINATE SERVER, "AE#WP001"

The following example terminates agent WIN21 without specifying a connection type.

: TERMINATE, "WIN21"