Communication parameters

The following table list the Control‑M/Server communication parameters.

Parameter

Description

AGENT_TO_SERVER_HOSTNAME

Determines the server host name for communicating with the Control-M/Agent.

This parameter is used to separate the listening interface from Control-M/EM and Control-M/Agents.

Agent-to-Server Port Number (CTMS_PORT_NUM)

The listening port number of the NS process (not to be used for any other purpose in the server computer). Control‑M/Server communicates with Control‑M/Agent using two TCP/IP ports. CTMS_PORT_NUM specifies the port for data flowing from Control‑M/Server to Control‑M/Agent. The other port is specified using Server-to-Agent Port Number parameter.

Note: This number must match the value assigned to the Agent-to-Server Port Number parameter on the agent computer.

Valid Values: 1024–65534

Default: 7005 (On UNIX, the default value is overridden, using the value given during installation.)

How / where to set: In the Control-M Main Menu, choose Parameter Customization => Basic Communication and Operational Parameters => Agent to Server Port.

Refresh Type: Recycle

Communication Protocol

Protocol used to communicate with the agent computers. (The protocol specified here must be the same as that specified on the agent computer.)

Valid Values: TCP

Default: TCP It is recommended that you use TCP when there are many jobs running simultaneously reporting to Control‑M/Server.

Refresh Type: Recycle

Inter Process Communication (IPC) Port Number (CTM_RT_PORT_NUMBER)

The listening port number of the RT process.

Valid Values: 1025–32767

Default: 6005

How / where to set: In the Control-M Main Menu, choose Parameter Customization => Basic Communication and Operational Parameters => IPC Port.

Refresh Type: Recycle

Local IP Host Interface Name

Host interface name of the TCP/IP network interface card on the server computer to use for communication with Control‑M/EM.

This name is typically the host name of the server computer. You should modify this parameter only if the server computer contains more than one network interface card (for example, Ethernet and Token-Ring).

Valid Values: host name, or host IP address (for example, 192.123.186.20)

Default: the default host interface name defined in the server computer operating environment.

Configuration Agent Port

Port number for the Control-M/Server Configuration Agent.

Valid Values: 1025–32767

Default: 2369

Refresh Type: Recycle

CD_MAX_DBU

When there is no current Control-M/EM session, Control-M accumulates database updates before downloading them to Control‑M/EM. CD_MAX_DBU determines the maximum number of updates to accumulate before requesting a download.

Valid Values: 100–2^31

Default: 1000

How / where to set: In the Control-M Main Menu, choose Parameter Customization => Advanced Communication and Operational Parameters => Maximum Job State Changes.

Refresh Type: Manual

CMN_PRM_CD_MAX_SERVICES

Maximum number of requests (originating from CONTROL-M/EM gateways) that Control‑M/Server can queue.

Valid Values: 60–32000

Default: 60

How / where to set:

Refresh Type:

CTM_PRM_KPA_ACTIVE

Whether the Heartbeat monitor operates in active or passive mode.

Valid Values: Y (for active) or N (for passive)

Default: Y

Refresh Type: Recycle

CTM_PRM_KPA_BETWEEN_MSGS

Time in seconds between heartbeat checks.

Valid Values: 1–2^31 (integer)

Default: 300

Refresh Type: Recycle

CTM_PRM_KPA_ROUNDTRIP_TIMEOUT

Time in seconds to wait for a confirmation from Control‑M/EM.

If confirmation does not arrive, a timeout is generated and the connection is severed.

Valid Values: any integer

Default: 300

Refresh Type: Recycle

CTM_VARIABLE_SHOUT_ON_ ERROR_URGENCY

Enables alerts to be sent when variables have not been resolved during job submission. You can set this parameter in the config.dat file.

The format for the parameter is:

CTM_VARIABLE_SHOUT_ON_ERROR_URGENCY <urgency>

Valid values:

  • N – Do not send alert
  • R – Regular (default value)
  • U – Urgent
  • V – Very urgent

For changes to take effect, restart Control-M/Server or run the following command:

ctmipc -dest ALL -msgid CFG

COMTIMOUT

Communication timeout in seconds.

Valid Values: 10–2^31

Default: 60 (seconds)

How / where to set: In the Control-M Main Menu, choose Parameter Customization => Default Parameters for Communicating with Agent Platforms => Communication Timeout.

Refresh Type: Recycle

COMTRYNO

Communication retry value.

Valid Values: 1–2^31 (seconds)

Default: 5

How / where to set: In the Control-M Main Menu, choose Parameter Customization => Default Parameters for Communicating with Agent Platforms => Maximum Retries.

Refresh Type: Recycle

OS_PRM_HOSTNAME

Used in various ways, for example, the name of the server to be sent to the Agent, for later comparison with the Agent's permitted server list.

Valid Values: 50 characters

Default: gethostname

How / where to set:

(UNIX) In the Control-M Main Menu, choose Parameter Customization => Basic Communication and Operational Parameters => Local IP host interface name.

Refresh Type: Recycle

OUTGOING_ADDR

Enables you to define an IP address for Server to Agent connections.

Valid Values: IP address or hostname

Default: hostname

Refresh Type: Recycle

Parent Topic

Control-M/Server parameters