Universal Data Mover Manager Configuration Options

Universal Data Mover Manager Configuration Options

This page provides links to detailed information on the configuration options available for use with the Universal Data Mover Manager.

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

UNIX

Windows

z/OS

Command Line, Short Form

<Format / Value>





Command Line, Long Form

<Format / Value>





Environment Variable

<Format / Value>





Configuration File Keyword

<Format / Value>





STRUDM Parameter

<Format / Value>





Method

Identifies the different methods used to specify Universal Data Mover Manager configuration options:

  • Command Line Option, Short Form
  • Command Line Option, Long Form
  • Environment Variable
  • Configuration File Keyword
  • STRUDM Parameter

Note

Each option can be specified using one or more methods.

Syntax

Identifies the syntax of each method that can be used to specify the option:

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

Note

If a Method is not valid for specifying the option, the Syntax field contains n/a.

(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 UDM Manager configuration options.

Option

Description

ACK_WINDOW

Amount of data transferred in Network Fault Tolerant (NFT) mode before waiting for a data acknowledgement message from the receiver.

ACTIVITY_MONITORING

Specification for whether or not product activity monitoring events are generated.

ALLOC_ABNORMAL_DISP

Disposition of data set when an abnormal ending occurs.

ALLOC_BLKSIZE

Block size used for newly allocated data sets.

ALLOC_DATACLAS

SMS data class used for newly allocated data sets.

ALLOC_DIR_BLOCKS

Number of directory blocks for newly allocated partitioned data sets.

ALLOC_DSORG

Data set organization used for newly allocated data sets.

ALLOC_INPUT_STATUS

Status of data sets being allocated for input.

ALLOC_LRECL

Logical record length used for newly allocated data sets.

ALLOC_MGMTCLAS

SMS management class used for newly allocated data sets.

ALLOC_NORMAL_DISP

Disposition of data set when normal ending occurs.

ALLOC_OUTPUT_STATUS

Status of existing data sets being allocated for output.

ALLOC_PRIM_SPACE

Primary space allocation used for newly allocated data sets.

ALLOC_RECFM

Record format used for newly allocated data sets.

ALLOC_SEC_SPACE

Secondary space allocation used for newly allocated data sets.

ALLOC_SPACE_UNIT

Space unit in which space is allocated for newly allocated data sets.

ALLOC_STORCLAS

SMS storage class used for newly allocated data sets.

ALLOC_UNIT

Unit used for newly allocated data sets.

ALLOC_VOLSER

Volume serial number used for newly allocated data sets.

ALLOW_REPL_ON_RENAME

Specification for whether or not the UDM rename command will succeed if the new file name provided in that command matches the name of an existing file.

BIF_DIRECTORY

Broker Interface Directory that specifies the location of the Universal Broker interface file.

CA_CERTIFICATES

File name / ddname of the PEM-formatted trusted CA X.509 certificates.

CERTIFICATE

File name / ddname of UDM Manager's PEM-formatted X.509 certificate.

CERTIFICATE_EXPIRATION_NOTICE

Number of days prior to certificate expiration to begin issuing informational messages about the expiration.

CERTIFICATE_REVOCATION_LIST

File name / ddname of the PEM-formatted CRL.

CODE_PAGE

Character code page used to translate text data.

CODEPAGE_TO_CCSID_MAP

Specification to use the internal or external table for code page to CCSID mapping.

COMMENT

User-defined string.

CTL_SSL_CIPHER_LIST

Acceptable and preferred SSL/TLS cipher suites to use for the control session between UDM components.

CTL_SSL_CIPHER_SUITES SSL/TLS 1.3 specific cipher suites to use for the control session between UDM components, or it can be used to disable the SSL/TLS protocol.

DATA_COMPRESSION

Specification for whether or not data is compressed on all standard I/O files.

DATA_SSL_CIPHER_LIST

SSL/TLS cipher suites to use for data session between UDM primary and secondary servers.

DATA_SSL_CIPHER_SUITES SSL/TLS 1.3 specific cipher suites to use for the data session on which file data is transferred between UDM primary and secondary servers.

ENCRYPT

Encryption method to be used in a UDM transfer session if one is not specified by an encrypt parameter in the UDM open command.

EVENT_GENERATION

Events to be generated as persistent events.

FRAME_INTERVAL

Number of UDM transfer blocks transferred before a frame-sync message is sent with network fault tolerance turned on.

HELP

Displays a description of the command line options and their format.

IDLE_TIMEOUT

Number of seconds of inactivity in an interactive UDM session after which the UDM Manager will close the session.

INSTALLATION_DIRECTORY

Directory in which UDM Manager is installed.

KEEP_ALIVE_INTERVAL

Default interval at which a keep alive message is sent from the UDM Manager to the transfer server(s).

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

MERGE_LOG

Specification for merging standard out and standard error output streams from a remote command to the UDM transaction log.

MESSAGE_LANGUAGE

Universal Message Catalog (UMC) file used to format messages.

MESSAGE_LEVEL

Level of messages that UDM will write.

MIN_SSL_PROTOCOL

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

Note

This option was introduced to IBM i in version 5.1.1.0.

MODE_TYPE

Default transfer mode type for UDM sessions.

MSG_SUPPRESSION_LIST

List of message IDs representing Universal messages to be suppressed.

NETWORK_DELAY

Expected network latency (in seconds).

NETWORK_FAULT_TOLERANT

Setting for whether or not UDM transfer sessions are network fault tolerant by default.

NLS_DIRECTORY

Directory name where the UDM Manager can find its message catalog and code page tables.

OPEN_RETRY

Level of fault tolerance for the open command.

OPEN_RETRY_COUNT

Maximum number of attempts that will be made to establish a session by the open command.

OPEN_RETRY_INTERVAL

Number of seconds that UDM will wait between each open retry attempt.

OUTBOUND_IP

Host or IP address that UDM binds to when initiating outgoing connections to another UDM server.

PLF_DIRECTORY

Program Lock File directory that specifies the location of the UDM Manager program lock file.

PRIVATE_KEY

ddname of Manager's PEM formatted RSA private key.

PRIVATE_KEY_PWD

Password for the Manager's PRIVATE_KEY.

PROXY_CERTIFICATES

Specification for whether or not UDM will use proxy certificates in three-party transfer sessions if a certificate is supplied to the UDM Manager.

RECONNECT_RETRY_COUNT

Number of attempts that the UDM Manager will make to re-establish a transfer session when a network fault occurs.

RECONNECT_RETRY_INTERVAL

Number of seconds that UDM will wait between each successive attempt to re-establish a transfer session when a network fault occurs.

RECV_BUFFER_SIZE

Size (in bytes) of the application's incoming buffer for UDM.

REMOTE_PORT

TCP port number on the remote computer used for invoking UDM Server instances.

SAF_KEY_RING

SAF certificate key ring name.

SAF_KEY_RING_LABEL

SAF key ring certificate label.

SCRIPT

ddname from which to read a UDM script command file.

SCRIPT_FILE

Script file containing UDM commands to execute.

SCRIPT_OPTIONS

Script options to pass into the script command file.

SEND_BUFFER_SIZE

Size (in bytes) of the application's outgoing buffer for UDM.

SERVER_STOP_CONDITIONS

Exit codes that cause Universal Broker to cancel the corresponding UDM Server of the exited UDM Manager.

SIZE_ATTRIB

Default size for file creation of physical files for both data and source file types.

SSL_IMPLEMENTATION

SSL/TLS implementation.

SYSTEM_ID

Local Universal Broker with which the UDM Manager must register.

TCP_NO_DELAY

Specification for whether or not to use TCP packet coalescing.

TCP_RECV_BUFFER

Size of the TCP receive buffer used for socket connections.

TCP_SEND_BUFFER

Size of the TCP send buffer used for socket connections.

TCP_WINDOW_SIZE

(Renamed TCP_RECV_BUFFER.)

TRACE_FILE_LINES

Maximum number of lines to write to the trace file.

TRACE_TABLE

Size of a wrap-around trace table maintained in memory.

UCMD_PATH

Complete path to Universal Command for calls by the exec command.

UMASK

File mode creation mask.

USAP_PATH

Complete path to USAP for calls by the execsap command.

VERIFY_HOST_NAME

Specification for whether or not the Universal Broker's X.509 certificate identity is verified.

VERSION

Specification for writing of program version information and copyright.