Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleUsage
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 variableargument in job resource
    --value=<string>              | required: value of argument in job resource
    --env-var=<identifier>        | optional: name of environment variable in job resource
    --user=<account>[:<password>] | optional: user account for login to JOC Cockpit, use <account> or <account>:<password>
    --cacert=<path>               | optional: path to Root CA Certificate for HTTPS connections
    --client-cert=<path>          | optional: path to Client Certificate for HTTPS mutual authentication
    --client-key=<path>           | optional: path to Client Private Key for HTTPS mutual authentication
    --log-dir=<directory>         | optional: log directory for log output of this script

  Switches:
    -h | --help                   | displays usage
    -v | --verbose                | shows verbose log output
    --show-logs                   | shows log output if --log-dir is used
    --make-dirs                   | creates directories if they do not exist

...

  • --url
  • --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 an argument in the job resource specified with the --job-resource option.
    • Job Resource variables arguments are case-sensitive.
  • --value
    • Specifies the value of the argument in the job resource specified with the --job-resource option.
  • --env-var
    • Optionally specifies the name of an environment variable in the job resource specified with the --job-resource option.
    • The environment variable will be assigned a reference to the argument specified by the --key option to hold the same value as the argument.
    • Job Resource environment variables are case-sensitive.
  • --user
    • Specifies the user account for login to JOC Cockpit. Specification of the user account can be omitted if a JS7 - Identity Services is available for Client authentication certificates that are specified with the --client-cert and --client-key options.
    • --user=<account> can be specified to cause the password to be prompted.
    • --user=<account>:<password> can be specified.
  • --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.
  • --client-cert
    • Specifies the path to a .pem file that holds the Client Certificate if HTTPS mutual authentication is used..
  • --client-key
    • Specifies the path to a .pem file that holds the Client Privae Key if HTTPS mutual authentication is used..
  • --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

...

Code Block
titleExample for Update of a Job Resource Variable
linenumberstrue
./set_job_resource.sh \
    --url=http://joc-2-0-primary:7446 \
    --controller-id=controller \
    --user=root:root \
    --job-resource=/ProductDemo/Variables/pdBusinessDate \
    --key=businessDate \
    --value=$(date +'%Y-%m-%d')

# updates the job resource variableargument "businessDate" from the current date
# the connection to JOC Cockpit is established by HTTP

...

Code Block
titleExample for Update of a Job Resource Variable
linenumberstrue
./set_job_resource.sh \
    --url=https://joc-2-0-primary:7446 \
    --cacert=/home/sos/jstest/certs/root-ca.pem \
    --controller-id=controller \
    --user=root:root \
    --job-resource=/ProductDemo/Variables/pdBusinessDate \
    --key=businessDate \
    --env-var=BUSINESS_DATE \
    --value=$(TZ=Europe/London date +'%Y-%m-%d')

# updates the job resource variableargument "businessDate" from the current date
# the environment variable "BUSINESS_DATE" will be assigned the same date from a reference to the argument
# the date is specified from the UK time zone
# the connection to JOC Cockpit is established by HTTPS and the Root CA Certificate is specified from the path to a .pem file

...