retire_job - Data Stream Architecture

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.

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.

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.