unityadmin Parameters | Teradata Unity - unityadmin Shell Parameters - Continuous Availability - Teradata Unity

Teradata® Unity™ User Guide

Continuous Availability
Teradata Unity
Release Number
September 2020
English (United States)
Last Update
Product Category
Analytical Ecosystem

The following table lists optional parameters you can include when running the unityadmin shell.

Command Option Description
-w <password key> Uses password stored with TD wallet key <password key> for authentication.
-u <username> Specifies the Unity username.
-P <password> Specifies the Unity user password.
-h <host> Sets the name or IP address of the Unity server to which to connect. The default is localhost.
-p <port> Sets the listening port of the Sequencer server. The default value is 5344.
-e "<command>" Enables you to run a single unityadmin command from the command line. The tools exits once the command returns. The user and password must be specified as part of the command-line arguments. The command must be enclosed in quotes. For example,-e "SESSION LIST". To use unityadmin in interactive mode, do not specify -e.
-l <filename> Sends the session output to the specified log file. There is no default log file.
-nosync or -n * Sets the unityadmin shell default to asynchronous mode. By default, the unityadmin shell runs all operations in the synchronous mode. You must specify this command option to switch to asynchronous mode. When the command succeeds, the output prints "All operations will be run in asynchronous mode."

You can use the abbreviation -n or -nosync for this command option. For example, unityadmin -nosync or unityadmin -n.

-sync or -s * Sets the unityadmin shell to synchronous mode which blocks each command that runs in the shell until it completes. When a synchronous command succeeds, the output prints "Operations' output will be synchronous."

You can use the abbreviation -s or -sync for this command option; for example: unityadmin -s or unityadmin -Sync. This option is enabled by default.

--prompt=<string> Specifies the command prompt string. The default value is unityadmin.
-? Displays help information.

* If both the -n and -s options are entered in the same command, unityadmin uses the last option in the command as the selected operation. For example, in the command unityadmin -s -n, unityadmin selects to run all operations in the non-synchronous mode.


These examples show a Unity user working in the /opt/teradata/unity directory.

The following example shows a user connecting to the Sequencer on the host ftcp1 and using the default port and username admin. The user is prompted for a password.

./bin/unityadmin -h ftcp1 -u admin

The following example shows a user connecting to the Sequencer on the host ftcp1 and with the username admin and password adminPass. The user includes -e to run the SYSTEM ACTIVATE ALL command. This format is a useful for running scripting tasks at unityadmin. The unityadmin shell runs by default in synchronous mode, and therefore the -s option used previously to force unityadmin to wait for command completion before continuing is no longer needed.

./bin/unityadmin -h ftcp1 -u admin -P adminPass -e "SYSTEM ACTIVATE ALL";

The following example shows the Welcome message that displays when you log on. The last line of the message tells you the mode selected for running all operations.

unityadmin -u admin -P admin
Login successful, authenticated connection established.

Welcome to the Unity interactive administration shell (version

Commands end with ;
Type 'help' for additional shell commands.

All operations will be run in synchronous mode.