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 have multiple Agents installed on each computer that is 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)

  • sqs.us-west-2.amazonaws.com:443

  • *.credentials.iot.us-west-2.amazonaws.com:443

  • *.s3.us-west-2.amazonaws.com:443

If the Agent is installed on Linux, BMC recommends to 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 describe the specific actions you can perform on an Agent:

Agent General Parameters

The following table describes Agent General parameters.

Parameter

Description

Server

Defines the name of 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. You define the name during the Agent installation and 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 (Available Agent)

Defines 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 (Unavailable Agent)

Defines 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

Determines 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 might 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.

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. It is recommended to select Yes, when the Agent is used to start background applications.

Default: Yes

Echo Job commands into Output

Defines 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-insClosedA Control-M component that extends functionality to third-party applications like Hadoop or SAP and integrates plug-in jobs with other jobs into 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 DayClosedA Control-M process that occurs at midnight at the beginning of each day, which adds the 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 ViewpointsClosedA 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 definitionClosedThe set of parameters that defines what the job does, when it must run, its prerequisites to run, and post-processing actions for Control-M to perform after its completion (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)