retire_job | Teradata DSA Commands - 17.20 - retire_job - BAR - Data Stream Architecture

Teradata® DSA User Guide

Product
BAR
Data Stream Architecture
Release Number
17.20
Published
November 2022
Last Update
2022-11-14
Content Type
User Guide
Publication ID
B035-3150-101K
Language
English (United States)
Last Update
2022-11-14

Purpose

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.

Syntax

retire_job -n|-name Name -S|-skip_prompt

Example

dsc retire_job -n job1 -S

Parameters

n|name Name
The name of the job on which to perform the action. Must be unique for each job.
Example: job1
S|skip_prompt SkipPrompt
[Optional] Skips displaying a confirmation message before performing the command action.
u|user_authentication User
Required when security management is enabled. Supplies the command with the Viewpoint user, and triggers a password prompt for authentication.

Permissions required: DSA Job Permissions: Run and Edit

Usage Notes

After a job is retired, no status information is returned for the job. The only commands you can use with a retired job are: delete_job, activate_job and list_jobs (with a retired state parameter).

XML File Example

This command does not support an XML file.