Introduction
s
See
Job Resource Script
The Job Resource Script is provided for download and can be used to automate updates of job resources.
- The script is available for Linux, MacOS® and AIX® using bash, dash, ksh and zsh POSIX-compatible shells.
- The script terminates with exit code 0 to signal success, with exit code 1 for command line argument errors and with exit code 2 for non-recoverable errors.
- The script is intended as a baseline example for customization by JS7 users and by SOS within the scope of professional services.
Download
Download: set_job_resource.sh
Usage
Invoking the script without arguments displays the usage clause:
Usage
Usage: set_job_resource.sh [Options] [Switches] Options: --url=<url> | required: JOC Cockpit URL --controller-id=<identifier> | required: Controller ID --job-resource=<path> | required: path to job resource --key=<identifier> | required: name of variable in job resource --value=<string> | required: value of variable in job resource --cacert=<path> | optional: path to Root CA Certificate for HTTPS connections --user=<account> | optional: user account for login to JOC Cockpit --password=<account> | optional: password for login to JOC Cockpit --log-dir=<directory> | optional: log directory for log output of this script Switches: -h | --help | displays usage -v | --verbose | show verbose log output --show-logs | shows log output if --log-dir is used --make-dirs | creates directories if they do not exist
Options
--url
- Specifies the URL by which JOC Cockpit is accessible using
<http|https>://<host>:<port>
. - Example: http://centostest-primary.sos:4446
- Example: https://centostest-primary.sos:4443
- Specifies the URL by which JOC Cockpit is accessible using
--controller-id
- Specifies the Controller ID to which the updated job resource should be deployed.
--job-resource
- Specifies the path to the job resource in the JOC Cockpit inventory.
--key
- Specifies the name of the variable in the job resource specified with the
--job-resource
option.
- Specifies the name of the variable in the job resource specified with the
--value
- Specifies the value of the variable in the job resource specified with the
--job-resource
option.
- Specifies the value of the variable in the job resource specified with the
--cacert
- Specifies the path to a .pem file that holds the Root CA Certificate and optionally Intermediate CA Certificates to verify HTTPS connections to JOC Cockpit.
--user
- Specifies the directory in which the Agent should be installed.
--password
- Specifies the directory in which the Agent should be installed.
--log-dir
- If a log directory is specified then the script will log information about processing steps to a log file in this directory.
- File names are created according to the pattern:
set_job_resource.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example:
set_job_resource.2022-03-19T20-50-45.log
Switches
-h | --help
- Displays usage.
-v | --verbose
- Displays verbose log output.
--show-logs
- Displays the log output created by the script if the
--log-dir
option is used.
- Displays the log output created by the script if the
--make-dirs
- If directories are missing that are indicated with the
--home
,--backup-dir
or--log-dir
options then they will be created.
- If directories are missing that are indicated with the
Exit Codes
1
: argument errors4
: this exit code is returned if the JS7 REST Web Service is not reachable or reports errors
Examples
The following examples illustrate typical use cases.
Update Job Resource from HTTP Connection
Example for Update of a Job Resource Variable
./set_job_resource.sh \ --url=http://joc-2-0-primary:7446 \ --controller-id=controller \ --user=root \ --password=root \ --job-resource=/ProductDemo/Variables/pdBusinessDate \ --key=BusinessDate \ --value=$(date +'%Y-%m-%d') # updates the job resource variable "BusinessDate" from the current date # the connection to JOC Cockpit is established by HTTP
Update Job Resource from HTTPS Connection
Example for Update of a Job Resource Variable
./set_job_resource.sh \ --url=https://joc-2-0-primary:7446 \ --cacert=/home/sos/jstest/certs/root-ca.pem \ --controller-id=controller \ --user=root \ --password=root \ --job-resource=/ProductDemo/Variables/pdBusinessDate \ --key=BusinessDate \ --value=$(date +'%Y-%m-%d') # updates the job resource variable "BusinessDate" from the current date # the connection to JOC Cockpit is established by HTTPS and the Root CA Certificate is specified from the path to a .pem file
Overview
Content Tools