Command Format

command [parameter[=value] ]...

appenddata _data_element_name_ [_value_1_]... [_value_n_]

Parameter	Description
data_element_name	Name of a data element.
value_1	First value in the line of text to be appended.
value_n	Last value in the line of text to be appended.

attrib _logical-name_=[ {dd | dsn | hfs | lib} ] [attribute-name=attribute-value]...

Parameter	Description
logical-name	Logical name of the transfer server to which the attribute(s) applies.
dd \| dsn \| hfs \| lib	File system for which the attribute(s) applies.
attribute-name	Name of an attribute.
attribute-value	Value to be set for the attribute.

break

(There are no parameters used with this command.)

call script-file [parameter-name=parameter-value]...

Parameter	Description
script-file	Name of the script file to execute.
parameter-name	Name of a parameter to pass to the script.
parameter-value	Value to be set for the parameter.

cd _logical-name_[=_directory_]

Parameter	Description
logical-name	Logical name of the transfer server to execute the cd command.
directory	Working directory to change to on the server.

close

(There are no parameters used with this command.)

closelog

(There are no parameters used with this command.)

compare STRING_1 STRING_2 [case=yes | no] [length=_length_]

Parameter	Description
STRING_1	String to be compared to STRING_1.
STRING_2	String to be compared to STRING_2.
case = yes \| no	Specification for whether or not the comparison is case-sensitive If set to yes, comparison is case-sensitive. If set to no, comparison is not case-sensitive. (If the case parameter is not used, the comparison is case insensitive.)
length=length	First n characters to be compared.

copy source-logical-name=file-specification [destination-logical-name=file specification]

Parameter	Description
source-logical-name	Logical name of the source transfer server in the copy operation.
file-specification	File specification for the source file.
destination-logical-name	Logical name of the destination transfer server in the copy operation.
file-specification	File specification for the destination file.

copydir source-logical-name=file-specification [destination-logical-name=file-specification]

Parameter	Description
source-logical-name	Logical name of the source transfer server in the copy operation.
file-specification	File specification for the source file directory.
destination-logical-name	Logical name of the destination transfer server in the copy operation.
file-specification	File specification for the destination file or directory.

data [name | print=name] [resolve={all | defined | no} ] [data-element] [end=end-sequence]

Parameter	Description
name \| print=name	Specifies either the name of the in-stream data element being defined (name) or a request to print the lines of that data element.
resolve={all \| defined \| no}	Variable resolution method: all: Resolve all variable references in the data. defined: Resolve only defined variable references in the data. no: Do not resolve any variable references in the data.
data-element	Contents of the in-stream data element being defined.
end=end-sequence	Sequence indicating the end of the data.

debug [EXPRESSION_SHOW_POSTFIX=yes | no] [EXPRESSION_SHOW_EVALUATION=yes | no] [COMMAND_SHOW_STRUCTURE=yes | no]

Parameter	Description
EXPRESSION_SHOW_POSTFIX=yes \| no	Postfix version of an expression after it has been converted from infix notation.
EXPRESSION_SHOW_EVALUATION=yes \| no	Evaluation of an expression.
COMMAND_SHOW_STRUCTURE=yes \| no	Different elements of a command after it has been parsed.

delete logical-name=file-specification

Parameter

Description

logical-name

Logical name of the server on which to delete the file(s).

file-specification

File(s) to be deleted; single filename or a complete path to a file or directory.

The filename (or filename portion of the path) can contain wildcard characters:

Wildcard * represents zero or more characters.
Wildcard ? indicates a single character.

deletestring variable_name {pos=position} | {startseq=sequence [startseqnum=number] } {length=length} | {endseq=sequence [endseqnum=number] } [case=yes | no]

Parameter	Description
variable-name	Name of an existing variable.
pos=position	Starting position of sequence to be deleted (one-based index).
startseq=sequence	Starting position of sequence to be deleted (following a specific character sequence).
startseqnum=number	Occurrence number of starting position of sequence to be deleted (following a specific character sequence).
length=length	Length of the substring to be deleted.
endseq=sequence	Ending position of sequence to be deleted (preceding a specific character sequence).
endseqnum=number	Occurrence number of ending position of sequence to be deleted (preceding a specific character sequence).
case=yes \| no	Indicates whether or not the comparisons of the sequence are case-insensitive.

diskspace logical_name [=path] | [qty=nnn{b|k|m|g}] [cond=GT | LT]

Parameter	Description
logical-name	Name of the system where UDM checks available space. If path is specified, diskspace checks the volume or file system where that directory resides. Otherwise, the current working directory is used..
qty=nnn{b\|k\|m\|g}	Amount of space that diskspace should look for. To specify a unit for the quantity, add one of the following letters to the quantity amount: b - bytes k - kilobytes (1,024 bytes) m - megabytes (1,048,576 bytes) g - gigabytes (1,073,741,824 bytes) If no unit is specified, the default (b - bytes) is used. If no quantity is specified, diskspace displays the amount of available space.
cond=GT \| LT	Instructs diskspace to check for an amount that is greater than (GT) or less than (LT) the specified quantity. This parameter is optional. If no condition is specified, GT is used.

echo [parm_1]... [parm_n]

Parameter	Description
parm_1	First parameter to echo.
parm_n	Other parameter(s) to echo.

echolog [value_1]... [value_n]

Parameter	Description
value_1	First parameter to echo.
value_n	Other parameter(s) to echo.

exec logical-name | host-name {cmd=command | cmdref=command-ref | stc=started-task} [user=user-id] [pwd=password] [port=port] [codepage=codepage] [file=filename | xfile=filename [key=key] ] [option=option] [mergelog=yes | no] [trace=yes | no] [input=data-element] [svropt=server-options] [stdout=data-element] [stderr=data-element]

Parameter	Description
logical-name	Logical name of the server on which to execute the command.
host-name	Host name of the server on which to execute the command.
cmd=command	Name of command to execute of command type cmd.
cmdref=command-ref	Name of command reference to execute of command type cmdref.
stc=started-task	Name of started task to execute of command type stc.
user=user-id	User ID with which the command is to be executed.
pwd=password	Password for the specified user ID.
port=port	Port that the broker is listening on for the machine the command is to be executed on.
codepage=codepage	Codepage used for executing the command.
file=filename	Plain text file containing the options for the remote execution server. These options include: port, user, pwd, and codepage. Note The options in this file override any corresponding options specified for the transfer server in the open command.
xfile=filename	Universal Encrypted text file containing the options for the remote execution server. These options include: port, user, pwd, and codepage. Note The options in this file override any corresponding options specified for the transfer server in the open command.
key=key	Key used to decrypt an encrypted option file.
option=option	Options to be passed to the UCMD Server.
mergelog=yes \| no	Specification for whether or not to merge standard out and standard error output streams from a remote command to the UDM transaction log: yes: Merge data streams in UDM transaction log. no: Do not merge data; keep as separate data streams.
trace=yes \| no	Specification for whether or not trace functionality is used: yes: Tracing turned on in the call to UCMD. no: Tracing turned off in the call to UCMD.
input=data-element	Name of the data element that is used as input to the command being executed.
svropt=server-options	Options used to override Universal Command Server options.
stdout=data-element	Data element to be used as standard out from the remote command.
stderr=data-element	Data element to be used as standard error from the remote command.

execsap [host=host-name | destination type=event | generic [eventid=event-id] [parm=event-parm] [client=client] [user=user-id] [pwd=password] [codepage=codepage] [file=filename | xfile=filename [key=key] ] [mergelog=yes | no] [trace=yes | no]

Parameter	Description
host	SAP destination entry.
destination	Destination in the SAP RFC file.
type=event	Type of SAP operation to perform (event is the only valid type).
eventid	ID of the SAP event to trigger.
parm	Parameter to the SAP operation.
client	Name of the SAP client.
user=user-id	User ID with which the command is to be executed.
pwd=password	Password for the specified user ID.
codepage=codepage	Codepage used for executing the command.
file=filename	Plain text file containing the options for the remote execution server. These options include: port, user, pwd, and codepage. Note The options in this file override any corresponding options specified for the transfer server in the open command.
xfile=filename	Universal Encrypted text file containing the options for the remote execution server. These options include: port, user, pwd, and codepage. Note The options in this file override any corresponding options specified for the transfer server in the open command.
key=key	Key used to decrypt an encrypted option file.
mergelog=yes \| no	Specification for whether or not to merge standard out and standard error output streams from a remote command to the UDM transaction log: yes: Merge data streams in UDM transaction log. no: Do not merge data; keep as separate data streams.
trace=yes \| no	Specification for whether or not trace functionality is used: yes: Tracing turned on in the call to UCMD. no: Tracing turned off in the call to UCMD.

exit

(There are no parameters used with this command.)

filesys logical-name=[ {dd | dsn | hfs | lib} ]

Parameter

Description

logical-name

Logical name of the transfer server on which to change the file system.

dd | dsn | hfs | lib

File system to set for the specified server:

dd: ddnames defined with JCL DD statements (z/OS only)
dsn: data set name (z/OS only)
hfs: UNIX System Services file system (z/OS and IBM i only)
lib: LIB file system (IBM i only)

filetype [binary | text=filemask_1]...[binary | text=filemask_n] [remove=filemask_1]...[remove=filemask_n] [resetall]

Parameter	Description
binary \| text = filemask_1	Sets the specified file mask (filemask_1) so that source file names matching this mask will be transferred as binary files.
binary \| text = filemask_n	Sets the specified file mask (filemask_n) so that source file names matching this mask will be transferred as text files.
remove=filemask_1	Removes an entry that matches the specified file mask (filemask_1).
remove=filemask_n	Removes an entry that matches the specified file mask (filemask_n).
resetall	Removes all file mask entries.

find string seq=sequence [pos=index] [case=yes | no] [num=number | last]

Parameter	Description
string	String in which to search for the sequence.
seq=sequence	Sequence for which the search is being made.
pos=index	One-based index of the string where the find operation begins.
case=yes \| no	Specification of whether the search is case-sensitive (yes) or case-insensitive (no). [Default is no.]
num=number \| last	Instance of the sequence for which the search is being made.

format variable_name [ {string_1 | expression_1} [align={center | left | right | justify} ] [pad=sequence] [trunc=yes | no] [length=length] ]...[ {string_n | expression_n} [align=center | left | right | justify] [pad=sequence] [trunc=yes | no] [length=length] ]

Parameter	Description
variable_name	Variable or list element in which the newly formatted string is stored
string_1 \| expression_1	First section of the string
align=center \| left \| right \| justify	Method of how the value is aligned within the given space. [Default alignment is left.]
pad=sequence	Character(s) used to pad out the formatted value. [Default is space character.]
trunc=yes \| no	Truncates the value to the length given by length if it is longer than that value. [Default is to not truncate.]
length=length	Length of the formatted field. [Default is length of the value specified.]

insertstring variable_name sequence {pos=position | startseq=sequence startseqnum=number} [case=yes | no]

Parameter	Description
variable_name	Name of the existing variable or list element into which to insert the sequence.
sequence	Sequence to be inserted.
pos=position	Position at which sequence is inserted.
startseq=sequence	Sequence after which specified sequence is inserted.
startseqnum=number	Instance of sequence after which specified sequence is inserted.
case=yes \| no	Specification of whether or not the comparison used to find the start sequence is case\-insensitive. [Default is no.]

loaddata data-element-name=file-path

Parameter	Description
data-element_name	Data element into which the file contents is loaded.
file_path	File from which contents is loaded into the data element.

logdata data_element_name

Parameter	Description
data_element_name	Name of the data element to write to the open log.

lower variable_name

Parameter	Description
variable_name	Variable or list element in which to force alphabetic characters to lower case.

mode [type={text | binary} ] [trim={ yes | no} ]

Parameter

Description

type=text | binary

Type of transfer mode to be used:

text: UDM sends source data as is.
binary: UDM performs text translation on data.

[Default is binary when a new session is opened.]

trim=yes | no

Trim trailing spaces during a text transfer:

yes: Spaces at the end of each line (record) are removed from the data when it is written.
no: Spaces at the end of each line (record) are not removed.

[Default is no when a transfer session is initiated.]

move source-logical-name=source-file-specification [destination-logical-name=destination-file-specification]

Parameter	Description
source-logical-name	Logical name of the server acting as the source of the move operation.
file-specification	File(s) to be copied. It can be a single file name or a complete path. The file name (or file name portion of the path) can contain wildcard characters: Wildcard * represents for zero or more characters. Wildcard ? indicates a single character.
destination-logical-name	Logical name of the destination server in the move operation.
file-specification	Complete path or file name for the destination file.

open [ [primary ={* | local | hostname} [port=port] [user=username [pwd=password] ] [codepage=codepage] [ {file=filename | xfile=filename [key=key] } ] secondary =hostname [port=port] [user=username [pwd=password] ] [codepage=codepage] [file=filename] [xfile=filename [key=key] ] [encrypt={yes | no | cipher} ] [compress={yes | no | hasp | zlib} ] [nft=yes | no] [comment=text] [tt=direct | deferred]

Parameter	Description
primary=* \| local \| hostname	Logical name of the primary transfer server: * or local: Manager is the primary server in a two-party transfer hostname: Host name or IP address of a transfer server
port=port	Port that the Universal Broker is listening on that will initiate the primary transfer server.
user=username	Name of the user to authenticate on the primary transfer server.
pwd=password	Password used to authenticate the specified user.
codepage=codepage	Codepage to use for text translation by the primary transfer server.
file=filename	Plain text file that can contain open options for the primary transfer server.
xfile=filename	Universal Encrypted file that can contain open options for the primary transfer server.
key=key	Encryption key used to decrypt the specified encrypted open options file.
secondary=hostname	Logical name of the secondary transfer server. hostname is the Host name or IP address of the machine on which the server will be running. Note Host name must be given from the perspective of the primary transfer server, not the UDM Manager.
port=port	Port that the Universal Broker is listening on that will initiate the secondary transfer server.
user=username	Name of the user to authenticate on the secondary transfer server.
pwd=password	Password used to authenticate the specified user.
codepage=codepage	Codepage to use for text translation by the secondary transfer server.
file=filename	Plain text file that can contain open options for the secondary transfer server.
xfile=filename	Universal Encrypted file that can contain open options for the secondary transfer server.
key=key	Encryption key used to decrypt the specified encrypted open options file.
encrypt=yes \| no \| cipher	Encryption method for the transfer session: yes: Use cipher based on list in the -data_ssl_cipher_list option. no: Use NULL-MD5 cipher. cipher: Specific cipher to use.
compress= yes \| no \| hasp \| zlib	Data compression method for the transfer session: yes: Use method as specified in the -compress option. no: Do not use data compression. hasp: Use HASP compression. zlib: Use ZLIB compression.
nft= yes \| no	Specification for network fault tolerance: yes: Session is network fault tolerant. no: Session is not network fault tolerant.
commeent=text	Comment for a single session (or overrides a comment specified by the COMMENT option).
tt= direct \| deferred	Specification for where codepage translation is performed for files transferred in text mode: direct: codepage translation will be performed in the component sending the file - prior to transmission. deferred: codepage translation will be performed in the component receiving the file - after transmission.

openlog log_file_path [append=yes|no]

Parameter	Description
log_file_path	Path name of the log file to open.
append=yes\|no	Specification for whether or not to append log statements to an existing log file.

pad variable_name length=length [seq=sequence]

Parameter	Description
variable_name	Name of an existing variable or list element to pad.
length=length	Desired length of the padded string.
seq=sequence	Sequence used for padding the string.

parse variable_name length=length [seq=sequence]

Parameter	Description
string_name	String to parse.
var_1	First component of the parsed string placed into a variable.
seq_1	Sequence of the string serving as a delimiter between var_1 and var_2.
var_2	Second component of the parsed string placed into a variable.
seq_n	Sequence of the string serving as a delimiter between the preceding var_n and the following var_n.
var_n	Next component of the string after the preceding seq_n.

print msg=message

Parameter	Description
msg=message	Message that should be printed by the UDM Manager in its transaction output.

query

(There are no parameters used with this command.)

quit

(There are no parameters used with this command.)

rename logical-name old-filename new-filename

Parameter	Description
logical-name	Logical name of the transfer server on which you want to rename a file.
old-filename	Current name (filename, path, or absolute path) for the file that you want to rename.
new-filename	New name (filename, path, or absolute path) to which the file is to be renamed.

replace variable_name oldsequence newsequence [num=index] [all=yes | no] [case=yes | no]

Parameter	Description
variable_name	Name of the existing variable or list element on which to perform the replace.
oldsequence	Sequence to be replaced.
newsequence	Sequence replacing oldsequence.
num=index	One-based sequence number that identifies the occurrence of oldsequence.
all=yes \| no	Specification for whether all instances (yes) of the sequence are replaced or only the first instance (no) of the sequence.
case=yes \| no	Specification for whether the comparison to match the old sequence is case sensitive (yes) or case insensitive (no). [Default is no.]

report progress=yes | no

Parameter	Description
progress=yes \| no	Turns on or off the reporting of periodic transfer progress messages by UDM Manager during a file transfer operation.

resetattribs logical-name

Parameter	Description
logical-name	Logical name of the transfer server whose attributes are to be reset to their default values.

return [return-value]

Parameter	Description
return-value	Sets _rc variable with a return value to specify when to return.

reverse [variable_name]

Parameter	Description
variable_name	String in which all characters will be reversed.

savedata [data_element_name=file_spec]

Parameter	Description
data_element_name	Name of the data element.
file_spec	Name of the file on which to write each line of the data element.

set [ _echo={yes | no} ] [ _lines={yes | no} ] [ _halton={none | warn | error | fatal | integer-value} ] [ _rc={none | warn | error | fatal | integer-value} ] [ _keepalive=integer-value] [global_name=global_value_1]...[global_name_n=global_value_n]

Parameter	Description
_echo	Each command is echoed back after it is read for processing: yes or no (default).
_lines	Line number of each command is reported if an invalid command is received or fails to be parsed or processed by the UDM Manager: yes or no (default).
_halton	Halt condition setting: if the return code of any command is greater than the value of halton, and halton is not zero, UDM issues a quit command and exits. Values are a simple integer value or one of the following predefined values: none: equivalent to a value of 0; UDM does not automatically quit, regardless of a command's return value. warn: equivalent to a value of 4; usually returned for invalid commands and command parse errors. error: equivalent to a value of 8; command fails to execute successfully. fatal: equivalent to a value of 16; unrecoverable error occurs and the UDM Manager or one of the transfer servers must exit. [Default is 0.]
_rc	Internal UDM value, returned to UDM when the UDM Manager exits, that indicates the success or failure of each command executed by UDM. If the returned value is greater than the current value of rc, rc is set to that return value. Values are a simple integer value or one of the following predefined values: none: equivalent to an integer value of 0; command completed successfully. warn: equivalent to a value of 4; usually returned for invalid commands and command parse errors. error: equivalent to a value of 8; command fails to execute successfully. fatal: equivalent to a value of 16; unrecoverable error occurs and the UDM Manager or one of the transfer servers must exit. [Default is 0.]
_keepalive	Interval (in seconds) at which the UDM Manager sends a keep alive message. Value is a simple integer value; 0 = no keep alive message is to be sent. Note This value must be set BEFORE a session is established.
_global_name	User-defined global variable.

status

(There are no parameters used with this command.)

strip variable_name sequence [num=index] [all=yes | no] [case=yes | no]

Parameter	Description
variable_name	Name of the existing variable or list element on which to perform the strip.
sequence	Sequence to be stripped
num=index	One-based sequence number that identifies the occurrence of the sequence to be stripped.
all=yes \| no	Specification for whether all instances (yes) of the sequence are replaced or only the first instance (no) of the sequence.
case= yes \| no	Specification for whether the comparison to match the old sequence is case sensitive (yes) or case insensitive (no). [Default is no.]

substring variable_name sequence [num=index] [all=yes | no] [case=yes | no]

Parameter	Description
variable_name	Name of the existing variable into which the substring is placed.
string	String from which the substring is taken.
pos=position	Starting position of string to be taken (one based index).
startseq=sequence	Starting position of string to be taken (following a specific character sequence).
startseqnum=number	Occurrence number of starting position of string to be taken (following a specific character sequence).
length=length	Length of the string to be taken.
endseq=sequence	Ending position of string to be taken (following a specific character sequence).
endseqnum=number	Occurrence number of ending position of string to be taken (following a specific character sequence.
case=yes \| no	Specification for whether or not the comparisons of the start and end sequences are case sensitive (yes) or case insensitive (no). [Default is no.]

truncate variable_name length=length

Parameter	Description
variable_name	Name of the existing variable or list element to truncate.
length=length	Length to which the string truncates.

upper variable_name

Parameter	Description
variable_name	Variable or list element in which to force alphabetic characters to upper case.

Browser not supported