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.

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:

Edit: Enables you to configure all Agent parameters, as described in the following:
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.

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.

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
Server to Agent Port Number	Defines the port number in the Control-M/Agent computer where data is received from the Control-M/Server computer. The value assigned to this parameter must correspond to the value assigned to the Server-to-Agent Port Number field in the configuration file on the corresponding Control-M/Agent computer. Default: 7005
Agent to Server Port Number	Defines the port number between 1024 and 65535 that receives data from the Control-M/Agent computer. Verify that this port is not used for any other purpose. This value must match the Agent-to-Server Port Number in Control-M/Server. The value is the COMTIMOUT communication Job-tracking timeout in seconds. Example: 7005/30. Increasing the Timeout value reduces agent performance. Valid values: Between 1024 and 65535 inclusive Default: 7005
Primary Server	Defines the hostname of the computer where the current Control-M/Server submits Jobs to the Control-M/Agent
Authorized Servers	Defines a list of backup servers which can replace the primary server if it fails. The Control-M/Agent only accept requests from servers on this list. NOTE: You cannot submit Jobs to the same Control-M/Agent if there is more than one active Control-M/Server. Another Control-M/Agent instance must be installed with unique ports to support this configuration or Job status updates corrupt.
Check Interval (Available Agent)	Defines the number of seconds between status checks for each Agent that communicates with the Control-M/Server If you decrease the default value, it might impact Control-M/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 Control-M/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 Control-M/Server attempts to connect to the Agent before the Agent is set to Unavailable. If you decrease the default value, it might impact Control-M/Server performance. Default: 120
Agent TCP/IP Timeout	Defines the timeout used by the Control-M/Agent when listening on the Server to agent port number before timing out and performing housekeeping tasks
Maximum Retries	Determines the number of times the Control-M/Server attempts to connect to the Agent before the Agent is set to Unavailable.
Logical Agent Name	Defines a logical or alias name for the Agent. If you have more than one Agent on the same host that connects to the same Control-M/Server, you must use this parameter to uniquely identify each Agent. The value must be the same as the value in Control-M/Server computer. The logical name is used when the Agent initiates the communication to the Control-M/Server with the output from Agent utilities and in messages sent to the Control-M/Server.
Listen to Network Interface	Determines which network interface the Agent is listening on. It can be set to a specific hostname or IP address so that the Agent port is not opened in the other interfaces.
Secure Socket Layer	Determines whether SSL is used to encrypt the communication between Control-M/Server and the Control-M/Agent.

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
Foreign Language Support	Determines whether CJK or LATIN-1 is supported.
Application Locale	Determines the LATIN-1encoding used by the Agent to run Jobs.
Tracker Polling Interval	Determines the number of seconds the Agent tracker process waits for incoming events from plug-insA 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 DayA 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 ViewpointsA customizable view of job flows in the Monitoring domain are saved.
Default Printer	Defines the default printer for Job output (OUTPUT)
OUTPUT Name	Determines one of the following prefix options for the output file name: memname Jobname

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 DayA 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 ViewpointsA customizable view of job flows in the Monitoring domain are saved.

Default Printer

Defines the default printer for Job output (OUTPUT)

OUTPUT Name

Determines one of the following prefix options for the output file name:

memname
Jobname

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 definitionThe 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)

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 definitionThe 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)

Email parameters

The following table describes the Email parameters:

Field	Description
SMTP Server Name	Defines the name of the SMTP server
SMTP Port Number	Determines the port number between 0-65535 where the SMTP server communicates
Sender Email	Defines the e-mail address of the sender (max 99 characters)
Sender Friendly Name	Defines the name or alias that appears on the sent e-mail
Reply to Email	Defines the e-mail address where to send replies. If this field is left empty, the sender e-mail address is used.