Overview

This page provides information on the Universal Data Mover (UDM) Manager, specific to the z/OS operating system.

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.

The z/OS Batch Manager provides a batch job interface to remote computers running the UDM Server component.

Usage

UDM Manager for z/OS executes as a batch job.

JCL Procedure

The following figure illustrates the UDM for z/OS JCL procedure (UDMPRC, located in the SUNVSAMP library) that is provided to simplify the execution JCL and future maintenance.

//UDMPRC   PROC UPARM=,               -- UDM options
//             USPRFC=USPRFC00,       -- USAP SAP RFC member
//             UNVPRE=#SHLQ.UNV,
//             UNVPRD=#PHLQ.UNV
//\*
//PS1      EXEC PGM=UDM,REGION=256M,PARM='ENVAR(TZ=EST5EDT)/&UPARM'
//STEPLIB  DD  DISP=SHR,DSN=&UNVPRE..SUNVLOAD
//*
//UNVNLS   DD  DISP=SHR,DSN=&UNVPRE..SUNVNLS
//UNVUSRC  DD  DISP=SHR,DSN=&UNVPRD..UNVCONF(&USPRFC)
//UNVCLIB  DD  DISP=SHR,DSN=&UNVPRE..SUNVSAMP
//*
//UNVTRACE DD  SYSOUT=*
//UNVTRMDL DD  DISP=SHR,DSN=&UNVPRD..MDL
//*
//SYSPRINT DD  SYSOUT=*
//SYSOUT   DD  SYSOUT=*
//CEEDUMP  DD  SYSOUT=*
//SYSUDUMP DD  SYSOUT=*
//*
//SYSIN    DD  DUMMY                  -- UDM command options
//UNVSCR   DD  DUMMY                  -- UDM script

For this JCL procedure:

UPARM parameter is used to specify EXEC PARM keyword values.
UNVPRE parameter specifies the data set name prefix of Universal Agent installation data sets.
UNVPRD parameter specifies the data set name prefix of Universal Agent production data sets.

DD Statements in JCL

The following table describes the DD statements used in the UDM for z/OS JCL procedure, above.

ddname	DCB Attributes	Mode	Description
STEPLIB	DSORG=PO, RECFM=U	input	Universal Agent load library containing the program being executed.
UNVNLS	DSORG=PO, RECFM=(F, FB, V, VB)	input	Universal Agent national language support library. Contains message catalogs and code page translation tables.
UNVUSRC	DSORG=PS, RECFM=(F, FB, V, VB)	input	Universal SAP connector RFC member.
UNVCLIB	DSORG=PO, RECFM=(F, FB, V, VB)	input	UDM call library: UDM searches for script files specified on the call command in this library.
UNVTRACE	DSORG=PS, RECFM=(F, FB, V, VB)	Output	UDM trace output.
UNVTRMDL	DSORG=PS, RECFM=(F, FB, V, FB)	input	Data set used as a model for creating UCMD and USAP trace files when they are called by UDM using the exec and execsap commands.
SYSPRINT	DSORG=PS, RECFM=(F, FB, V, VB)	output	Standard output file for the UDM program.
SYSOUT	DSORG=PS, RECFM=(F, FB, V, VB)	output	Standard error file for the UDM program.
SYSIN	DSORG=PS, RECFM=(F, FB, V, VB)	input	Standard input file for the UDM program. UDM reads its command options from SYSIN.
UNVSCR	DSORG=PS, RECFM=(F, FB, V, VB)	input	UDM command script: UDM executes the script allocated to this ddname.

The C runtime library determines the default DCB attributes. Refer to the IBM manual OS/390 C/C++ Programming Guide for details on default DCB attributes for stream I/O.

JCL

The following figure illustrates the UDM for z/OS JCL using the UDMPRC JCL procedure, above.

//jobname  JOB CLASS=A,MSGCLASS=X
//STEP1    EXEC UDMPRC
//UNVSCR   DD  *
 open srv=sol7 user=id001 pwd=pwd001
 copy local='uid.data' srv=data
 quit
/*

Job step STEP1 executes the procedure UDMPRC.

The UDM script commands are specified on the UNVSCR DD.

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:

PARM keyword
SYSIN ddname
Configuration file

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

See Configuration Management for detailed information on these methods of configuration.

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.

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 z/OS. 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.
ALLOC_ABNORMAL_DISP	Abnormal disposition of a data set being allocated.
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	Normal disposition of a data set being allocated.
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.
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 received and transmitted over the network.
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.
HELP	Writes a description of the command options and their format.
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.
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.
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.
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.
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_OPTIONS	Options to pass to 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.
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_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.
VERIFY_HOST_NAME	Specification for whether or not the Universal Broker's X.509 certificate identity is verified.
VERSION	Writes the program version information and copyright.

Command Line Syntax

The following figure illustrates the command line syntax of UDM Manager for z/OS.

udm
[-alloc_abnormal_disp {keep|delete|catlg|uncatlg}]
[-alloc_blksize size]
[-alloc_dataclas class]
[-alloc_dir_blocks number]
[-alloc_dsorg {po|ps}]
[-alloc_input_status {old|shr}]
[-alloc_lrecl length]
[-alloc_mgmtclas class]
[-alloc_normal_disp {keep|delete|catlg|uncatlg}]
[-alloc_output_status {old|shr}]
[-alloc_prim_space space]
[-alloc_recfm format]
[-alloc_sec_space space]
[-alloc_space_unit {cyl|trk|number}]
[-alloc_storclas class]
[-alloc_unit unit]
[-alloc_volser number]
[-allow_repl_on_rename {yes|no}]
[-system_id ID]
[-ssl_implementation {openssl|system}]
[-ca_certs ddname]
[-cert ddname]
[-private_key ddname [-private_key_pwd password] ]
[-proxy_certificates {yes|no}]
[-days number]
[-crl ddname]
[-script ddname]
[-options options]
[-codepage codepage]
[-ctl_ssl_cipher_list list]
[-data_ssl_cipher_list list]
[-encrypt {yes|no|cipher} ]
[-compress {yes|no}[,{zlib|hasp}] ]
[-delay seconds]
[-idle_timeout seconds]
[-keep_alive_interval seconds]
[-lang language]
[-level {trace|audit|info|warn|error}[,{time|notime}] ]
[-msg_suppression_list list ]
[-min_ssl_protocol option]
[-network_fault_tolerant {yes|no} [-frame_interval number] ]
[-mode_type {binary|text}]
[-umask number]
[-outboundip host]
[-port port]
[-recvbuffersize size]
[-open_retry {yes|no}]
[-open_retry_count number]
[-open_retry_interval number]
[-retry_count number]
[-retry_interval seconds]
[-sendbuffersize size]
[-saf_key_ring name]
[-saf_key_ring_label label]
[-server_stop_conditions codes]
[-tcp_no_delay option]
[-tcp_window_size size]
[-tracefilelines number]
[-trace_table size,{error|always|never}]
[-verify_host_name {yes|no}|host name]
[-comment text]

udm
{ -help | -version }

Universal Agent 7.4.x

Universal Data Mover Manager for z/OS