Configuring Agent System Parameters

This procedure describes how to access the Agent system parameters:

Begin

  1. From the icon, select Configuration.

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

    The Agents pane appears.

  3. From the Advanced Tools drop-down list, select System Parameters.

    The Agent System Parameters tab opens.

Agent Environment Parameters

The following table describes the Agent environment system parameters.

Parameter

Description

AGENT_DIR

Defines the Control-M/Agent home directory.

This parameter cannot be changed or deleted.

Communication Parameters

The following table describes the communication Agent system parameters.

Parameter

Description

ATCMNDATA

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.

7005/30

Increasing the Timeout value reduces agent performance.

Valid Values: 1024–65533

Default: 7005

CTMSHOST

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

CTMPERMHOSTS

Defines one or more TCP/IP addresses or DNS names, separated by a | (vertical bar, or pipe), where each value identifies a Control-M/Server host that is authorized to connect to this Agent.

PROTOCOL_VERSION

Describes the Server-Agent communication protocol version.

Valid Values: 12–14

Default: 13

COMMRETCNT

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

COMMRETSLP

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

Valid Values: 1–99

Default: 1

LOGICAL_AGENT_NAME

Defines a logical name for 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 communication to Control-M/Server.

Replies and job status updates are sent by the Agent using the name that 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.

The default value can differ in the case of a cluster installation or if the Agent host name has aliases.

ALLOW_COMM_INIT

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

LISTEN_INTERFACE

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

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

CTMS_ADDR_MODE

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

UTTIMEOUT

Determines the maximum number of 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–86,400

Default:

  • UNIX: 120

  • Windows: 600

TCP_IP_TIMEOUT

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

Valid Values: 1–86,400

Default: 120

AUTHORIZED_CTM_IP

Defines the authorized Control-M/Server IP address.

RU_COMM_PORT

Determines the remote utilities port number.

Valid Values: 1025–65535

Default: 8000

UPLOAD_REMOTE_UTILS

Determines whether the Agent utilities are uploaded to remote hosts.

Valid Values:

  • Y: Yes

  • N: No

Default: N

CMN_ASCII2EBCDIC

(OS/400 Only) Changes the conversion table from ASCII to EBCDIC.

CMN_EBCDIC2ASCII

(OS/400 Only) Changes the conversion table from EBCDIC to ASCII.

COMM_CONNECT_BLOCKING

(OS/400 Only) Determines whether to revert to blocking connect. Non-blocking is preferable.

Diagnostics Parameters

The following table describes the diagnostics Agent system parameters.

Parameter

Description

DBGLVL

Determines the general debug diagnostics level.

Valid Values: 0–5

AGDBGLVL

Determines the Agent diagnostics level.

Valid Values: 0–5

ASDBGLVL

Determines the Agent submitter diagnostics level.

Valid Values: 0–5

ATDBGLVL

Determines the Agent tracker diagnostics level.

Valid Values: 0–5

ARDBGLVL

Determines the Agent router diagnostics level.

Valid Values: 0–5

UTDBGLVL

Determines the utilities diagnostics level.

Valid Values: 0–5

AJDBGLVL

Determines the Agent Java diagnostics level.

Valid Values: 0–5

BUFFERED_DBGLVL

Defines the First Failure Data Capture diagnostic level.

Valid Values: 0–5

DBG_RESET_INTERVAL

Defines the number of seconds for the First Failure Data Capture reset interval.

Valid Values: 1–86400

Default: 600

ONSTMT_BUFFERED_DBGLVL

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

Valid Values: 1–5

Default: 1

LOGKEEPDAYS

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

MEASURE_USAGE_DAYS

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

Valid Values: 1–99

Default: 7

RH_KEEPDAYS

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

Valid Values: 1–99

Default: 7

GENERAL_CLEANUP_INTERVAL

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 occurs.

Valid Values: 1–65

Default: 100

AG_LOG_ON

Determines whether to generate the daily ctmag log file.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

LIMIT_LOG_FILE_SIZE

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

You must stop and start the Agent after you make changes to this parameter.

Valid Values: 1–1,000

Default: 10

LIMIT_LOG_VERSIONS

Determines the number of generations of diagnostic log information to keep for a process or a thread.

You must stop and start the Agent after you make changes to this parameter.

Valid Values: 0–99

Default: 10

Output Parameters

The following table describes the output Agent system parameters.

Parameter

Description

SYSKEEPDAYS

Determines the number of days to retain output files.

Valid Values: 1–99

Default: 10

OUTPUT_LIMIT_SIZE_START

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

Valid Values: 0–999,999

Default: 0

OUTPUT_LIMIT_SIZE_END

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

Valid Values: 1–999,999

Default: 0

UTIL_REAL_EXIT_CODE

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

Valid Values:

  • Y: Yes

  • N: No

Default: N

OUTPUT_NAME

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

You can modify this parameter using the ctmwincfg and ctmunixcfg utilities.

DFTPRT

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

You can modify this parameter using the ctmwincfg and ctmunixcfg utilities.

JOB_STATISTIC

Determines whether the job object statistics must be included in the job output.

Valid Values:

  • Y: Statistics are added to the end of the OUTPUT file.

  • N: Statistics are not added to the OUTPUT file.

Default: Y

You can modify this parameter using the ctmwincfg utility.

Recovery Parameters

The following table describes the recovery Agent system parameters.

Parameter

Description

WATCHDOG_ENABLED

Determines whether to allow the recovery of failed Agent processes.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

Agent Deployment Parameters

The following table describes the Agent deployment Agent system parameters.

Parameter

Description

AD_RETAIN_PACKAGES

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

Valid Values:

Default: 30

AD_GA_RETAIN_DAYS

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

If you do not plan to downgrade the Agent, BMC recommends that you delete the directory to save disk space.

Valid Values: 1–365

Default: 30

AD_DECODING_BY_CHUNKS

Determines whether to decode the Agent package by chunks in auto-deployment.

Valid Values:

  • Y: Yes

  • N: No

Default: N

Submission Parameters

The following table describes the submission Agent system parameters.

Parameter

Description

USE_JOB_VARIABLES

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

Creation of environment variables is subject to the requirements and limitations of the operating system. On UNIX and Linux, variables that begin with %%$ (that is, variables that begin with the $ character after the %% prefix, such as %%$ODATE) are not recognized and are not converted.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

MIN_FREE_SPACE

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

Valid Values: 1–100,000

Default: 50

MIN_FREE_SPACE_WARN

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

Valid Values: 1–100,000

Default: 100

WRAP_PARAM_QUOTES

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

  • You can modify this parameter using the ctmwincfg utility.

  • You can, alternatively, enforce one of the above values at the job level, by defining a local variable in a specific job:

    %%WRAP_PARAM_QUOTES = <1|2|3|4>

JOB_WAIT

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 that are invoked by the job are run inside the job object.

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

Default: Y

RUN_USER_LOGON_SCRIPT

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

Valid Values:

  • Y: Yes

  • N: No

Default: N

ECHO_OUTPUT

Determines whether to print commands in the job output.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

You can modify this parameter using the ctmwincfg utility.

ENABLE_RECOVERY

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

Valid Values:

  • Y: Yes

  • N: No

Default: Y

CODE_PAGE

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

Valid Values: 1–99,999

Default: 1,252

OUTPUT_MODE

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

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

Default: 600

OUTPUT_MODE_AS_USER

(UNIX/Linux) 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

ENABLE_NON_ROOT_CHECKS

(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

LOCALE

(UNIX/Linux) 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

CTM_PRM_SH_FLAGS

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

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

Default: -x

CTM_PRM_KSH_FLAGS

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

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

Default: -x

CTM_PRM_DONT_DELETE

(UNIX/Linux) Determines whether to save temporary files for a job.

  • A temporary script file.

  • An environment file.

  • A view JCL file.

Valid Values:

  • Y: Yes

  • N: No

Default: N

TRANSLATE_$0

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

Valid Values:

  • Y: Yes

  • N: No

Default: Y

CM_TEMP_SCRIPTS_DIR

(UNIX/Linux) Defines the directory where temporary files are saved during job submission.

CTM_PARM_ENC

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

CTM_SU_PATH

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

ENABLE_PAM

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

Valid Values:

  • Y: Yes

  • N: No

Default: Y

PROCLOG_MODE

(UNIX/Linux) Defines permissions for debug log files in the proclog directory, in octal values.

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

Default: 644

UMASK_MODE

(UNIX/Linux) Sets the umask of the user job process.

Valid Values:

  • Unused

  • 000

  • 002

  • 003

  • 007

  • 022

  • 023

  • 027

  • 033

  • 037

  • 077

Default: Unused

AGENT_ENV_IN_JOB

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

Valid Values:

  • Y: Yes

  • N: No

Default: N

ENABLE_JOB_VARIABLES_VALIDATION

(UNIX/Linux) Determines whether to enable checking job variables for invalid characters.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

Tracking Parameters

The following table describes the tracking Agent system parameters.

Parameter

Description

TRACKER_EVENT_PORT

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

Valid Values: 1025–65535

EVENT_TIMEOUT

Determines the tracker polling interval, in seconds.

Valid Values: 1–86,400

Default: 60

RETRY_TIMEOUT

Determines the number of seconds the Agent Tracker process waits after tracking or event failure.

Valid Values: 0–99,999

RECOVERY_TIMEOUT

Determines the number of seconds the Agent Tracker process waits for the job status file after job submission.

Valid Values: 0–99,999

AGENT_TO_SERVER_CONNECT

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

Valid Values:

  • Y: Yes

  • N: No

AT_UPDATE_PRIMARY

Determines whether the Agent 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

DELETE_BACKUP_FILES

Determines whether to delete the job backup file after the job output file is moved or deleted.

Valid Values:

  • Y: Yes

  • N: No

Default: N

Multitracker Parameters

The following table describes the multitracker Agent system parameters.

Parameter

Description

MULTITRACK_ENABLED

Determines whether to enable multiple parallel Agent Trackers.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

MULTITRACK_MAX_PROC

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

Valid Values: 1–100

Default: 10

MULTITRACK_SKIP_INTERVAL

Determines the number of seconds that a job is 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.

Valid Values: 1–60

Default: 15

MULTITRACK_JOBS_PER_WORKER

Determines the optimal ratio between the number of jobs and 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 when the actual ratio is more than the optimal ratio. It shuts down tracker-workers if the actual ratio is less than the optimal ratio.

Valid Values: 5–300

Default: 30

MULTITRACK_LATE_PERIOD

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

Valid Values: 30–300

Default: 120

MULTITRACK_MAIN_EVENT_TIMEOUT

Determines the number of seconds that the main tracker process waits for events.

The main tracker first tracks events that may be sent from completed jobs, and then tracks completed jobs that do not send events.

Valid Values: 10–240

Default: 30

Performance Parameters

The following table describes the performance Agent system parameters.

Parameter

Description

CM_CHUNK_SIZE

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

Valid Values: 1–31

CM_OUTPUT_CHUNK_SIZE

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

Valid Values: 1–30

Default: 2

CM_JCLDOC_CHUNK_SIZE

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

Valid Values: 1–30

Default: 2

CM_GENERAL_CHUNK_SIZE

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

Valid Values: 1–30

Default: 30

ACCUMULATED_BUFF_SIZE

Determines the buffer size, in KB, to accumulate text from plug-ins to CTMS.

Valid Values: 0–250

Default: 250

Workload Parameters

The following table describes the workload monitoring Agent system parameters.

Parameter

Description

WKL_SLEEP_INTERVAL

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

Valid Values: 10–3,600

Default: 30

WKL_HB_INTERVAL

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

Valid Values: 1–180

Default: 15

WKL_CPU_SAMPLE_NUM

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

Valid Values: 3–60

Default: 3

WKL_CPU_SAMPLE_INTERVAL

Determines the number of seconds between CPU samples to calculate a single, average CPU usage.

Valid Values: 2–60

Default: 5

Account Availability Parameters

The following table describes the account availability Agent system parameters.

Parameter

Description

CMACC_AV_INTERVAL

Determines the interval, in seconds, between Account Availability monitor operations.

Valid Values: 600–36,000

Default: 3,600

CMACC_UNAV_INTERVAL

Determines the interval, in seconds, between Account Unavailability monitoring.

Valid Values: 100

Default: 90

Measure Parameters

The following table describes the measure Agent system parameters.

Parameter

Description

MEASURE_FUNCTION_CALLS

Determines whether to measure function calls.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

WRITE_MEASURES_INTERVAL

Determines the interval in minutes between write measures.

Valid Values: 15–1440

Default: 60

Maintenance Parameters

The following table describes the maintenance Agent system parameters.

Parameter

Description

AG_NOT_RESPONDING_TIME

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

A message is written to the daily log file.

Xalert messages are controlled by the PROCESS_NOT_RESPONDING_ALERT_INTERVAL parameter, which is influenced by the <X>_NOT_RESPONDING_TIME parameters.

Valid Values: 1–900

Default: 3

AT_NOT_RESPONDING_TIME

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

A message is written to the daily log file.

Xalert messages are controlled by the PROCESS_NOT_RESPONDING_ALERT_INTERVAL parameter, which is influenced by the <X>_NOT_RESPONDING_TIME parameters.

Valid Values: 1–900

Default: 3

AR_NOT_RESPONDING_TIME

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

A message is written to the daily log file.

Xalert messages are controlled by the PROCESS_NOT_RESPONDING_ALERT_INTERVAL parameter, which is influenced by the <X>_NOT_RESPONDING_TIME parameters.

Valid Values: 1–900

Default: 3

PROCESS_NOT_RESPONDING_ALERT_INTERVAL

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

Valid Values: 1–900

Default: 60

CHECK_DISKSPACE_INTERVAL

Determines the number of minutes to wait between checks that determine if there is enough free disk space.

Valid Values: 60–1,440

Default: 60

SSL_CONTEXT_VALIDATION_INTERVAL

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

Valid Values: 1–1,440

Default: 12

SSL_CONTEXT_VALIDATION_DAYS

Determines the number of days in advance that the Agent checks if the SSL keystore and certificates will expire when using SSL mode.

Valid Values: 1–3,650

Default: 7

Java Parameters

The following table describes the Java Agent system parameters.

Parameter

Description

JAVA_AR

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

Valid Values:

  • Y: Yes

  • N: No

Default: Y

AG_JAVA_HOME

Defines the path to the external Java directory.

OnStatement Parameters

The following table describes the OnStatement Agent system parameters.

Parameter

Description

DISABLE_CM_ONSTMT

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

ONSTMT_CASE_SENSITIVE

Determines whether the output for On Statement processes is case sensitive.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

ONSTMT_ADD_WILD

Determines whether the On Statement and On Code should be enclosed with the * (asterisk) wildcard character during On Statement processing.

Valid Values:

  • Y: Yes

  • N: No

Default: N

Globalization Parameters

The following table describes the globalization Agent system parameters.

Parameter

Description

I18N

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

Valid Values:

  • LATIN-1

  • CJK (Chinese-Japanese-Korean)

Default: LATIN-1

APPLICATION_LOCALE

Defines the CJK encoding used by the Agent to run jobs.

Security Parameters

The following table describes the security Agent system parameters.

Parameter

Description

LOGON_AS_USER

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.

  • You must manually grant Logon as a Batch Job privileges to a new user.

DOMAIN

Defines the login domain name.s

The domain is determined by the value of this parameter if <domain> is not specified in <domain>\<username> in the Run_As parameter of the job definition.

If the domain is not specified, the user profile is searched for in the trusted domains.

  • BMC recommends that you do not specify a value for Log in Domain.

  • You can modify this parameter using the ctmwincfg utility.

Email Parameters

The following table describes the email Agent system parameters.

You can modify these parameters using the ctmwincfg and ctmunixcfg utilities.

Parameter

Description

SMTP_SERVER_NAME

Defines the name of the SMTP server.

SMTP_PORT_NUMBER

Determines the SMTP server port number.

Valid Values: 0–65535

Default: 25

SMTP_SENDER_EMAIL

Defines the sender email address.

SMTP_SENDER_FRIENDLY_NAME

Defines the name or alias that appears on the email.

SMTP_REPLY_TO_EMAIL

Defines the email address for replies. If this field is left empty, the sender email address is used.

Agentless Parameters

The following table describes the Agentless system parameters.

Parameter

Description

RJX_CONN_TRY

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

Valid Values: 0–99,999

Default: 15

RJX_CONN_TOUT

Determines the number of seconds between attempts to restore the connection to the remote host.

Valid Values: 0–99,999

Default: 120

RJX_OUTPUT_DIR

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

These files are automatically moved to the 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.

RJX_DETAILS_TO_OUTPUT

Determines whether to include details that are related to the remote connection in the job output for jobs that execute on a remote host.

Valid Values:

  • Y: Yes

  • N: No

Default: Y

RJX_CONN_MODE

Defines the SSH connection mode that is 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

  • The values 0 and 1 are not supported.

  • BMC recommends that you only use value 2.

SSH_VER_CMD

Defines the SSH command to verify the remote platform version.

Valid Values: Any valid command.

Default: cmd.exe /c ver

RJX_CLEAN_ENV

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

Valid Values:

  • Y: Yes

  • N: No

Default: Y

RJX_KEEP_OUTPUT

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

Valid Values:

  • Y: Yes

  • N: No

Default: N

RJX_COPY_OUTPUT_REMOTE

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

RJX_MULTIPLE_HOST

Determines whether to allow multiple remote host keys for clusters.

Valid Values:

  • Y: Yes

  • N: No

Default: N

RJX_SSH_CLOSE_TOUT

Determines the number of seconds for SSH connection timeout in job monitoring (Mode 2).

Valid Values: 1–86,400

Default: 300

RJX_LIFE_CHK_INTERVAL

Determines the number of seconds between job completion monitoring (SSH).

Valid Values: 1–86,400

Default: 0

WMI_WAIT_TIME_OUT

Determines the number of milliseconds to wait for WMI events.

Valid Values: 1,000–900,000

Default: 50,000

WMI_TCP_ONLY_PING

Determines how the WMI remote host availability is checked.

Valid Values:

  • Y: TCP ping only.

  • N: WMI and TCP ping.

Default: N

WMI_REMOTE_SHARED_NAME

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

Default: SYSOUT

WMI_MONITORING_METHOD

Determines whether to set the WMI monitoring mode to asynchronous or synchronous.

Valid Values:

  • ASYNC: Asynchronous

  • SYNC: Synchronous

Default: ASYNC

RJX_DOWNLOAD_OUTPUT

Determines whether the remote host performs the post-processing actions (move, copy, or delete the job outputs).

Valid Values:

  • Y: Yes

  • N: No

Default: Y

RJX_FORCE_OS_CHECKING

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.

RJX_POOL_CONNECTION_LIMIT

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–99,999

Default: 10

RJX_POOL_SLEEP_TIME

Determines the number of minutes for a thread to monitor the connections and release unused ones.

Valid Values: 0–99,999

Default: 10

RJX_POOL_KEEP_UNUSED

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

Valid Values: 0–99,999

Default: 10

RJX_SSH_RETRIES

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

Valid Values: 1–1,000

Default: 10

RJX_COURIER_DELAYED_SSH_CLOSE

Determines whether to keep the SSH channel open during remote job execution.

Valid Values:

  • Y: Yes

  • N: No

Default: N

Miscellaneous Parameters

The following table describes the miscellaneous Agent system parameters.

Parameter

Description

KILL_EXIT_CODE

Determines the exit code for killed jobs.

Valid Values: 1–9,999

Default: N/A

Documentation Parameters

The following table describes the documentation Agent system parameters.

Parameter

Description

USE_JCL_AGENT_OWNER

(UNIX/Linux) Determines whether the Agent owner is used to access the View Documentation function.

Valid Values:

  • Y: Yes

  • N: No

Default: N

Management Parameters

The following table describes the management Agent system parameters.

Parameter

Description

CM_SHUTDOWN_INTERVAL

Determines the number of seconds to wait before Agent processes shut down.

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

Valid Values: 1–30

MFT_INSTALL_JAVA_32

Defines the path of the Java 32-bit external directory for MFT installation.

OS400 CTMVT Device Management Parameters

The following table describes the OS400 CTMVT device management Agent system parameters.

Parameter

Description

CTMVT_GENDEV_PREFIX

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

CTMVT_DLT_VTDEV

Determines whether to delete the selected virtual terminal device when job completes.

OS400 CTMVT Display Program Messages Handling Parameters

The following table describes the OS400 CTMVT display program messages handling Agent system parameters.

Parameter

Description

CTMVT_DSPPGMMSG_DFTMAXRPY

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

CTMVT_DSPPGMMSG_DFTRPY

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

CTMVT_DSPPGMMSG_DFTACT

Defines the Display Program Messages default action to take.

CTMVT_DSPPGMMSG_TITLE

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

CTMVT_BRKMSG

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

CTMVT_DSPPGMMSG_DFTGOTO

Defines the default GOTO label to jump on a *GOTO action for the 'Display Program Messages' screen.

OS400 CTMVT Job Control Parameters

The following table describes the OS400 CTMVT job control Agent system parameters.

Parameter

Description

CTMVT_DISABLE_VRYOFF_ENDJOB

Determines whether to disable Vary Off virtual terminal device and ENDJOB. If disabled, virtual terminal devices might remain active and might be unusable for future use.

OS400 CTMVT Output Parameters

The following table describes the OS400 CTMVT output Agent system parameters.

Parameter

Description

INCSCRIMG

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

JOBLOG_MODE

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

CTMVT_NONDISPLAY_CHAR

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

CTMVT_REVERSEIMG_CHAR

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

DISABLE_SCRIMG_ONSTMT

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

CTMVT_SKIP_DSPLOG

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.

CTMRSTRCTD_DLY_BEFORE_ENDTCP

Determines the delay time, in seconds, between ending TCPIP servers and ending the TCPIP processes.

OS400 Output Parameters

The following table describes the OS400 output Agent system parameters.

Parameter

Description

RPTDSTPGM

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

RPTDSTPRF

Defines the default Report distribution profile.

OS400 Post Processing Parameters

The following table describes the OS400 post processing Agent system parameters.

Parameter

Description

PARALLEL_PP_ACTION

Defines the parallel post-processing actions to take.

DISABLE_FREEFORM_ONSTMT

Determines whether to disable the freeform On Statement.

When disabled, report distribution is spawned by the Tracker.

PARALLEL_PP_FILTER

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

SKIP_DSPLOG

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

Set to Y if you encounter long delays in post-processing of jobs without job log.

OS400 Submission Parameters

The following table describes the OS400 submission Agent system parameters.

Parameter

Description

LOGOUTPUT

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

RSVSPCVAL

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.

DFTCCSID

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

SBMJOBPRM

Defines the list of valid SBMJOB command parameters.

SETENV_PREFIX

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

OVRMSGQ

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

SBMJOBCMD

Defines the name of the command to submit jobs.