Wiki Admin

dssjobconfig - DSS 6 | Data Source Solutions Documentation

Export as HTML Export as PDF Export as DOCX
Edit

Documentation: dssjobconfig - DSS 6 | Data Source Solutions Documentation

dssjobconfig

Usage

  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] <em>hub</em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Show jobs and their statuses.
  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] <b>-a</b> <em>hub</em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Show job attributes along with jobs and their statuses.
  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] [<b>-d</b>] <b>-A</b> [<em>attribute</em>[=<em>value</em>]]... <em>hub </em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Set or delete (-d) job attribute(s).
  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] <b>-d</b> <em>hub</em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Delete jobs and their corresponding attributes and environment variables.
  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] <b>-e</b> <em>hub</em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Show environment variables along with jobs and their statuses.
  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] [<b>-d</b>] <b>-E</b> [<em>attribute</em>[=<em>value</em>]]... <em>hub </em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Set or delete (-d) environment variables for jobs.
  • <b>dssjobconfig</b> [<b>-R</b><em>url</em>] <b>-l</b> <em>hub</em>[<em>chn</em>] [<em>chn-task</em>] [<em>job</em>] [SYSTEM] Show latency information for capture and integrate jobs along with the jobs and their statuses.

Description

The dssjobconfig command allows you to:

  • view jobs and their statuses.
  • view and manage job attributes
  • view and manage job environment variables
  • view job latencies.

The required argument hub specifies the name of the hub containing the jobs, job attributes, and environment variables you want to view or manage.

Command dssjobconfig without any options shows the list of all jobs on the hub and their statuses.

Use the following arguments to view only the required jobs, job attributes, environment variables, and job latencies or to set/delete only specific job attributes and environment variables:

  • chn: related to a specific channel
  • chn-task: related to specific task jobs of a channel (task can be: cap, integ, activate, refr, cmp)
  • job: related to a specific job
  • SYSTEM: related to system-wide job group. This is to set default job attributes, environment variables for all jobs in the hub.

See section Examples for specific usage examples of the dssjobconfig command.

Command dssjobconfig corresponds to the Jobs tab in the User Interface.

Options

This section describes the options available for command dssjobconfig.

Parameter Description
-a Show job attributes in addition to jobs and their statuses. This option cannot be combined with options -A, -E or -d.
-Aname_args Set the job attribute. This option is also used in combination with option -d to delete job attributes.
-d

Delete the specified job and its corresponding job attributes and environment variables.

Generally suspending jobs with dsssuspend is more appropriate than deleting them.
-e Show environment variables in addition to jobs and their statuses. This option cannot be combined with options -A, -E or -d.
-Ename_val Set the environment variable for the job. This option is also used in combination with option -d to delete environment variables.
-l Show latency information for capture and integrate jobs in addition to the jobs and their statuses. This option cannot be combined with options -A, -E or -d.
-Rurl

Remote hub server. Access the hub server running on a remote machine, via the REST interface.

This option is required for remote CLI access. When using this option, command dsslogin should be run first, for authentication.

Examples

This section provides examples of using the dssjobconfig command.

Example 1. Show jobs, their statuses, job attributes and environment variables

  • The following command shows the list of all jobs and their attributes for channel mychannel.

    dssjobconfig -a myhub mychannel

  • The following command shows the list of jobs and the environment variables set on channel mychannel.

    dssjobconfig -e myhub mychannel

  • The following command shows all the capture jobs in channel mychannel.

    dssjobconfig myhub mychannel-cap

  • The following command shows all the refresh jobs in channel mychannel.

    dssjobconfig myhub mychannel-refr
Example 2. Set job attributes

The following command sets job attribute retry_max for job mychannel-activate.

dssjobconfig -A retry_max=1 myhub mychannel-activate
Example 3. Delete job attributes

The following command deletes job attribute retry_max for job mychannel-activate.

dssjobconfig -d -A retry_max myhub mychannel-activate
Example 4. Set environment variables

The following command sets environment variable DSS_PROC_TRACE for job mychannel-cap-src.

dssjobconfig -E DSS_PROC_TRACE=1 myhub mychannel-cap-src

The following command sets the system environment variable DSS_PERFORMANCE_METRIC_ENABLE for all jobs in the hub myhub. This command enables the Performance Metrics feature.

dssjobconfig -E DSS_PERFORMANCE_METRIC_ENABLE=1 myhub SYSTEM
Example 5. Delete environment variables

The following command deletes environment variable DSS_PROC_TRACE for job mychannel-cap-src.

dssjobconfig -d -E DSS_PROC_TRACE myhub mychannel-cap-src
Example 6. Delete job and its attributes and environment variables

The following command deletes job mychannel-cap-src, its attributes and environment variables (if any).

dssjobconfig -d myhub mychannel-cap-src