Purpose
The status command displays the status of a specified job. To see the status of multiple jobs, issue a command for each job.
The frequency of status updates can also be specified. If the frequency parameter is not specified, the status is displayed only once and is not updated.
Parameters
See Parameter Order.
- dm.rest.endpoint
- [Optional] Enter a Data Mover REST server URL to overwrite the default value specified in the commandline.properties file in order to connect to a different REST server (and therefore a different daemon) at runtime.
- frequency
- [Optional] Frequency of status update in seconds.
- job_name
- Name of the job to be monitored.
- output_level
- [Optional] Output level of the job status. Specify one of the output levels in the following table:
Output Level Description 1 Displays the overall job status. This is the default. 2 Displays the status of each job step. 3 Displays the status of each job task. 4 Displays detailed log information. - security_password
- [Optional] Password for the super user or authorized Viewpoint user.
- security_password_encrypted
- [Optional] Encrypted password for the super user.
- security_username
- [Optional] User ID of the super user or authorized Viewpoint user. The user ID of the super user is dmcl_admin and cannot be changed.
Usage Notes
To stop the status updates, press the system INTR character (UNIX) or Ctrl+C (Windows).
The following example shows output for the status command.
Job Name: floyd_to_checks-Sun_May_24_13:42:13_PDT_2009 Job Execution Name: floyd_to_checks-Sun_May_24_13:42:13_PDT_2009_Execution_Sun_May_24_13:48:40_PDT_2009_1 TYPE ID STATUS CURRENT STEP START TIME DURATION TIME ------------------------------------------------------------ Job: 3 COMPLETED_SUCCESSFULLY - 5/24/09 1:49 PM 0:0:55 TYPE ID STATUS STEP TYPE START TIME DURATION TIME ------------------------------------------------------------ Step: 1 COMPLETED_SUCCESSFULLY MOVE_DEFINITION_BEFORE_LOAD 5/24/09 1:49 PM 0:0:7 Step: 2 COMPLETED_SUCCESSFULLY MOVE_TABLE_DATA 5/24/09 1:49 PM 0:0:28 Step: 3 COMPLETED_SUCCESSFULLY RESOLVE_TABLE_AFTER_LOAD 5/24/09 1:49 PM 0:0:6
XML File Example
For the status command, type datamove status -f parameters.xml.
In the following example, the parameters file returns the status of each job step for job 12315DFHJKS, and updates the status every five seconds.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <dmStatus xmlns="http://schemas.teradata.com/dataMover/v2009" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://schemas.teradata.com/unity/datamover.xsd"> <job_name>12315DFHJKS</job_name> <frequency>5</frequency> <output_level>2</output_level> </dmStatus>