list_job_definition | Commands | Teradata Data Mover - list_job_definition - Teradata Data Mover

Teradata® Data Mover User Guide - 20.01

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Mover
Release Number
20.01
Published
November 2023
Language
English (United States)
Last Update
2023-12-05
dita:mapPath
hlv1700545853003.ditamap
dita:ditavalPath
mpm1591127278842.ditaval
dita:id
don1467241476387
Product Category
Analytical Ecosystem

Purpose

The list_job_definition command lists the job definition for the job name you specify.

You can modify job behavior either of the following two methods:
  • Edit the object list and job parameters in the job definition. Then use the create command to save the job modifications to the daemon, using a new name to create a new job definition.
  • Supply new job values for job variables at runtime using the start command.

If you specify the original job name for the list_job_definition command, the original job definition is listed. If you specify the name of a job instance in which job variable values were modified at runtime, the modified job definition is listed.

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
dir
[Optional] Output directory for the job definition. A directory will be created if one does not exist.
Example: /home/datamover/jobdefs
The generated XML file is written by default to the current directory.
filename
[Optional] Output file name for the job definition. Existing file name will be overwritten.
Example: jobdefinition.xml
The generated XML file has by default the name <job_name>.xml.
job_name
Name of the job definition that will be output.
Example: 12315DFHJKS
security_password
[Optional] Password for the super user or authorized Viewpoint user.
Example: 53cUr17y
Required if security management is enabled on the Data Mover daemon. Not a valid parameter if -security_password_encrypted is also specified.
security_password_encrypted
[Optional] Encrypted password for the super user.
Example: 052c7aabd14c7770141ac3c0137ab98ae0d3f0f7cddf588981206b010c0c1b2f
Required if security management is enabled on the Data Mover daemon. Not a valid parameter if -security_password is also specified.
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.
Required if security management is enabled on the Data Mover daemon.

XML File Example

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

In the following example, the parameters file writes the definition for the 12315DFHJKS to /home/datamover/jobdefs/12315DFHJKS_jobdefinition1.xml.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<dmGetJobDefinition
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>
	<dir>/home/datamover/jobdefs</dir>
	<filename>12315DFHJKS_jobdefinition1.xml</filename>
</dmGetJobDefinition>
Here is an example of an output file produced when a user runs the list_job_definition command:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<dmCreate 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>jp_low_5</job_name>
 <job_priority>LOW</job_priority>
 dmdev
 <source_user></source_user>
 <source_password></source_password>
 dmsmp
 <target_user></target_user>
 <target_password></target_password>
 <use_userid_pool>false</use_userid_pool>
 <data_streams>1</data_streams>
 <source_sessions>1</source_sessions>
 <target_sessions>1</target_sessions>
 <max_agents_per_task>1</max_agents_per_task>
 <overwrite_existing_objects>TRUE</overwrite_existing_objects>
 <freeze_job_steps>TRUE</freeze_job_steps>
 <force_utility>JDBC</force_utility>
 <compare_ddl>UNSPECIFIED</compare_ddl>
 <log_level>1</log_level>
 <online_archive>UNSPECIFIED</online_archive>
 <database selection="unselected">
  <name>DB</name>
  <table selection="included">
   <name>TEST101</name>
   <compare_ddl>FALSE</compare_ddl>
  </table>
 </database>
<dmCreate>