list_jobs | Commands | Teradata Data Mover - 17.11 - list_jobs - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.11
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-4101-091K
Language
English (United States)

Purpose

The list_jobs command displays a list of all jobs that have run on the Data Mover daemon with the specified status mode. Job definitions are not displayed.

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.
https://dm-server1:1443/datamover
end_time
[Optional] Lists all jobs that finished earlier than the specified time.
The format is: yyyy-MM-dd-HH in local time.
Example: 2019-02-20-16
end_time cannot be used with last_hour.
freeze_step_only
[Optional] Lists only jobs with freezeJobSteps=true.
last_hour
[Optional] Lists all jobs that finished in the last X hours, where X is the number of hours.
The value must be a positive integer.
Example: 6
last_hour cannot be used with start_time or end_time.
latest_job_only
[Optional] Returns the status of the most recent completed job, per job name, after meeting the conditions specified by other parameters.
For example, if used with the parameter status_mode set to failed (F), only the latest completed job instances with a failed status are returned.

If the end_time parameter is used, the latest job instances that completed before the specified end time are returned.

start_time
[Optional] Lists all jobs that started later than the specified time.
The format is: yyyy-MM-dd-HH in local time.
Example: 2019-02-20-16
start_time cannot be used with last_hour.
status_mode
[Optional] Lists all jobs with the status mode specified in the following table.
Example: R
job_name
[Optional] Name of the job to filter the results with.
Example: 12315DFHJKS
Status Mode Description
A All jobs (default).
N All new jobs.
I All initializing jobs.
R All running jobs.
C All successfully completed and completed with warnings jobs.
F All failed jobs.
RS All restarting jobs.
Q All queued jobs.
B All blocked jobs due to object locks.
UC All user-cancelled jobs.

XML File Example

For the list_jobs command, type datamove list_jobs -f parameters.xml.

The following example shows a parameters file, dmListJobs.xml, for the list_jobs command.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dmListJobs 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">
	<status_mode>C</status_mode> 
</dmListJobs>
Here is an example of the screen output of running the list_jobs command:
Data Mover Command Line 16.20.25.00
2019-05-13 18:56:22 - List Jobs mode
Command parameters:
About to connect to REST server at https://localhost:1443/datamover
Connected to Daemon version 16.20.25.00
List jobs...
Job Name                                                               Start                End                  Status                 Priority
------------------------------------------------------------------------------------------------
jp_high_1    5/13/19 6:50 PM      5/13/19 6:50 PM      COMPLETED_SUCCESSFULLY HIGH
jp_high_2    5/13/19 6:51 PM      5/13/19 6:51 PM      COMPLETED_SUCCESSFULLY HIGH
jp_high_3    5/13/19 6:51 PM      5/13/19 6:52 PM      COMPLETED_SUCCESSFULLY HIGH
jp_high_4    5/13/19 6:52 PM      5/13/19 6:52 PM      COMPLETED_SUCCESSFULLY HIGH
jp_low_1     5/13/19 6:53 PM      5/13/19 6:53 PM      COMPLETED_SUCCESSFULLY LOW
jp_low_2     5/13/19 6:54 PM      5/13/19 6:54 PM      COMPLETED_SUCCESSFULLY LOW
jp_low_3     5/13/19 6:54 PM      5/13/19 6:55 PM      COMPLETED_SUCCESSFULLY LOW
jp_low_4     5/13/19 6:55 PM      5/13/19 6:55 PM      COMPLETED_SUCCESSFULLY LOW