Currently, IBM i runs Workload Automation 5.1.1. These pages provide information for that version.

Overview

This page provides information on the Universal Data Mover (UDM) Manager, specific to the IBM i operating system. It describes the commands, modes of operation, configuration and configuration options, and command line syntax of UDM Manager for IBM i.

UDM Manager transfers files between any computers running UDM Server. Using a UDM command script, you indicate to the UDM Manager the actions to take. The UDM Manager connects to the UDM Server (or Servers) and processes your request.

Usage

UDM Manager is executed from the command line (interactive mode), a script file, or in batch mode. In interactive mode, commands come from standard input; in batch mode, they come from a script file.

Workload Automation 5 for IBM i Commands

The names of the Workload Automation 5 for IBM i commands that are installed in the IBM i QSYS library are tagged with the Workload Automation 5 for IBM i version / release / modification number, 511.

The names of the commands installed in the Workload Automation 5 for IBM i product library, UNVPRD511, are untagged.

To maintain consistency across releases, you may prefer to use the untagged names in your production environment. The Change Release Tag program, UCHGRLS, lets you change the tagged command names in QSYS to the untagged command names in UNVPRD511.

These pages reference the IBM i commands by their untagged names. If you are using commands with tagged names to run UDM, substitute the tagged names for the untagged names in these references.

Modes of Operation

Under IBM i, UDM can be run either:

In interactive mode
From a script file
In batch mode

Additionally under IBM i, UDM can use either the LIB or HFS file system.

Running UDM in Interactive Mode

To run UDM in interactive mode, enter the following at the command prompt:

STRUDM

This starts the UDM Manager. You will be greeted with a start-up message and the UDM prompt:

UNV2800I Universal Data Mover 5.1.1 Level 0 started.

udm>

UDM now is ready to process commands. At the udm> prompt, you can enter any UDM command.

To exit UDM, enter the following command at the udm> prompt:

quit

Running UDM from a Script

To invoke a UDM script, enter the following on the command line:

STRUDM SCRFILE(library/file) SCRMBR(member)

This starts the UDM Manager using the script located by library, file, and member.

When the script file has finished executing, UDM exits automatically.

UDM requires the member name (there is no default). This makes script specification under IBM i behave as it does on other platforms. On other systems, there is no default search order as exists under IBM i. However, you can explicitly provide *FILE as a member name to use the IBM i default file search order.

Running UDM in Batch Mode

(When running in batch mode, use a script as shown in #Running UDM from a Script.)

To execute a batch file such as the one below, use SBMDBJOB FILE(LIBNAME/FILENAME) MBR(MBRNAME):

//BCHJOB JOB(MYUDMJOB) ENDSEV(10) 
STRUDM MYLIB/QSCRSRC UDM817
//ENDBCHJOB

Output is sent to the output queue associated with the batch job. Two spooled files will be sent to the output queue; one file associated with standard out and one file associated with standard error.

Configuration

Configuration consists of:

Setting default options and preferences for all executions of UDM Manager.
Setting options and preferences for a single execution of UDM Manager.

Configuration options are read from the following sources:

Command line
Command file
Environment variables
Configuration file

The order of precedence is the same as the list above; command line options being the highest and configuration file being the lowest. That is, options specified via the command line override options specified via a command file, and so on.

Detailed information on these methods of configuration can be found in Configuration Management.

Configuration File

The configuration file provides the simplest method of specifying configuration options whose values will not change with each command invocation. These default values are used if the options are not read from one or more other sources.

The installation default for the UDM configuration file is Workload Automation 5 installation library UNVPRD511, file UNVCONF, and member UDM. The configuration file name can be any valid file name. It can be edited manually using an IBM i editor such as SEU, EDTF, or any other installed source file editor, or via the IFS using a text editor. If a text editor is used to edit the file via the IFS, the padded spaced must be removed for lines that exceed the file maximum record length.

Some options only can be specified in the configuration file; they have no corresponding command line equivalent. Other options cannot be specified in the configuration file; they must be specified via one or more other sources for a single execution of UDM Manager.

Configuration Options

The following table describes the configuration options used to execute UDM Manager for IBM i. Each Option Name is a link to detailed information about that configuration option.

Option Name	Description
ACTIVITY_MONITORING	Specification for whether or not product activity monitoring events are generated.
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_REVOCATION_LIST	File name / ddname of the PEM-formatted CRL.
CODE_PAGE	Character code page used to translate text data received and transmitted over the network.
CODEPAGE_TO_CCSID_MAP	Specification to use either 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.
DATA_COMPRESSION	Specification for whether or not data is compressed on all standard I/O files.
DATA_SSL_CIPHER_LIST	Acceptable and preferred SSL/TLS 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 when UDM is operating with network fault tolerance turned on.
IDLE_TIMEOUT	Number of seconds of inactivity in an interactive UDM session after which the manager will close the session.
KEEP_ALIVE_INTERVAL	Default interval at which a keep alive message is sent from the manager to the transfer server(s).
MERGE_LOG	Specification for whether or not to merge 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 write messages.
MESSAGE_LEVEL	Level of messages to 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.
NETWORK_DELAY	Expected network latency.
NETWORK_FAULT_TOLERANT	Specification for whether or not UDM transfer sessions are network fault tolerant by default.
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 the 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.
SCRIPT_FILE	Script file containing UDM commands to execute.
SCRIPT_OPTIONS	Options to pass to the script command file.
SEND_BUFFER_SIZE	Size (in bytes) of the application's outgoing buffer for UDM.
SIZE_ATTRIB	Default file creation size for physical files of both data and source file types.
TCP_NO_DELAY	Specification for whether or not to use TCP packet coalescing.
TCP_WINDOW_SIZE	TCP/IP buffer size of a UDM Server on the receiving end of a two-party transfer.
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.
UMASK	File mode creation mask.
VERSION	Writes the program version information and copyright.

Command Line Syntax

The following figure illustrates the command line syntax of UDM Manager for IBM i.

STRUDM
[SCRFILE([library/]filename) [SCRMBR(member) ]
[PLFDIR (directory)]
[OPTIONS(options)]
[CODEPAGE(codepage)]
[CTLCPHRLST(cipherlist)]
[DTACPHRLST(cipherlist)]
[ENCRYPT {*yes|*no|cipher} ]
[COMPRESS(*{yes|no})]
[CMPRSMTH(*{zlib|hasp})]
[DELAY(seconds)]
[IDLTIMOUT(seconds)]
[KEEPALIVE(seconds)]
[MODETYPE (*{bin|binary|text}]
[MSGLANG(language)]
[[MSGLEVEL(*{trace|audit|info|warn|error}) [,*{yes|no}] ]
[MINSSLPROTOCOL(option)]
[NETWORKFT(*{yes|no}) [FRAMEINT(number)]]
[OPENRETRY(*{yes|no} count interval)]
[OUTBOUNDIP(host)]
[PORT(port)]
[PROXYCERT(option)]
[RCVBUFSIZE(size)]
[RETRYCNT(number)]
[RETRYINT(seconds)]
[SNDBUFSIZE(size)]
[TCPNODELAY(*{yes|no})]
[TCPWINSIZE(size)]
[TRCLINES(number)]
[TRCTBL(size,*{error|always|never})]
[CACERTS(file [lib] ) [CACERTSMBR(member)] ]
[CERT(file [lib] ) [CERTMBR(member)]
     [PVTKEYF|PRIVATE_KEY - UDM Manager configuration option](file [lib] ) [PVTKEYFMBR(member)] [PVTKEYPWD(password)] ]
[CRLFILE(file [lib]) [CRLMBR(member)] ]
[COMMENT(user-defined string)]


STRUDM
[VERSION(*{yes|no})]

Browser not supported