qoperation jobretention

Updated

Description

This command allows you set retention rules on a given job. The job ID, storage policy, and storage policy copy names must be specified when using this command.

Jobs that are not retained are subject for data aging. Jobs that are retained with a specified retention period will become subject for data aging after the retention period ends. If you retain a job, however, and do not specify the retention period, the job data will never be subject for data aging.

In case of an error, an error code and description are displayed as: "jobretention: Error errorcode: errordescription"

Usage

qoperation jobretention -j <jobid> -sp <storagepolicy> -spc <copy> -rtn <true|false> [-rd <infinite or mm/dd/yyyy hh:mm:ss or yyyy/mm/dd hh:mm:ss>]
    

Options

-j

Job ID

-sp

Storage policy name

-spc

Storage policy copy name

-rtn

Job to be retained (true) or not (false)

-rd

Date until the job is to be retained. Valid values are:

  • infinite

  • mm/dd/yyyy hh:mm:ss

  • yyyy/mm/dd hh:mm:ss

-tf

Reads token from a file

-tk

Token string

-h

Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Retain a job - with job ID 175, storage policy sp1 and storage policy copy copy1 - indefinitely by setting the retention period to infinite.

qoperation jobretention -j 175 -rtn true - rd infinite -sp sp1 -spc copy1
    

Was this page helpful?