cleanup - Teradata Data Mover

Purpose

The cleanup command cleans up Teradata ARC, Teradata PT API, and Teradata JDBC tasks from a job that failed or was stopped before completing successfully. The command deletes staging, error, work, and log tables and releases HUT locks, depending on the underlying utility used for the job.

Syntax

See http://schemas.teradata.com/unity/DataMover.xsd.

Parameters

See Parameter Order.

broker.port

[Optional] You may enter a broker port to overwrite the default value specified in the commandline.properties file in order to connect to a different ActiveMQ server (and therefore a different daemon) at runtime.

61616

broker.url

[Optional] You may enter a broker URL to overwrite the default value specified in the commandline.properties file in order to connect to a different ActiveMQ server (and therefore a different daemon) at runtime.

dm-server1

job_name

Name of the job to be cleaned up.

12315DFHJKS

security_password

[Optional] Password for the super user or authorized Viewpoint user.

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.

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.

Usage Notes

The cleanup command only cleans up job instances that are not currently running. To clean up a currently running job, stop the job and then run cleanup.

XML File Example

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

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<dmCleanup
	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>
</dmCleanup>