Agents

Agents submit jobs for execution on the host computer, monitor jobs, and perform post-processing analysis of completed jobs. The job completion status and the post-processing analysis results are transmitted back to the Server.

You can install multiple Agents that are managed by a Server. Jobs are assigned to an Agent name that identifies the host.

The Agent communicates with the Server using https protocol (port 443). If your organization blocks access to the Internet, contact your Network administrator to grant outgoing access to the following:

  • *.controlm.com:443 (https protocol) (outgoing only)

  • *.amazonaws.com:443 (outgoing only)

If the Agent is installed on Linux, BMC recommends you use non-root mode. For more information, see set_agent_mode.

In the Configuration domain, you can install, monitor, search, and manage Agents in your environment.

The following describes the specific actions you can perform on an Agent:

  • Install: Installs the Agent on your environment, as described in Agent Installation.

  • Edit: Enables you to configure the following Agent parameters, as described in Configuring Agent Parameters.

  • Ping: Tests the connectivity to the Agent.

  • Recycle: Shuts down and starts up the Agent.

  • Disable: Disables all Agent actions.

  • Delete: Deletes the Agent from your environment. To fully remove it, you need to uninstall the Agent from the host.

Configuring Agent Parameters

This procedure describes how to configure all Agent parameters.

Begin

  1. From the icon, select Configuration.

  2. From the drop-down list, select Agents.

    The Agents tab appears.

  3. Click the Agent you want to edit.

    The Edit Agent dialogue tab appears.

  4. Select the Advanced tab.

  5. For each field, define the required parameters, as described in the following:

Agent General Parameters

The following table describes Agent General parameters.

Parameter

Description

Server

Defines the name of the Server that sends job requests to the Agent.

You cannot modify this parameter.

Agent Name

Defines the name of the host where the Agent is installed.

You cannot modify this parameter. The Agent name is defined during the Agent installation, and it cannot be changed afterwards.

Latin-1 special characters are not supported.

Tag

Defines a logical name that is used to label specific Agents into a group with a specific authorization level. You can apply a specific tag to an Agent, as described in Installing an Agent, or you can define your own tag with the asterisk character if you have the correct permissions.

Communication Parameters

The following table describes the Agent Communication parameters:

Field

Description

Check Interval

Determines the number of seconds between status checks for each Agent that communicates with the Server

If you decrease the default value, it might impact Server performance.

Default: 7200 (2 hours)

Retry Interval

Determines the number of seconds between attempts to communicate with an Agent computer whose status is Unavailable.

If you decrease the default value, it might impact Server performance.

Default: 90

Unavailability Shout Urgency

Defines the urgency level of a message sent with high priority when an Agent has an Unavailable status.

Urgent messages are sent with a special indication so that the recipient of the message is aware of the urgency.

Communication Timeout

Determines the maximum number of seconds that the Server attempts to connect to the Agent before the Agent is set to Unavailable.

If you decrease the default value, it impact Server performance.

Default: 120

Maximum Retries

Determines the number of times the Server attempts to connect to the Agent before the Agent is set to Unavailable.

Persistent Connection Parameters

The following table describes the Persistent Connection parameters:

Field

Description

Persistent Connection

Determines whether to connect to a specific agent with either a persistent or transient connection.

The connection between Control-M/Server and Control-M/Agent is constant and can be initiated by both. When the Control-M/Agent starts up, the Agent Router process is started and acts as a broker between the other Control-M/Agent components and Control-M/Server. The Agent Router process allows Control-M/Server to maintain a constant connection with the Control-M/Agent. However, when Control-M/Server sits behind a firewall, the Agent Router cannot initiate the connection with Control-M/Server. After the Control-M/Server creates the connection to the Agent Router, the Agent Tracker and Agent Utilities processes use this connection to communicate with Control-M/Server.

Maximum Disconnect Time

Determines the maximum number of seconds between 30 - 86400 that the Control-M/Server allows an agent to be disconnected before it initiates a session. This parameter is relevant only if the Allow agent to initiate a session parameter on the agent is set to NO.

Default: 300

Session Idle Timeout

Determines the maximum number of seconds between 30 - 86400 that a session can be idle before Control-M/Server terminates it.

Default: 900

Allow Agent Disconnection

Determines if the current connection to this Control-M/Agent can be disconnected when the maximum number of concurrent sessions is reached. Allowing a persistent connection on a Control-M/Agent to disconnect requires the connection to be reestablished before communication with the Control-M/Agent can continue. If you run time-sensitive jobs on the Control-M/Agent, you might want to select No.

Default: Yes

Allow Agent to Initiate a Session

Determines if the Control-M/Agent can open a connection to the Control-M/Server when working in Persistent Connection mode.

If the Control-M/Agent is outside a firewall and the Agent to Server port is blocked, set this parameter to No.

Default: Yes

Windows Job Submission and Tracking Parameters

The following table describes the Windows Job Submission and Tracking parameters:

Field

Description

Run Job Owner's Logon Script

Determines whether the Agent runs the Log in script defined by the system Administrator before each Job.

Default: No

Wait for Child Processes to Complete

Determines whether the Job ends when all sub-processes exit or waits until the main Job process exits. BMC recommends you select Yes, when the Agent is used to start background applications.

Default: Yes

Echo Job Commands into Output

Determines whether to print commands in the output of a Job.

Default: Yes

Tracker Polling Interval

Determines the number of seconds the Agent tracker process waits for incoming events from plug-insClosed A Control-M component that extends functionality to third-party applications like Hadoop or SAP and can be integrated with other jobs in a single workflow. that send events (such as Databases) before going back to scan the status directory.

Default: 60

Linux Job Submission and Tracking Parameters

The following table describes the Linux Job Submission and Tracking parameters:

Field

Description

Korn Shell (ksh) Flags

Determines the shell flag that is used to run the job script.

Valid values: -x, -v, n

Default: -x

Bourne Shell Flags

Determines the shell flag that is used to run the job script

Valid values: -x, -v, n

Default: -x

Temporary Scripts Saving

Determines whether to save temporary scripts. By default, temporary scripts generated from jobs are deleted at the end of job execution. If this value is set to Yes, temporary scripts are not deleted.

Valid values:

  • Yes

  • No

Default: No

Tracker Polling Interval

Determines the number of seconds the Agent tracker process waits for incoming events from plug-ins that send events (such as Databases) before going back to scan the status directory.

Default: 60

Agent's Account Owner

Determines whether jobs are submitted as the Agent account owner or root.

Output Parameters

The following table describes the Output parameters:

Field

Description

Days to Retain OUTPUT files

Determines the number of days that Job output files are retained for Jobs executed by Agent computers. After this period, the New DayClosed A Control-M process that begins every day at midnight, adds jobs and folders to the Run Queue for the day that is about to begin, and removes jobs and folders from previous days. procedure deletes all expired Job output files.

This parameter also affects the number of days that archived ViewpointsClosed A customizable view of job flows in the Monitoring domain. are saved.

Default Printer

Defines the default printer for Job output (OUTPUT)

Security Parameters

The following table describes the Security parameters for Windows:

Field

Description

Logon Domain

Defines the logon domain name if <domain> is not defined in <domain>\<username> in the Run as parameter of the job definitionClosed The set of parameters that defines what the job does, when it runs, its prerequisites, and the post-processing actions Control-M performs after it ends (also called a job processing definition)..

Logon as User

Determines whether jobs are submitted with the permissions and environment variables of the specified user or the local system account:

  • Yes: Specified User

  • No: Local System Account (Default)

Agentless Parameters

The following table describes the Agentless parameters:

Field

Description

SSH Connection Mode

Determines one of the following connection modes:

  • SSH Only

  • SSH with SFTP - One Connection

  • SSH with SFTP - Two Connections

Connection Retries

Determines the maximum number of attempts to restore the connection between Control-M/Server and the remote host.

Connection Timeout

Determines the maximum number of seconds that Control-M/Server attempts to connect to the remote host before the remote host is set to Unavailable.

Temporary Directory

Defines a directory to store temporary files that are removed from Control-M/Agent when the Jobs end and the network connection is available or restored.

Default: Job Owners (Run As) home directory. The period (.) represents this directory.

Print Details to OUTPUT

Determines whether to include details related to the remote connection in the Job output of Jobs executed on a remote host.