Automation Engine Script Guide > Ordered by Function > System Conditions and Settings > :TERMINATE

:TERMINATE

Script Statement: Ends an agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host, the agents of an agent groupAn agent group combines agents of the same platform. The agents that should be included in an agent group are specified by entering the agent name or via filters. A task that runs in an agent group is processed on one or all of the agent group's agents, depending on the specified mode. A particular Automation Engine object type. , a work or communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components.

Syntax

:TERMINATE [Connection], Name

Syntax

Description/Format

Connection

Type of connection
Format: AE name, script literal or script literal

Allowed values: "HOST" (default value), "HOSTGROUP" and "SERVER"
"HOST" = Agent
"HOSTGROUP" = Agents of an agent group
"SERVER" = Work or communication process

Name

Name of an agent, agent group, work or communication process
Format: scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.

Comments

This script statement can be used to end agents and work and communication processes. The parameter Connection does not have to be indicated. A colon must be set if it is not used.

Instead of specifying an individual agent, you can also indicate an agent group. The termination applies to all agents that belong to this groupAn Automation Engine object type that integrates tasks so that they can be processed together..

If the connection to an agent should end on a temporary basis, we recommend using the script element  :DISCONNECT. In this case, the agent reconnects to the Server when the next signal for an agent check is sent. With :SHUTDOWN all work and communication processes of the AE system can be terminated.

 The right to "cancel" server processes or agents is required to execute this script statement.

Examples

The example below terminates a work processA part of the component Automation Engine. It is responsible for an Automation Engine system's processes (see also 'Primary work process')..

:TERMINATE SERVER,"AE#WP001"

In this example, the agent "WIN21" is terminated. The type of connection is not indicated.

:TERMINATE ,"WIN21"

 

See also:

Script element/functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… Description

:DISCONNECT

Disconnects a connection to the AE system.
:SHUTDOWN Ends an AE system.

MODIFY_SYSTEM

Processes ServiceManagerA program that facilitates the starts and stops of Automation Engine components. actions or queueA particular Automation Engine (AE) object type. In AE, a queue determines the maximum number of concurrent tasks, their priorities and the order in which tasks should be executed. In ARA, queues are containers for workflow executions that should be executed at a certain time one after another. modifications.

Script Elements - System Conditions and Settings

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH