Universal Automation Center Agent Configuration Options

Owned by Stonebranch (Deactivated)
Last updated: Oct 01, 2024 by Tony Partin

Overview

This page provides links to detailed information on the configuration options available for use with the Universal Automation Center Agent (UAG).

The options are listed alphabetically, without regard to any specific operating system.

Configuration Options Information

For each configuration option, these pages provide the following information.

Description

Describes the configuration option and how it is used.

Usage

Provides a table of the following information:

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Configuration File Keyword

<Format / Value>






Method

Identifies the method used to specify Universal Automation Center Agent configuration options:

  • Configuration File Keyword

Syntax

Identifies the syntax of the method used to specify the option:

  • Format: Specific characters that identify the option.
  • Value: Type of value(s) to be supplied for this method.

(Operating System)

Identifies the operating systems for which each method of specifying the option is valid:

  • IBM i
  • UNIX
  • Windows
  • z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

Additional Information>

Identifies any additional information specific to the option.

Configuration Options List

The following table identifies all Universal Automation Center Agent configuration options. Each Option Name is a link to detailed information about that option.


Option Name

Description

AGENT_CLUSTERS

List of Agent Clusters to join automatically.

AGENT_IP

IP address of an Agent.

AUTOMATIC_FAILOVERSpecification for whether or not automatic failover is used. 
BUSINESS_SERVICES

Specification for the list of Business Services to join automatically.

CF_STRUCT_NAME

Name of a Coupling Facility structure that will be used to communicate from the secondary Agents to the primary Agent.

CODE_PAGE

Text translation code page.

DATA_DIRECTORY

Base directory for the UAG cache/, logs/, and var/ sub-directories.

DSN_DELETE_EXCLUDE

Data sets that are excluded from UAG re-run data set delete processing.

END_SEVERITYSpecifies the message severity level that must be reached in order for the Initiator job to terminate.

EXTENSION_ACCEPT_LIST

Lists Extensions that Universal Agent will accept via auto-deployment from Universal Controller.

EXTENSION_CANCEL_TIMEOUTLength of time that a Universal Extension task is given to complete its response to a CANCEL request received from Universal Controller.

EXTENSION_DEPLOY_ON_REGISTRATION

Controls Extension deployment behavior from Universal Controller.

EXTENSION_PYTHON_LIST

Controls Extension deployment behavior from Universal Controller.

FM_CREATE_FAIL_NODIR

Specification for whether or not a Universal Controller File Monitor task with a Monitor Type of Create will fail if the directory specified in the file(s) to monitor does not exist.

FM_FAULT_TOLERANT

Specification for whether or not File Monitors will behave in a fault tolerant manner.

FM_FAULT_TOLERANT_TIMEOUT

Specification for the amount of time that a fault tolerant File Monitor will tolerate a temporary fault condition before failing.

FM_FILES_OWNERSHIP

Specification for whether or not to retrieve file ownership information in Agent File Monitors.

FTP_FM_FAULT_TOLERANCE

Specification for whether or not to enable fault tolerance for FTP File Monitors when UFTP is executed from UAG.

GDG_PROCESSING

Specification for the type of GDG processing to use.

HIGH_COMMON_STORAGE

Maximum amount of high common storage (in MB) that will be used by an Agent to stage job tracking information.

INSTALLATION_DIRECTORY

Base directory where product is installed.

JCL_LIBRARY

JCL library ddname allocations.

JCL_SAVE_LIBRARY

JCL for all jobs submitted by UAG will be saved here.

JES_SYSOUT_CLASS

JES held class dedicate to UAG SYSOUT processing.

JES_SYSOUT_DISP

Disposition of a job's SYSOUT data sets once UAG has completed processing them.

JES_SYSOUT_RETENTION

Number of hours that job SYSOUT files are retained in the UAG cache directory.

JES_SYSOUT_SPACEAllow configurable space parameters for UAGSRV Temporary Output Datasets on z/OS.
JES_SYSOUT_TIMEOUTMake timeout on JES output read configurable.

JSC_DATASET

Name of the VSAM Job Submission Checkpoint cluster. In a sysplex environment, all Agents sharing the same system ID must use the same JSC.

JTSK_NUM

Number of job task worker threads (JTSK threads) created, which are responsible for job-related services, such as job submission, tracking, and JES sysout collection.

KILL_PROCESS_TREESpecification for whether or not UAG should always terminate the entire task process tree when a Cancel command is issued.

LOGLVL

Logging level of UAG.

LOGON_METHOD

Specification for whether the Batch Logon or Interactive Logon type will be used for all of the tasks executed by the Agent.

MAX_SSL_PROTOCOL  Maximum SSL/TLS protocol level that will be negotiated and used for communications channels.

MESSAGE_LEVEL

Level of messages written.

MIN_SSL_PROTOCOL

Minimum SSL/TLS protocol level that will be negotiated and used for communications channels.

NETNAME

Default network ID of UAG.

OMS_SERVERS

Port and network address of the Universal Message Service (OMS) server(s) used for network communications.

OTEL_ENABLE_TRACING Specification for whether UAG will export traces to the OpenTelemetry collector.
OTEL_EXPORT_METRICS Specification for whether UAG will export metrics to the OpenTelemetry collector.
OTEL_METRICS_ENDPOINT URL used to export UAG metric data using the OTLP/HTTP(S) protocol to the OpenTelemetry Collector.
OTEL_METRICS_EXPORT_INTERVAL Interval for how often to export the metrics to the OpenTelemetry Collector.
OTEL_SERVICE_NAME Value of the service.name resource attribute used to identify UAG in traces and metrics.
OTEL_SSL_CA_CERT_PATH Full path to the file containing one or more X.509 trusted certificates in PEM format. The certificate(s) will be used to validate the OpenTelemetry Collector (server).
OTEL_SSL_CLIENT_CERT_PATH Full path to an X.509 certificate used to identify UAG to the OpenTelemetry Collector.
OTEL_SSL_CLIENT_KEY_PATH Full path to the PEM formatted file containing the private key associated with the client certificate specified by the OTEL_SSL_CLIENT_CERT_PATH option.
OTEL_SSL_INSECURE_SKIP_VERIFY Specification for whether to validate the Opentelemetry Collector's (server's) certificate against the locally configured CA certificate (specified by OTEL_CA_CERT_PATH option).
OTEL_TRACE_ENDPOINT URL used to export UAG trace data using the OTLP/HTTP(S) protocol to the Opentelemetry Collector.
OTEL_UIP_SERVICE_NAME Value of the service.name resource attribute used to identify an Extension worker process in traces and metrics.

PDSE_SHARING

Specification for whether UAG will allocate PDS/E datasets for output with DISP=SHR (yes) or DISP=OLD (no).
PROCESS_CANCEL_TIMEOUTLength of time that an OS task is given to complete its response to a CANCEL request received from Universal Controller.
PROXY_URLSpecifies the proxy server address to be used for OMS connection.