Universal Data Mover Return Code Processing

UDM Return Codes

Universal Data Mover (UDM) return codes, particularly for batch operations, are used to gauge the degree of success of a job. Each job generates a return code that indicates the status of the job when it ended.

Types of Return Codes

The following table organizes UDM return codes into four categories.
 

Category

Value

Description

Success

0 / none

All commands completed successfully.

Warning

4 / warn

Non-critical error in operation.

Error

8 / error

UDM command failed to execute because it was:

  • Inappropriately issued (for example, a copy command was issued before a transfer session had been established).
  • Malformed; that is, grammatically correct but either:
    • Missing required parameters.
    • Containing invalid parameters.

Fatal

16 / fatal

Fatal error has occurred; UDM cannot continue and must exit.
 
A fatal error is one that prevents UDM from running:

  • Failure to allocate memory.
  • Failure to initialize portions of the UDM application.
  • Parser errors (grammatically incorrect scripting language).


Each return code category has an integer value and a convenient value.

Processed commands return only integers as return code values. The convenient values can be used when setting return codes in the _rc and/or _halton variables via the set command (see Return Codes in set (Set) Command).

Additional Information

The following pages provide additional detailed information for Universal Data Mover Return Code Processing: