Command-Line Interface | Teradata DSA - 17.20 - DSA Command-Line Interface - BAR - Data Stream Architecture

Teradata® DSA User Guide

Product
BAR
Data Stream Architecture
Release Number
17.20
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-3150-101K
Language
English (United States)

DSA provides a command-line interface (CLI) that allows you to carry out the same actions as in the BAR Setup and BAR Operations portlets, plus additional commands that are not available in the portlets. The CLI includes setup commands for configuring, updating, and deleting targets, sources, and the DSC repository. The CLI also includes operations commands for creating, running, and monitoring jobs.

After the DSA command-line interface package is installed, access the command line from the Linux console. You can run DSA commands from any file system location without navigating to the root directory.
If you are non-root, you must be in the users group to run the DSA command-line interface.

You can run commands on an ad hoc basis, as an alternative to the portlets, and you can switch between the CLI and portlets. For example, you can create jobs in the portlet and then view them using list_jobs. Or you can export the XML file associated with a job created in the portlet, and update the job definition using the command line. You can also develop scripts to automate DSA commands and to use with UNIX cron or other job-scheduling applications. For example, you might want to have a backup job run automatically every night at 1 a.m.

Each command has parameters that can be specified directly in the command line. In addition, many commands require that additional information is specified in an XML file. Sample XML files for system and component configuration and for job definition are located at $BARCMDLINE_ROOT/samples. The sample files include helpful comments and show the available settings for the corresponding command.

Enabling General > Security Management in the BAR Setup portlet increases security for the DSA environment. This setting requires users to provide Viewpoint credentials to execute some commands from the DSA CLI.