:TERMINATE
Use the :TERMINATE script statement to end an agent, the agents of an agent group, a work process, or a communication process.
To be able to use this script statement, you require the C (cancel) right for server processes (SERV type at object level) or agents (HOST type at object level). For details, see Authorizations Page
Tips:
- To end the connection to an agent temporarily, use the :DISCONNECT script statement The agent will reconnect to the server when the next signal for an agent check is sent. For more information, see :DISCONNECT.
- To terminate all work processes and communication processes of your AE system, use the :SHUTDOWN script statement. For more information, see :SHUTDOWN.
Syntax
:TERMINATE [Connection], Name
-
:TERMINATE
Ends an agent, the agents of an agent group, a work process, or a communication process
-
Connection
(Optional) Specifies the type of connection. Set a comma if you do not use this parameter.
Format: AE name, script literal or script variable
Allowed values: -
HOST (default)
Agent -
HOSTGROUP
Agents of an agent group. All the agents that belong to this group are terminated. -
SERVER
Work process or communication process -
Name
Name of an agent, agent group, work process, or communication process
Format: script literal or script variable
Examples
The following example terminates a work process.
:TERMINATE SERVER,"AE#WP001"
The agent WIN21 is terminated, no type of connection is specified.
:TERMINATE ,"WIN21"
See also: