Configuring Agent System Parameters

Determines the Control-M/Server port number that receives data from the Agent.

Port number specifies the Server computer port that receives data from the 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 Timeout value is the COMTIMOUT communication job-tracking timeout in seconds. Mandatory.

Valid values: 1024 - 65533

Default: 7005

Defines the primary Control-M/Server host (multi-subnet aware).

Defines one or more TCP/IP address or DNS name, separated by |, where each value identifies a Control-M/Server host authorized to connect to this Agent.

Describes the Server-Agent communication protocol version.

Valid values: 12 - 14

Default: 13

Determines the maximum number of times an Agent process must attempt to communicate with the Control-M/Server before declaring that there is no communication.

Valid Values: 1 - 99

Default: 12

Determines the time in seconds between failed attempts to retry to communicate with the Control-M/Server.

Valid Values: 1 - 99

Default: 1

Defines a logical name of the Agent.

The value must match the name that the Agent is defined by in Control-M/Server.

A logical name is used only when the Agent initiates the communication to Control-M/Server.

Replies and job status updates are sent by the Agent using the name the Control-M/Server uses to contact the Agent. This allows the server to use several aliases for the same Agent.

Default: Agent host name.

Determines whether the Agent can open a connection to the Control-M/Server when working in persistent connection mode.

Valid values:

• Y: Yes

• N: No

• A: Automatically connects to Control-M/Server in persistent connection mode

  Default: Y

Defines the network interface that the Agent listens on (multi-subnet aware).

It can be set to a specific hostname or IP address so that the Agent port is not opened in other interfaces .

Defines if the IP address or the host name is saved in CTMS_HOSTNAME.

Use this parameter if Control-M runs on a computer with more than one network card.

Determines the maximum time in seconds that an Agent utility waits for a response after sending a request to the Control-M/Server. Set this value higher than the value for TCP_IP_TIMEOUT.

Valid Values: 1 - 86400

Default:

• UNIX: 120

• Windows: 600

Determines the maximum time in seconds that TCP/IP connection times out. Set this value lower than the value for UTTIMEOUT.

Valid Values: 1 - 86400

Default: 120

Defines the authorized Control-M/Server IP address.

Determines the remote utilities port number.

Valid values: 1025 - 65535

Default: 8000

Determines whether the Agent utilities are uploaded to remote hosts.

Valid values:

• Y: Yes

• N: No

  Default: N

(OS/400 only) Sets the conversion table from ASCII to EBCDIC.

(OS/400 only) Sets the conversion table from EBCDIC to ASCII.

Determines the general debug diagnostics level.

Valid Values: 0 - 5

Determines the Agent diagnostics level.

Valid Values: 0 - 5

Determines the Agent submitter diagnostics level.

Valid Values: 0 - 5

Determines the Agent tracker diagnostics level.

Valid Values: 0 - 5

Determines the Agent router diagnostics level.

Valid Values: 0 - 5

Determines the utilities diagnostics level.

Valid Values: 0 - 5

Determines the Agent Java diagnostics level.

Valid Values: 0 - 5

Defines the First Failure Data Capture diagnostic level.

Valid Values: 0 - 5

Defines the time in seconds for First Failure Data Capture reset interval.

Valid Values: 1 - 86400

Default: 600

Determines the First Failure Data Capture diagnostic level for ON Statement processing.

Valid Values: 1 - 5

Default: 1

Determines the number of days to retain Agent log files.

After this period, agent proclog files are deleted by the New Day procedure.

Valid Values: 1 - 99

Default: 1

Determines the number of days to retain the files in the dailylog directory. These files contain the information about jobs that is used to calculate the metrics for the usage measurement report.

Valid Values: 1 - 99

Default: 7

Determines the number of days to retain the files in the DATA\rhdetails directory. These files contain the CPU specifications for agent, remote hosts and application plug-in server hosts.

Valid Values: 1 - 99

Default: 7

Determines the number of days to wait before STATUS, PROCID, ONSTMT, RUNTIME and non-root files are deleted from the Agent home directory after an Agent or host malfunction occurred.

Valid Values: 1 - 365

Default: 30

Determines if the daily ctmag log file is generated.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines the maximum size in MB of diagnostic log files for a process or a thread.

Valid Values: 1 - 1000

Default: 10

Determines the number of days to retain output files.

Valid Values: 1 - 99

Default: 10

Determines the number of KB to display from the start of the job output file.

Valid Values: 0 999999

Default: 0

Determines the number of KB to display from the end of the job output file.

Valid Values: 1 999999

Default: 0

Determines whether to return the actual exit code from Agent utilities.

Valid Values:

• Y: Yes

• N: No

  Default: N

Determines the prefix for the OUTPUT file name.

Values:

• MEMNAME: the OUTPUT file prefix is the MEMNAME of the job.

• JOBNAME: the OUTPUT file prefix is the JOBNAME of the job.

  Default: MEMNAME

Defines the name of the default printer used to print job output files.

Determines the number of days that the installation package is saved by the Agent.

Valid Values: 1 - 365

Default: 30

Determines the number of days to keep the backup4restore directory on the Control-M/Agent, which is used to downgrade to the original version of the Control-M/Agent after an upgrade has occurred.

Valid Values: 1 - 365

Default: 30

Determines whether all variables are set as environment variables in the script.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines the minimum free disk space in MB required for job submission.

Valid Values: 1 - 100000

Default: 50

Determines the minimum free disk space in MB to send an Agent alert.

Valid Values: 1 - 100000

Default: 100

Determines whether to wrap input parameters in double quotes.

Valid Values:

• 2: Parameter values are always passed to the operating system without quotes. If quotes were specified in the job definition, they are removed before the parameter is passed on by the Agent.

• 4: Parameters are passed to the operating system in exactly the same way that they were specified in the job definition. No quotes are added or removed in this case.

  Default: 4

Determines whether procedures invoked by a job can be run outside the job object.

This prevents the original job from remaining in execution mode until the invoked procedure completes.

Valid Values:

• Y: All procedures invoked by the job are run inside the job object.

• N: All procedures invoked by the job are run outside the job object.

  Default: Y

Determines whether a user-defined login script should be run by the Control-M/Agent before running the standard user login script.

Valid Values:

• Y: Yes

• N: No

  Default: N

Determines whether to print commands in the job output.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines whether to enable job recovery when the Agent monitoring process terminates unexpectedly.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Defines the code page for job processing in Latin-1 mode.

Valid Values: 1 - 99999

Default: 1252

(UNIX only) Indicates file access mode of the output file in octal values.

Valid Values: 600, 640, 644, 660, 664, 666

Default: 600

(UNIX only) Indicates file access mode of the output file for non-root mode when the job owner is not the Agent owner.

Valid values: 660, 664, 666

Default: 660

(UNIX only) Determines whether to enable a permissions check of the job script in non-root mode.

Valid Values:

• Y: Yes

• N: No

  Default: Y

(UNIX only) Defines the locale (LATIN-1 mode only).

Valid Values:

• C

• POSIX

• de_DE.iso88591

• en_GB

• en_GB.iso88591

• en_US

• en_US.iso88591

• es_ES.iso88591

• es_US.iso88591

• fr_FR.iso88591

• French

• German

• Spanish

(UNIX only) Defines the flag to set when submitting a job to Bourne Shell.

Valid Values: -x, -v, n, N

Default: -x

(UNIX only) Defines the flag to set when submitting a job to Korn Shell.

Valid Values: -x, -v, n, N

Default: -x

(UNIX only) Determines whether to save temporary files of a job.

For example: temporary script file, environment file, and view JCL file.

Valid Values:

• Y: Yes

• N: No

  Default: N

(UNIX only) Determines whether to replace $0 with the file name when submitting a script file job.

Valid Values:

• Y: Yes

• N: No

  Default: Y

(UNIX only) Defines the directory for temporary files during job submission.

(UNIX only) Defines a character used to enclose job processing parameters passed to jobs by Control-M/Server.

(UNIX only) Defines the full path to the alternative 'su' utility.

(UNIX only) Determines whether to enable PAM Authentication in non-root mode.

Valid Values:

• Y: Yes

• N: No

  Default: Y

(UNIX only) Defines permissions of debug log files in the proclog directory in octal values.

Valid Values: 600, 640, 644, 660, 664, 666

Default: 644

(UNIX only) Sets the umask of the user job process.

Valid Values: Unused, 000 ,002, 003, 007, 022, 023, 027, 033, 037, 077

Default: Unused

(UNIX only) Determines whether to include Agent identification environment variables in the job environment.

Valid Values:

• Y: Yes

• N: No

  Default: N

Defines the port number for sending messages to the Tracker process when jobs end.

Valid Values: 1025 - 65535

Determines the tracker polling interval in seconds

Valid Values: 1 - 86400

Default: 60

Determines the time in seconds that the Tracker process waits after tracking or event failure.

Valid Values: 0 - 99999

Determines the time in seconds that the Tracker process waits for the job status file after the job submission

Valid Values: 0 - 99999

Determines whether to allow the Agent Tracker process to send updates to Control-M/Server.

Valid Values:

• Y: Yes

• N: No

Determines whether the Tracker process sends job updates to the primary Control-M/Server rather than to the Control-M/Server host that submitted the job.

Valid Values:

• Y: Yes

• N: No

  Default: N

Determines whether to enable multiple parallel Trackers.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines the maximum number of tracker-workers that can run in parallel when there is no starvation. Starvation occurs by a job that causes repeated tracker-worker crashes, or by a job that causes a tracker-worker to hang.

Valid Values: 1 - 100

Default: 10

Determines the time in seconds for a job to be identified as recently tracked.

Set this parameter to avoid situations where a job is tracked by more than one tracker-worker in a short period of time.

Before a tracker-worker tracks a job, it checks if the job has recently been tracked, and determines whether to track it or not.

Valid Values: 1 - 60

Default: 15

Determines the optimal ratio between the number of jobs and the number of tracker-workers.

The actual ratio is determined by the number of jobs divided by the number of running tracker-workers.

Under normal circumstances, the tracker creates new tracker-workers if the actual ratio is more than the optimal ratio, and shuts down tracker-workers if the actual ratio is less than the optimal ratio.

Valid Values: 5 - 300

Default: 30

Determines the time in seconds that a job waits to be tracked before it is declared as starved.

Valid Values: 30 - 300

Default: 120

Determines the default chunk size in KB to read text from plug-ins.

Valid Values: 1 - 31

Determines the default chunk size in KB for View Output from plug-ins.

Valid Values: 1 - 30

Default: 2

Determines the default chunk size in KB for viewing and editing JCL code and documentation from plug-ins.

Valid Values: 1 - 30

Default: 2

Determines the default chunk size in KB for general requests from plug-ins.

Valid Values: 1 - 30

Default: 30

Determines the sleep interval in seconds between successive CPU monitor operations.

Valid Values: 10 - 3600

Default: 30

Determines the interval in minutes for the Agent CPU usage to be sent to the Control-M/Server.

Valid Values: 1 - 180

Default: 15

Determines the number of CPU samples used to calculate average CPU usage.

Valid Values: 3 - 60

Default: 3

Determines the time in seconds between Account Availability monitor operations.

Valid Values: 600 - 36000

Default: 3600

Determines whether to measure function calls.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines the time in minutes for the main Agent process to be considered not responsive.

A message is written to the daily log file.

Valid Values: 1 - 900

Default: 3

Determines the time in minutes for the Agent tracker process to be considered not responsive.

A message is written to the daily log file.

Valid Values: 1 - 900

Default: 3

Determines the time in minutes for the Agent router process to be considered not responsive.

A message is written to the daily log file.

Valid Values: 1 - 900

Default: 3

Determines the interval in minutes for the Agent to send an alert when a process does not respond.

Valid Values: 1 - 900

Default: 60

Determines the interval in minutes to check if there is enough free disk space.

Valid Values: 60 - 1440

Default: 60

Determines the number of hours to wait before the Agent validates SSL keystore and certificates when using SSL mode.

Valid Values: 1 - 1440

Default: 12

Determines whether to set the Java service as the router for all Server-Agent communications.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines whether the On Statement is processed by the Agent Tracker or by the Agent Monitor process.

Valid Values:

• Y: Agent Tracker

• N: Agent Monitor

  Default: N

Defines if the output for On Statement processes is case sensitive.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Defines the mode of support for foreign languages on the Agent.

Valid Values:

• LATIN-1

• CJK (Chinese-Japanese-Korean)

  Default: LATIN-1

Determines which user account is used for the services to log in to.

Valid Values:

• Y: Jobs are submitted with the permissions and environment variables of the specified user.

• N: Jobs are submitted with the permissions and environment variables of the local system account.

  Default: N

  You can modify this parameter using the ctmwincfg utility.

Defines the name of the SMTP server.

Determines the SMTP server port number.

Valid values: 0-65535

Default: 25

Defines the sender email address.

Defines the name or alias that appears on the email.

Determines the maximum number of attempts to restore connection to the remote host.

Valid Values: 0 - 99999

Default: 15

Determines the time in seconds between attempts to restore connection to the remote host.

Valid Values: 0 - 99999

Default: 120

Defines the location of the directory to store temporary files of Remote Host jobs.

These files are automatically moved to the Control-M/Agent when the jobs end and the network connection is available or restored.

Default: period (.)—the files are stored in the user home directory of the job owner in the remote host.

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

Valid Values:

• Y: Yes

• N: No

  Default: Y

Defines the SSH connection mode used in Agentless jobs.

Valid Values:

• 0: The Agent uses only the SSH protocol to upload and download files and to submit the job to the remote computer.

• 1: The Agent uses both SFTP and SSH protocols. Only one connection is opened during job execution.

• 2: The Agent used both SFTP and SSH protocols. Two connections are opened at the beginning of the job, but after a while the SSH connection is closed.

  Default: 2

Defines the SSH command to verify the remote platform version.

Valid values: Any valid command.

Default: cmd.exe /c ver

Determines whether to delete temporary files on the remote host after job execution.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines whether the output file is deleted from remote host computers.

Valid Values:

• Y: Yes

• N: No

  Default: N

Determines whether the output handling operations are performed on the remote host instead of on the Agent.

Valid Values:

• Y: Yes

• N: No

  Default: N

Determines whether to allow multiple remote host keys for clusters.

Valid Values:

• Y: Yes

• N: No

  Default: N

Defines the default queue for the OpenVMS remote host.

Default: sys$batch

Determines whether to save commands in the job output file for OpenVMS:

• Y: SET VERIFY

• N: SET NOVERIFY

• E: Inherit environment setting

  Default: Y

Determines the SSH connection timeout for job monitoring (Mode 2).

Valid Values: 1 - 86400

Default: 300

Determines the interval in seconds between job completion monitoring (SSH).

Valid Values: 1 - 86400

Default: 0

Determines the time in milliseconds to wait for WMI events.

Valid Values: 1000 - 900000

Default: 50000

Determines how WMI remote host availability is checked.

Valid Values:

• Y: TCP ping only

• N: WMI and TCP ping

  Default: N

Defines the shared directory name used by the Agent for WMI jobs.

Default: SYSOUT

Determines whether the post processing actions of move, copy, or delete the job outputs are performed from the remote host.

Valid Values:

• Y: Yes

• N: No

  Default: Y

Determines whether to check for the remote host platform for every job.

Valid Values:

• Y: Yes

• N: No

• M: Manual enforcement by setting the %%RJX_REMOTE_PLATF variable of the job

Determines the maximum number of jobs that can use a single connection.

Connections are monitored and are released when not in use.

Valid Values: 0 - 99999

Default: 10

Determines the time in minutes for a thread to monitor the connections and release unused ones.

Valid Values: 0 - 99999

Default: 10

Determines the maximum number of minutes to check the status of open connections.

Valid Values: 0 - 99999

Default: 10

Determines the number of retries when communicating with the SSH-courier.

Valid Values: 1 - 1000

Default: 10

Determines the time in seconds to wait before Agent processes shut down.

This value is multiplied by the number of installed plug-ins.

Valid Values: 1 - 30

Defines the prefix for the generated device ID, no more than 5 characters.

Determines the default number of maximum replies on a *RPY action for the 'Display Program Messages' screen.

Defines the default reply on a *RPY action for the 'Display Program Messages' screen.

Defines the Display Program Messages default action to take.

Defines the screen title that appears for the Display Program Messages dialog. This dialog can have a different title on non-English systems.

Defines the BRKMSG attribute of the terminal job, which can prevent messages from disrupting the VT flow.

Determines whether to include screen images in the job output and their location.

Determines whether the job log of the terminal job is appended to the VT job log or replaces it.

Defines the character to replace Non-display output fields. If not set, Non-display fields appear blank.

Defines the character to replace the reverse image output fields. If not set, reverse image fields show their textual value.

Determines whether to disable the On Statement processing over the screen images output.

Determines whether to skip the DSPLOG action for terminal jobs without a job log.

Set to Y if you encounter long delays in post processing of VT jobs.

Defines the name of a qualified (Library/Name) or non-qualified (Name) of a program to carry out the Report Distribution of ended jobs.

Defines the parallel post-processing actions to take.

Determines whether to disable the freeform On Statement.

When disabled, report distribution is spawned by the Tracker.

Determines the minimum number of pages where automatic Parallel Post Processing takes place.

Defines the default job log output (LOGOUTPUT) attribute for job submission.

Determines whether to enable resolution of special values in regular job parameters, which does not impact special value resolution in Virtual Terminal or Script file jobs.

Defines the default CCSID for all jobs which can be any valid CCSID or one of the special values: *SYSVAL, *USRPRF, *HEX.

Defines the list of valid SBMJOB command parameters.

Defines the prefix to use when setting the attributes of a job as Environment Variables.

Determines whether to allow overriding the message queue of the submitted job.