QUERY JOB (Query a retention set creation job)

Use this command to display information about one or more retention set creation jobs and their statuses. You can filter the list of jobs that are displayed by specifying a job ID or by specifying various job attributes.

Privilege class

Any administrator can issue this command.

Syntax

Parameters

job_id

Specifies the ID of the job to query. The job ID is a unique numeric value that is automatically assigned when the job starts. If you specify a job ID, only that job is considered during query processing and you do not have to specify other parameters. If you do not specify a job ID, all jobs are queried.

Status

Specifies the status of a job. Only jobs that match the specified status are displayed. If you do not specify a status, all jobs are displayed. This parameter is optional. You can specify one of the following values:

ANy: Displays all jobs. This is the default value.
Running: Displays all jobs that are currently running. When a job starts, the job status is automatically set to RUNNING and a time stamp that indicates the start time for the job is stored in the database. When a job stops running, the job status changes to INTERRUPTED or COMPLETED, depending on what happens during job execution. Also, when a job stops running, active processes stop and the job information is updated with an end time and a status.
Interrupted: Displays all jobs that were interrupted because of an error.
COmpleted: Displays all jobs that were completed successfully without errors.

BEGINDate

Specifies the beginning date in a range of retention set creation job dates. All retention set creation jobs that were started from this date are displayed. The default value is the earliest possible date on which the first retention set creation job was started. If you specify a time but do not specify a beginning date, the earliest possible date is used. If you do not specify either a beginning date or time, all jobs from the earliest possible date to the current time are queried. This parameter is optional.

You can specify the date by using one of the following values:

Value	Description	Example
MM/DD/YYYY	A specific date	05/15/2018
TODAY	The current date	TODAY
TODAY+days or +days	The current date plus the number of specified days	TODAY+3 or +3
TODAY-days or -days	The current date minus the number of specified days	TODAY-3 or -3
EOLM (End Of Last Month)	The last day of the previous month	EOLM
EOLM-days	The last day of the previous month minus the number of specified days	EOLM-1 To include files that were active a day before the last day of the previous month
BOTM (Beginning Of This Month)	The first day of the current month	BOTM
BOTM+days	The first day of the current month, plus the number of specified days	BOTM+9 To include files that were active on the 10th day of the current month

BEGINTime

Specifies the beginning time in a range of retention set creation job times. All retention set creation jobs that started from this time are displayed. This parameter is optional. The default value is 00:00:00.

You can specify the time by using one of the following values:

Value	Description	Example
HH:MM:SS	A specific time	15:30:08
NOW	The current time	NOW
NOW+HH:MM or +HH:MM	The current time plus the specified number of hours and minutes	NOW+02:00 or +02:00
NOW-HH:MM or -HH:MM	The current time minus the specified number of hours and minutes	NOW-02:00 or –02:00

ENDDate

Specifies the ending date in a range of retention set creation job dates. All retention set creation jobs that started up to and including this date are displayed. This parameter is optional. The default is today's date.

You can specify the date by using one of the following values:

Value	Description	Example
MM/DD/YYYY	A specific date.	05/15/2018
TODAY	The current date.	TODAY
TODAY+days or +days	The current date plus the number of specified days. The maximum number of days that you can specify is 9999.	TODAY+3 or +3
TODAY-days or -days	The current date minus the number of specified days.	TODAY-3 or -3
EOLM (End Of Last Month)	The last day of the previous month.	EOLM
EOLM-days	The last day of the previous month minus the number of specified days.	EOLM-1 To include files that were active a day before the last day of the previous month
BOTM (Beginning Of This Month)	The first day of the current month.	BOTM
BOTM+days	The first day of the current month, plus the number of specified days.	BOTM+9 To include files that were active on the 10th day of the current month

ENDTime

Specifies the ending time of the range of retention set creation job times. All retention set creation jobs started up to and including this time are displayed. This parameter is optional. The default value is the current time.

You can specify the time by using one of the following values:

Value	Description	Example
HH:MM:SS	A specific time	15:30:08
NOW	The current time	NOW
NOW+HH:MM or +HH:MM	The current time plus the specified number of hours and minutes	NOW+02:00 or +02:00
NOW-HH:MM or -HH:MM	The current time minus the specified number of hours and minutes	NOW-02:00 or –02:00

Example: Display information about all retention set creation jobs

Display information about all jobs that created retention sets. See Field descriptions for field descriptions.

query job


Job ID         Begin Date/Time          End Date/Time            Status
----------     --------------------     --------------------     ----------------
        35     05/07/2018 08:41:48      05/07/2018 08:41:48      Completed
        36     05/07/2018 08:44:48      05/07/2018 08:44:48      Completed
        37     05/07/2018 08:45:18      05/07/2018 08:45:18      Completed
        42     05/13/2018 22:18:46      05/13/2018 22:18:46      Completed
        46     05/14/2018 08:44:50      05/14/2018 08:44:50      Completed
        47     05/14/2018 08:45:20      05/14/2018 08:45:20      Completed
        82     05/21/2018 17:09:25      05/21/2018 17:09:25      Completed
        91     05/25/2018 07:00:14      05/25/2018 07:00:14      Completed
        93     05/25/2018 13:00:19      05/25/2018 13:00:19      Completed

Field descriptions

Job ID: The unique numeric ID that is associated with the job.
Begin Date/Time: The data and time when the retention set creation job was started.
End Date/Time: The date and time when the retention set creation job ended.
Status: The status of the job.

Related commands

Table 1. Commands related to QUERY JOB
Command	Description
QUERY RETRULE	Displays information about retention rules.
QUERY RETSET	Displays information about retention sets.
QUERY RETSETCONTENTS	Displays information about the contents of retention sets.