Page History

...

Code Block

title	Usage

Usage: operate-joc.sh [Command] [Options] [Switches]

  Commands:
    status             --controller-id
    check-license     [--validity-days]
    encrypt           --in [--infile --outfile] --cert [--java-home] [--java-lib]
    decrypt           --in [--infile --outfile] --key [--key-password] [--java-home] [--java-lib] 

  Options:
    --url=<url>                        | required: JOC Cockpit URL
    --user=<account>                   | required: JOC Cockpit user account
    --password=<password>              | optional: JOC Cockpit password
    --ca-cert=<path>                   | optional: path to CA Certificate used for JOC Cockpit login
    --client-cert=<path>               | optional: path to Client Certificate used for login
    --client-key=<path>                | optional: path to Client Key used for login
    --timeout=<seconds>                | optional: timeout for request, default: 60
    --controller-id=<id>               | required: Controller ID
    --validity-days=<number>           | optional: min. number of days for which a license should be valid, default: 60 
    --key=<path>                       | optional: path to private key file in PEM format
    --key-password=<password>          | optional: password for private key file
    --cert=<path>                      | optional: path to certificate file in PEM format
    --in=<string>                      | optional: input string for encryption/decryption
    --infile=<path>                    | optional: input file for encryption/decryption
    --outfile=<path>                   | optional: output file for encryption/decryption
    --java-home=<directory>            | optional: Java Home directory for encryption/decryption, default: $JAVA_HOME
    --java-lib=<directory>             | optional: Java library directory for encryption/decryption, default: ./lib
    --audit-message=<string>           | optional: audit log message
    --audit-time-spent=<number>        | optional: audit log time spent in minutes
    --audit-link=<url>                 | optional: audit log link
    --log-dir=<directory>              | optional: path to directory holding the script's log files

  Switches:
    -h | --help                        | displays usage
    -v | --verbose                     | displays verbose output, repeat to increase verbosity
    -p | --password                    | asks for password
    -k | --key-password                | asks for key password
    --show-logs                        | shows log output if --log-dir is used
    --make-dirs                        | creates directories if they do not exist

see https://kb.sos-berlin.com/x/QoiOCQ

Commands

status

Returns status information about the JOC Cockpit, Controller instances and database indicated by a textual status and severity, for details see JS7 - Dashboard:

JOC Cockpit Status	Property	Value
JOC Cockpit Cluster Status	current	true\|false

Controller Status	Text	Severity
JOC Cockpit Controller Cluster Status	coupled	0
	unknown	13
Controller Cluster Node Status	active	0
	inactive	1
	unknown	3
Controller Component Status	operational	0
	limited	1
	inoperable	2
	unknown	3
Controller Connection Status	established	0
	unstable	1
	unreachable	2
	unknown	3

Database Status	Text	Severity
Database Component Status	operational	0
	unknown	3
Database Connection Status	established	0
	unstable	1
	unreachable	2
	unknown	3

check-license
- Terminates an order which optionally includes to forcibly terminate running jobs using the --force switch.
- When used for license checks the script terminates with exit code 0 to signal a valid license that will not expire before a number of days. Exit code 2 signals an expired license, exit code 3 signals a valid license that is about to expire within a number of days.
encrypt
- Allows to encrypt a value using the --in option. If used to encrypt a file then --infile and --outfile options must be specified.
- The --cert option specifies the path to a file holding the Certificate used for encryption.
- Encryption is performed by Java libraries that are looked up in the ./lib sub-directory of the JS7 Unix Shell CLI. For details see JS7 - Encryption and Decryption.
decrypt
- Allows to decrypt a value using the --in option. If used to decrypt a file then --infile and --outfile options must be specified.
- The --key option specifies the path to the Private Key used for decryption. If the Private Key is protected by a password, then the --key-password option or switch must be specified.
- Decryption is performed by Java libraries that are looked up in the ./lib sub-directory of the JS7 Unix Shell CLI.

...

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Commands