LOGON - Parallel Data Pump

Teradata Parallel Data Pump Reference

Product
Parallel Data Pump
Release Number
15.10
Language
English (United States)
Last Update
2018-10-07
dita:id
B035-3021
lifecycle
previous
Product Category
Teradata Tools and Utilities

LOGON

Purpose  

The LOGON command establishes a Teradata SQL session between Teradata TPump and Teradata Database. Use it to specify the LOGON string for connecting sessions required by subsequent functions. The ACCEPT and SET commands are valid commands preceding LOGON and LOGTABLE commands.

Note: To prevent the password from appearing in the script, use Teradata Wallet. Security Administration (B035‑1100) and the appropriate installation guide for more information.

Syntax  

Standard LOGON

Note: On z/OS, with the use of the User Logon Exit routine in TDP, the user name is not required. See the Teradata Director Program Reference (B035‑2416) for more information.

Single Sign On LOGON

Note: When logon encryption is enabled on the gateway, single sign on is disabled on the client and standard logon syntax should be used instead.

where

 

Syntax Element

Description

tdpid

Optional identifier associated with a particular copy of Teradata Database

If this field is not specified, the default tdpid, established by the system administrator, is used.

For mainframeattached systems, the tdpid string must be in the form:

TDPn 

where n is the TDP identifier

username

User identifier of up to a 30character maximum

password

Optional password associated with the username, up to a 30character maximum

Teradata Database must be configured to recognize the password specified.

Note: Passwords that contain special characters must be enclosed in double quotes. The strings in double quotes will not be touched in the LOGON command.

'acctid'

Optional account identifier associated with the username, up to a 30character maximum

The string specification must be enclosed in single quotes.

If this field is not specified, a default acctid” is used.

Usage Notes

Both the LOGON command and the LOGTABLE command are required to set up the Teradata TPump support environment. Use them in any order, but they must precede any other commands. However, a RUN FILE command can be used to identify a file containing the LOGON command before the LOGON and LOGTABLE commands.

LOGON and LOGTABLE commands typically occur as:

.logtable logtable001;
.logon tdpx/me,paswd;

When the LOGON command is executed, the initial Teradata TPump utility session is logged on. The logon information is saved and re‑used when processing the BEGIN LOAD command to connect the appropriate number of sessions.

The parameters (tdpid, username, password, and “acctid”) are optional and are used in all sessions established with Teradata Database. The LOGON command may only occur once. The period (.) preceding LOGON is also optional.

The tdpid identifier specifies a particular Teradata Database. See the system or site administrator for the identifier planned to use. If a tdpid is not specified and the site administrator has not updated the System Parameter Block, the default identifier is Teradata Database. The long form of this parameter, tdpx, should be used to avoid CLI errors that can occur when the short form is used.

The tdpid parameter is optional if the site has only one TDP, if a TDP command was previously executed, or if the default TDP was selected. This parameter is not case‑sensitive.

Teradata TPump does not prompt for a username or password. If either or both of these are required, Teradata TPump fails and reports the error. Both of these parameters may be optional if a logon exit is used.

Where possible, do not use special characters in the acctid parameter string. Although acctid may contain special characters, the special characters might be interpreted differently by different output devices. Therefore, a script containing special characters might have to be modified if the output is routed to another device. If the acctid contains an apostrophe (single quote) character, use either the second form of the LOGON command, which is delimited by quotes, or double the apostrophe character as follows:

.LOGON 0/fml,fml,"engineering’s account"

or

.LOGON 0/fml,fml,'engineering"s account"

If the acctid does not contain an apostrophe, the two LOGON command forms are the same.

If any parameter is entered incorrectly, the logon fails and Teradata TPump returns an error message. For security reasons, the error message does not state in which parameter the error occurred.

If password security on a mainframe‑attached client is a concern, use the RUN FILE command to alter the script to accept the LOGON command from another dataset/file under the control of ACF2 or another client‑resident security system. For example:

//stepname EXEC PGM=TPUMP,...
//SECURE DD DSN = FOO
//SYSIN DD *
.LOGTABLE MYTABLE;
.RUN SECURE;

Then log on by simply entering the LOGON command with a valid user name and no password if the system administrator has granted this option. As an example, to log onto Teradata TPump as user ABC with ABC as the password (which is masked from view on the output listing), specify the LOGON command on one line as follows:

.logon ABC,ABC

When the command is entered, Teradata TPump displays something like:

**** 19:07:16 UTY8400 Teradata Database Release: 15.10.00.00
**** 19:07:16 UTY8400 Teradata Database Version: 15.10.00.00
**** 15:12:47 UTY8400 Default character set: ASCII
**** 15:12:47 UTY8400 Current RDBMS has UDT support
**** 15:12:47 UTY8400 Maximum supported buffer size: 1M
**** 15:12:47 UTY8400 Upsert supported by RDBMS server
**** 15:12:47 UTY8400 Data Encryption supported by RDBMS server
**** 15:12:47 UTY8400 Array Support supported by RDBMS server
**** 15:12:48 UTY6211 A successful connect was made to the RDBMS.

Logon exits are supported on both mainframe and clients in the UNIX system. The CLIv2 User Logon Exit routine can be used to make some or all logon string elements optional.

LOGON is used with the LOGTABLE command, both of which are required. LOGON and LOGTABLE may appear in any order. If LOGON is entered first, a warning that LOGTABLE is required is returned.

The parameters (tdpid, username, password, and “acctid”) are used in all sessions established with Teradata Database. The LOGON command may occur only once.

Note: If the database is configured to use the Single Sign On (SSO) and the Teradata client machine is logged on, the machine name, user name, and password are not required in the LOGON command. The user name and password combination specified when the Teradata client machine was logged on are authenticated via network security for a SSO such that valid Teradata users will be permitted to log on to Teradata Database. The use of SSO is strictly optional, unless the Gateway has been configured to accept only SSO‑style logons.

To connect to a Teradata Database other than the default, the TDPid must be included in the LOGON command. If the TDPid is not specified, the default contained in clispb.dat will be used. To be interpreted correctly, the TDPid must be followed by the slash separator (/), to distinguish the TDPid from a Teradata Database user name. For example, to connect to slugger, enter one of the following:

.LOGON slugger/;
.LOGON slugger/,,'acctinfo';

If the LOGON command is entered first, Teradata TPump warns that the LOGTABLE command is also required.

If an account ID is to be used, the optional account ID must be specified in the LOGON command.

Teradata TPump terminates with a proper message when Teradata TPump attempts to connect the Main SQL session the first time and the Teradata Database is down.