15.11 - DSA Command Types - Data Stream Architecture

Teradata Data Stream Architecture (DSA) User Guide

prodname
Data Stream Architecture
vrm_release
15.11
created_date
December 2016
category
User Guide
featnum
B035-3150-026K
DSA commands can be categorized as the following two major types:
  • DSA setup commands for administration and configuration that allow you to create, update, and delete targets, sources, and the DSC repository. This functionality corresponds to that provided by the BAR Setup portlet.
  • DSA operation commands for management and reporting that allow you to create, execute, monitor, update, and delete jobs. This functionality corresponds to that provided by the BAR Operations portlet.
The following table lists and briefly describes the administration and configuration commands:
DSA Configuration Commands
Command Name Description
config_aws The config_aws command configures the Amazon S3 Server in the DSA repository based on parameter files.
config_azure The config_azure command configures the Microsoft Azure Server in the DSA repository based on parameter files.
config_dd_boost

The config_dd_boost command configures the DD Boost server for the DSA repository.

config_disk_file_system

The config_disk_file_system command configures the disk file system in the DSA repository.

config_general

The config_general command configures the general settings, based on the information contained in the parameters XML file.

config_media_servers

The config_media_servers command configures the BAR media servers.

config_nbu

The config_nbu command configures a DSA system to use Symantec NetBackup third-party software to back up and restore data.

config_repository_backup

The config_repository_backup command provides the configuration information to back up the DSC repository.

config_systems

The config_systems command configures the DSC settings for the Teradata system and nodes used for backup and restore jobs. It also sets the selector in the targeted system for ActiveMQ.

config_target_groups

The config_target_groups command configures the target groups based on the target type and the information from the parameters file.

config_target_group_map

The config_target_group_map command configures the map between target groups when restoring to a different client configuration.

delete_component

The delete_component command deletes an existing component based on the information in the parameters.

delete_target_group_map

The delete_target_group_map command deletes a target group map for restoring to a different client configuration.

disable_component

The disable_component command disables an existing BAR component based on the component name and type.

enable_component

The enable_component command enables an existing BAR component based on the component name and type.

export_config

The export_config command exports the current XML definition for the requested BAR component.

export_job_metadata

The export_job_metadata command exports metadata of a job (job definition, save sets, and targets) based on the requested backup version. In the case of a disaster to the DSC repository, exporting and then importing job metadata enables job migration and restoration to a different DSA environment.

export_repository_backup_config

The export_repository_backup_config command exports all configurations associated with setting up a repository backup job. This includes the system, NetBackup, media servers, and target group associated with the target selected in config_repository_backup.

export_target_group_map

The export_target_group_map command exports a map between target groups for restoring to a different client configuration.

import_repository_backup_config

The import_repository_backup_config command imports all configurations associated with setting up a repository backup job. This includes system, NetBackup, media servers, and target group configurations. This command is used to recover the DSC backup repository after a disaster.

list_access_module

The list_access_module command lists available access module types for a named media server.

list_components
The list_components command lists components defined and stored in the DSC repository. If a specific component is requested, that component definition is displayed. Otherwise, a list of the components matching any provided filters is displayed. Any partial component name returns all components matching the partial input.
The Type parameter is required.
list_general_settings

The list_general_settings command lists all current general settings.

list_repository_backup_settings

The list_repository_backup_settings command lists all current repository backup settings.

list_system_status

The list_system_status command lists the status of a system.

list_target_group_map

The list_target_group_map command lists the maps between target groups for restoring to a different client configuration.

The following table lists and briefly describes the management and reporting commands:

DSA Operating Commands
Command Name Description
abort_job

The abort_job command aborts an actively running job, a job in the queue, or a job that is not responding.

activate_job

The activate_job command activates a retired job, so that it is available.

consolidate_job_logs

The consolidate_job_logs command uploads all logs for a completed job to a centralized location. If the job is running, the command is rejected.

create_job

The create_job command creates a job based on the values you specify for parameters in the command line or in the XML file. Parameter values you enter in the command line supersede any value you enter for those parameters in the parameters XML file.

delete_job
The delete_job command deletes a job and any data associated with it from the DSC repository. Any logs and job history are deleted and cannot be restored. Any backup save sets created for the job that exist on devices managed by third-party solutions must be deleted manually using the interface for that solution.
This command only deletes new or retired jobs.
export_job

The export_job command exports the current XML definition for the requested job.

export_job_metadata

The export_job_metadata command exports metadata of a job (job definition, save sets, and targets) based on the requested backup version. In the case of a disaster to the DSC repository, exporting and then importing job metadata enables job migration and restoration to a different DSA environment.

import_job_metadata

The import_job_metadata command imports metadata of a job (job definition, save sets, and targets) to the specified directory. In the case of a disaster to the DSC repository, exporting and then importing job metadata enables job migration and restoration to a different DSA environment.

job_status

The job_status command gets the latest status for a job with the given name and displays it on the screen. If the job is running, a detailed status message is displayed. If the job is not running, the status of the last run for that job is displayed.

job_status_log

The job_status_log command displays the latest status log for a job with the given name if the job is running. If the job is not running, the status log for the last run job is displayed.

list_consumers

The list_consumers command sends a request to ActiveMQ to provide information about all of the consumers of DSA Network Client and DSMain processes. It checks whether the selector values match the names of the DSA Network Client and DSMain systems and that the processes are running.

list_jobs

The list_jobs command lists jobs defined and stored in the DSC repository. If a specific job is requested, that job definition is displayed. Otherwise, a list of job names matching any provided filters is displayed. If no parameters are provided, a list of jobs (excluding backup repository jobs) is displayed.

list_query_backupids

The list_query_backupids command lists the results of the query returned from the query_backupids command.

list_query_nbu_backupids

The list_query_nbu_backupids command lists the results of the query returned from the query_nbu_backupids command.

list_recover_backup_metadata

The list_recover_backup_metadata command lists the overall status and individual media server status of the recover_backup_metadata command.

list_save_sets

The list_save_sets command lists all valid save sets for a given job name.

list_validate_job_metadata

The list_validate_job_metadata command lists the information returned from a successful validate_job_metadata command.

object_release

The object_release command releases all objects that are currently locked by a job. It does not release objects for new, running, or queued jobs.

purge_jobs

The purge_jobs command can be used for cleaning up DSC repository when resources are not released after aborting jobs. The command will abort any jobs and purge the resources used by any incomplete jobs. When no job name is provided, it purges resources used by all jobs in BAR and BARBACKUP.

query_backupids

The query_backupids command queries third-party software for information needed for duplication.

query_nbu_backupids

The query_nbu_backupids command queries NetBackup for information needed for a NetBackup duplicate.

recover_backup_metadata

The recover_backup_metadata command queries the third party media to recover backup metadata and rebuild the backup job plan in the case of a disaster to the DSC repository. The command can only run on repository backup jobs with no save sets.

retire_job

The retire_job command retires an active job. It does not retire a running or queued status job, or one that is already in the retired state.

run_job

The run_job command runs a job as soon as all necessary resources are available. The DSC system limit is set at 20 concurrent running jobs, and up to 20 jobs can queue above that limit. The DSC also queues jobs if the defined target media is not available before the job starts.

run_repository_job

The run_repository_job command runs a job in the DSC repository.

set_status_rate

The set_status_rate command configures the status update rate between DSC and the media servers or Teradata systems.

system_health

The system_health command lists ActiveMQ system health information such as the memory limit and memory usage for the main DSA queues.

sync_save_sets

The sync_save_sets command sends a sync request to all NetBackup clients that have save sets older than the dataset.retention.days value configured in dsc.properties. If the save sets are expired on the NetBackup side, DSC deletes them from the DSC repository. No scheduled or ad hoc jobs can run until the deletion completes.

update_job

The update_job command updates an existing DSA job based on the information from the command line parameters or the XML file if provided. Parameter values specified in the command line supersede values entered for the same parameters in the XML file.

validate_job_metadata

The validate_job_metadata command queries NetBackup for information needed to validate the save set.