Overview

This page provides information on the Universal Data Mover (UDM) Manager, specific to the Windows 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.

Usage

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

This section describes the modes of operation, configuration and configuration options, and command line syntax of UDM Manager for Windows.

Modes of Operation

Under Windows, UDM can be run either in:

Interactive mode
Batch mode

Running UDM in Interactive Mode

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

udm

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

UNV2800I Universal Data Mover 6.3.0 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 in Batch Mode

To run UDM in batch mode, enter udm on the command line and specify a script file via the SCRIPT_FILE option.

For example:

udm -script script_filename

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

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.

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.

Although configuration files can be edited with any text editor (for example, Notepad), the Universal Configuration Manager application, accessible via the Control Panel, is the recommended way to set configuration options. The Universal Configuration Manager provides a graphical interface and context-sensitive help, and helps protect the integrity of the configuration file by validating all changes to configuration option values.

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 Windows. 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_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.
INSTALLATION_DIRECTORY	Directory on which UDM Manager is installed.
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.
NLS_DIRECTORY	Directory where the UDM Manager message catalog and code page tables are located.
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.
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.
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.
UCMD_PATH	Sets the complete path to UCMD for calls by the exec command.
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 Windows.

udm
[-ca_certs ddname]
[-cert ddname]
[-private_key ddname [-private_key_pwd password] ]
[-proxy_certificates {yes|no}]
[-days number]
[-crl file]
[-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]
[-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.7.x

Universal Data Mover Manager for Windows