save_configuration | Commands | Teradata Data Mover - 17.10 - save_configuration - Teradata Data Mover

Teradata® Data Mover User Guide

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

Purpose

The save_configuration command saves information in the configuration file (that was created by the list_configuration command) to the Data Mover daemon using the -f parameter.

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
filename.xml
Name of the configuration XML file.
Example: configuration.xml
The name of the configuration file by default is configuration.xml.
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 save_configuration command, type datamove save_configuration -f configuration.xml.

The following is a sample configuration.xml file for use with the save_configuration command. When updating the configuration settings in the configuration.xml file, the number or text enclosed in the <value> element is the only area eligible for editing. The text in the <description> element provides additional informational only. Do not change the text enclosed in the key element.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dmSaveConfiguration 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">
    <property>
        <key>agentCollector.agentHeartbeatWaitMillis</key>
        <value>600000</value>
        <description>Purpose: To set the amount of time to wait for an Agent heartbeat before assuming it has gone out of service in milliseconds. Default: 600000.</description>
    </property>
    <property>
        <key>databaseQueryService.useBaseViewsOnly</key>
        <value>true</value>
        <description>Purpose: Set all data dictionary queries on Teradata source and target systems to use the base views instead of X or VX views. Default: true.</description>
    </property>
    <property>
        <key>different.session.charsets.enabled</key>
        <value>false</value>
        <description>Purpose: Whether or not the different session charsets feature is supported. Default value false means not allowed.</description>
    </property>
    <property>
        <key>event.table.default</key>
        <value>NULL</value>
        <description>Purpose: Messages will be saved to this event table, unless the messages come from a different event table or the Job Definition explicitly overrides this parameter. Default: NULL.</description>
    </property>
    <property>
        <key>job.default.queryband</key>
        <value>ApplicationName=DM;Version=15.10;</value>
        <description>Purpose: Provide a set of name/value pairs for the default query_band feature.</description>
    </property>
    <property>
        <key>job.default.queryband.enabled</key>
        <value>false</value>
        <description>Purpose: Enable/Disable the default queryband feature. Default value: false</description>
    </property>
			<property>
        <key>job.databaseClientEncryption</key>
        <value>false</value>
        <description>Purpose: When set to true, utilities such as JDBC and TPTAPI will initiate encrypted sessions to both the source and target database systems. Default: false. Note: There is a performance hit trade-off for the gain of encryption.</description>
    </property>
			<property>
        <key>job.force.direction</key>
        <value>false</value>
        <description>Purpose: To force direction of data movement from source to target system.</description>
    </property>
    <property>
        <key>job.never.target.system</key>
        <value>false</value>
        <description>Purpose: Prevent certain database systems from ever being a target system in a Data Mover job. Default: false.</description>
    </property>
    <property>
        <key>job.noFallback</key>
        <value>false</value>
        <description>Configures whether the fallback settings on tables created as part of movement jobs are disabled. While this is enabled, fallback settings on target tables are scrubbed and disabled. When this is disabled, fallback settings will be set based on the source table. Default is false.</description>
    </property>
    <property>
        <key>job.onlineArchive</key>
        <value>false</value>
        <description>Purpose: When set to true, online archiving is utilized for objects that merit the use of DSA. Default: false. Note: There a is a performance hit trade-off for the gain of object availability.</description>
    </property>
    <property>
        <key>job.overwriteExistingObjects</key>
        <value>false</value>
        <description>Purpose: When set to true, objects that already exist on the target database system are overwritten. Default: false.</description>
    </property>
    <property>
        <key>job.useSecurityMgmt</key>
        <value>false</value>
        <description>Purpose: When set to true, some Data Mover commands will require the admin username and password to be specified when executing the command.  Refer to the User Guide for a complete list of commands affected by this parameter. Default: false</description>
    </property>
    <property>
        <key>job.useSyncService</key>
        <value>false</value>
        <description>Purpose: To record any changes to the Data Mover repository tables (inserts/updates/deletes) in an audit log table. The value must be set to true in order to use the Sync service. Default: false.</description>
    </property>
    <property>
        <key>job.useUserIdPool</key>
        <value>false</value>
        <description>Purpose: Use a target user from the pool of users. This enables running multiple DSA tasks at the same time.</description>
    </property>
    <property>
        <key>repository.purge.definition.enabled/key>
        <value>false</value>
        <description>Purpose: Enable/Disable the repository purge job definition feature. Default value: false.</description>
    </property>
    <property>
        <key>repository.purge.enabled</key>
        <value>true</value>
        <description>Purpose: Enable/Disable the repository purge feature.</description>
    </property>
    <property>
        <key>repository.purge.history.unit</key>
        <value>days</value>
        <description>Purpose: The unit for job history data to kept in the repository before purging should occur. The current supported values are days, weeks, months, and years. Default value: days.</description>
    </property>
    <property>
        <key>repository.purge.history.unitcount</key>
        <value>60</value>
        <description>Purpose: The number of units for job history data to kept in the repository before purging should occur. This value is combined with the value for repository.purge.history.unit to determine the amount of time before purging should occur for old jobs (for example, 60 days, 3 years, or 10 months). Default value: 60. The value of -1 will disable the purging by time.</description>
    </property>
    <property>
        <key>repository.purge.hour</key>
        <value>1</value>
        <description>Purpose: The hour when the daily repository purging should start. Default value 1 means 1am.</description>
    </property>
    <property>
        <key>repository.purge.minute</key>
        <value>0</value>
        <description>Purpose: The minute when the daily repository purging should start. Default value 0.</description>
    </property>
    <property>
        <key>repository.purge.percent</key>
        <value>50</value>
        <description>Purpose: The percentage of repository permspace that needs to be available to determine when purging should occur. Default value 50 means the repository should be purged when more than 50% of the available permspace is in use. The value of -1 will disable the purging by percentage.</description>
    </property>
    <property>
        <key>skip.FLML.tables</key>
        <value>true</value>
        <description>If enabled (true) and the table is being Fast/Multi Loaded, the daemon marks it as COMPLETED WITH WARNINGS. If disabled (false) and the table is being Fast/Multi Loaded, the daemon marks the table movement as FAILED. Default is false.</description>
    </property>
    <property>
        <key>system.default.database.enabled</key>
        <value>false</value>
        <description>Purpose: Enable/Disable the default target/staging databases at the system level. Default value false means disabled.</description>
    </property>
    <property>
        <key>target.system.load.slots</key>
        <value>5</value>
        <description>Purpose: Controls maximum number of load slots that Data Mover can use at one time on target Teradata systems. Default: 5.</description>
    </property>
    <property>
        <key>tmsm.frequency.bytes</key>
        <value>2147483647</value>
        <description>Purpose: Controls frequency of sending messages when using byte-based utilities (for example, TPTAPI). Default: 2147483647 bytes.</description>
    </property>
    <property>
        <key>tmsm.mode</key>
        <value>NONE</value>
        <description>Purpose: Controls how Data Mover directs messages. When set to BOTH, messages will be written to the TDI event tables. Default: NONE.</description>
    </property>
</dmSaveConfiguration>