...

Command	Documentation
status	JS7 - Dashboard
status-agent	JS7 - Dashboard
health-check	JS7 - How to check the Impact of Host Shutdown when Patching
version	JS7 - Compatibility Indicator
switch-over	JS7 - How to fail-over and switch-over between JOC Cockpit Cluster Instances
restart-service / run-service	JS7 - Dashboard
check-license	JS7 - How to apply a JS7 License Key
get-settings / store-settings	JS7 - Settings
encrypt / decrypt	Encrypt / decrypt strings and filesJS7 - Encryption and Decryption

The script is offered for download and can be applied for frequently used operations:

...

Code Block

title	Usage

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

  Commands:
    status              --controller-id
    status-agent        --controller-id  [--agent-id] [--agent-state] [--agent-cluster] [--no-hidden]
    health-check        --controller-id  [--agent-id] [--agent-state] [--agent-cluster] [--no-hidden] [--whatif-shutdown]
    version            [--controller-id] [--agent-id] [--json]
    switch-over         --controller-id
    restart-service     [--service-type]  [--proxies]
    run-service         --service-type
    check-license      [--validity-days]
    get-settings
    store-settings      --settings
    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>               | optional: Controller ID
    --agent-id=<id[,id]>               | optional: Agent ID
    --agent-state=<state[,state]>      | optional: Agent state for filtering by state filters such as
                                                   COUPLED, RESETTING, RESET, INITIALISED, COUPLINGFAILED, SHUTDOWN
    --service-type=<identifier>        | optional: service for restart such as cluster, history, dailyplan, cleanup, monitor
    --validity-days=<number>           | optional: min. number of days for which a license should be valid, default: 60
    --settings=<json>                  | optional: settings to be stored from JSON
    --whatif-shutdown=<host[,host]>    | optional: health status if hosts will be shutdown
    --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
    -jx | --jsonproxies                     | specifies proxy |services returnsfor versionrestart
 information in   -j | --json                        | returns version information in JSON format
    --agent-cluster                    | filters non-clustered Agents
    --no-hidden                        | filters hidden Agents
    --show-logs                        | shows log output if --log-dir is used
    --make-dirs                        | creates directories if they do not exist

...

status

Returns status information about JOC Cockpit , & Controller & Agent instances and database indicated by a textual status and severity, for details see JS7 - Dashboard:. The textual status explains the status type, the severity indicates if this is considered normal behavior as for green (0), yellow (1) or a problem as with red (2, 3).

JOC Cockpit Status	Text	SevertiySeverity
JOC Cockpit Cluster Status	active	green (0)
	inactive	yellow (1)
	unknown	red (3)

Controller Status	Text	Severity
Controller Cluster Status	coupled	green (0)
	unknown	red (3)
Controller Cluster Node Status	active	green (0)
	inactive	yellow (1)
	unknown	red (3)
Controller Component Status	operational	green (0)
	limited	yellow (1)
	inoperable	red (2)
	unknown	red (3)
Controller Connection Status	established	green (0)
	unstable	yellow (1)
	unreachable	red (2)
	unknown	3

Agent StatusTextSeverityAgent Cluster Statusactive0inactive1unknown3Agent Component Statuscoupled0resettingresetinitialisedcouplingfailedshutdownunknown

red (3)

Database Status	Text	Severity
Database Component Status	operational	green (0)
	unknown	red (3)
Database Connection Status	established	green (0)
	unstable	yellow (1)
	unreachable	red (2)
	unknown	red (3)

healthstatus-checkagent

Returns status information about Agent instances indicated by a textual status and severity, for details see JS7 - Dashboard. The textual status explains the status type, the severity indicates if this is considered normal behavior as for green (0), yellow (1) or a problem as with red (2, 3).

Agent Status	Text	Severity
Agent Cluster Status	active	green (0)
	inactive	yellow (1)
	unknown	red (3)
Agent Component Status	coupled	green (0)
	resetting	yellow (1)
	reset	yellow (1)
	initialised	yellow (1)
	couplingfailed	red (2)
	shutdown	red (2)
	unknown	red (3)

health-check
- Performs a health check and returns status information for each JOC Cockpit, Controller and Agent instances
- Performs a health check and returns status information for each JOC Cockpit, Controller and Agent instances.
- When used with the --agent-id option, filters the indicated. Agents. More than one Agent ID can be specified separated by comma, for example: --agent-id=agent1,agent2.
- Performs a scenario check Checks the scenario of host shutdown when used with the --whatif-shutdown option. The option takes a hostname. More than one hostname can be specified separated by comma, for example: --whatif-shutdown=host1.example.com,host2.example.com. The check implies to verify verifying if the JS7 scheduling environment will remain healthy operational in case that the given host or hosts will be shut down.
  - The check returns exit code 0 for a healthy an operational environment and exit code 3 for an unhealthy inoperable envirornment.
  - Users can perform the check before patching hosts, see JS7 - How to check the Impact of Host Shutdown when Patching.
version
- Returns version information of JOC Cockpit, Controller and Agents.
  - When used without options, the JOC Cockpit version will be returned.
  - When usiedf with the --controller-id option, the version of the indicated Controller will be returned.
  - When used with the --agent-id option, the version of the indicated Agent will be returned. If a Cluster Agent is specified, then version information for included Director Agents and Subagents will be returned in JSON format.
- When used with the --json switch switch, then information about included Controllers and/or Agents will be returned in JSON format.
switch-over
- Shifts the active role to the Standby JOC Cockpit instance.
restart-service
- Allows to restart JOC Cockpit proxy services when used with the --proxies switch.
- Allows to restart JOC Cockpit background services. One of the following services can must be specified using the --service-type option:
  - cluster, history, dailyplan, cleanup, monitor
- JOC Cockpit background services will run based on events (cluster, history, monitor) or based on schedules configurable with JS7 - Settings (dailyplan, cleanup). To force a background service to start immediately the run-service command can be used.
run-service
- Starts JOC Cockpit background services. One of the following services can be specified using the --service-type option:
  - dailyplan, cleanup
- JOC Cockpit background services will run based on schedules configurable with JS7 - Settings (dailyplan, cleanup). The run-service command will force immediate execution of the service.
check-license
- Checks which JS7 - License is available with JOC Cockpit and if it is valid for a predetermined period.
  - The Open Source License is valid for any period of time and will not expire.
  - The Commercial License can be perpetual or can be valid for a limited subscription period.
- The --validity-days option specifies the number of days before expiration of the Commercial License. Default: 60 days.
- Exit codes of the license check include:
  - Exit code 0 signals a valid license for the period specified.
  - Exit code 2 signals an expired license or an inapplicable license check if the Open Source License is used.
  - Exit code 3 signals a valid license that is about to expire within the number of days specified.
get-settings
- Returns JS7 - Settings in JSON format.
- Users can modify settings using the jq utility and can update settings using the store-settings command.
store-settings
- Updates JS7 - Settings in JOC Cockpit.
- Users can read settings using the get-settings command and can modify settings using the jq utility before updating settings.
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.

...

-h | --help
- Displays usage.
-v | --verbose
- Displays verbose log output that includes requests and responses with the JS7 REST Web Service.
- When used twice as with -v -v then curl verbose output will be displayed.
-p | --password
- Asks the user for interactive keyboard input of the password used for the account specified with the --user option..
- The switch is used for secure interactive input as an alternative to use of the option --password=<password>.
-k | --key-password
- Asks the user for interactive keyboard input of the password used for access to a keystore or key file specified with the --keystore or --key options.
- The switch is used for secure interactive input as an alternative to use of the --key-password=<password> option.
-j | --json
- Returns version information in JSON format when used with the version command.
--agent-cluster
- When used with the status-agent and health-status commandcheck commands, filters non-clustered Agents.
--no-hidden
- When used with the status-agent and health-status commandcheck commands, filters hidden Agents.
--show-logs
- Displays the log output created by the script if the --log-dir option is used.
--make-dirs
- If directories are missing that are indicated with the --log-dir option then they will be created.

...

0: operation successful
1: argument errors
2: permanent error
3: no objects found or temporary error
4: JS7 REST Web Service is not reachable or reports errors

...

Code Block

language	bash
title	Examples for Getting JOC Cockpit and Controller Status Information
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)

# get status information for Standalone JOC Cockpit and Controller
response=$(./operate-joc.sh status "${request_options[@]}" --controller-id=controller)

# returns response
{"clusterState":{"_text":"ClusterUnknown","severity":2},"controllers":[{"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerId":"controller","host":"localhost","id":20,"isCoupled":false,"javaVersion":"21+35-2513","os":{"architecture":"amd64","distribution":"3.10.0-1160.92.1.el7.x86_64","name":"Linux"},"role":"STANDALONE","securityLevel":"HIGH","startedAt":"2024-09-03T09:52:38.918Z","surveyDate":"2024-09-23T10:10:01.496Z","title":"Standalone Controller","url":"http://localhost:4444","version":"2.7.2"}],"database":{"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"dbms":"H2","version":"1.4.200 (2019-10-14)"},"deliveryDate":"2024-09-23T10:10:01.499Z","jocs":[{"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerConnectionStates":[{"role":"STANDALONE","state":{"_text":"established","severity":0}}],"current":true,"host":"localhost","id":1,"instanceId":"joc#0","isApiServer":false,"lastHeartbeat":"2024-09-23T10:09:43.682Z","memberId":"localhost:1ce420678f21a574e6adeb2f218f5bd40ed1b1bf9005414bcf060fba2e4c5a67","os":{"architecture":"amd64","distribution":"3.10.0-1160.92.1.el7.x86_64","name":"Linux"},"securityLevel":"HIGH","startedAt":"2024-09-19T20:55:34.522Z","title":"My JOC Cockpit","url":"http://localhost:4446","version":"2.7.2"}]}

# getreads severity from status informationresponse
echo "$response" | jq -r '.jocs[0].componentState.severity // empty'
echo "$response" | jq -r '.jocs[0].connectionState.severity // empty'
echo "$response" | jq -r '.jocs[0].controllerConnectionStates[0].state.severity // empty'
echo "$response" | jq -r '.jocs[0].version // empty'
echo "$response" | jq -r '.database.componentState.severity // empty'
echo "$response" | jq -r '.database.connectionState.severity // empty'


# get status information for JOC Cockpit Cluster and Controller Cluster
response=$(./operate-joc.sh status "${request_options[@]}" --controller-id=controller)
 
# returns response
{"clusterState":{"_text":"ClusterCoupled","severity":0},"controllers":[{"clusterNodeState":{"_text":"inactive","severity":1},"clusterUrl":"http://localhost:4444","componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerId":"controller_cluster","host":"localhost","id":2,"isCoupled":true,"javaVersion":"17.0.12+7-alpine-r0","os":{"architecture":"amd64","distribution":"3.10.0-1160.92.1.el7.x86_64","name":"Linux"},"role":"PRIMARY","securityLevel":"MEDIUM","startedAt":"2024-09-18T20:29:33.271Z","surveyDate":"2024-09-23T10:07:16.768Z","title":"PRIMARY CONTROLLER","url":"http://localhost:4444","version":"2.7.2"},{"clusterNodeState":{"_text":"active","severity":0},"clusterUrl":"http://localhost:4444","componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerId":"controller_cluster","host":"localhost","id":3,"isCoupled":true,"javaVersion":"17.0.12+7-alpine-r0","os":{"architecture":"amd64","distribution":"3.10.0-1160.92.1.el7.x86_64","name":"Linux"},"role":"BACKUP","securityLevel":"MEDIUM","startedAt":"2024-09-18T20:29:33.972Z","surveyDate":"2024-09-23T10:07:16.737Z","title":"SECONDARY CONTROLLER","url":"http://localhost:44444","version":"2.7.2"}],"database":{"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"dbms":"MySQL","version":"5.7.33"},"deliveryDate":"2024-09-23T10:07:16.773Z","jocs":[{"clusterNodeState":{"_text":"active","severity":0},"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerConnectionStates":[{"role":"PRIMARY","state":{"_text":"established","severity":0}},{"role":"BACKUP","state":{"_text":"established","severity":0}}],"current":true,"host":"localhost","id":3,"instanceId":"joc#0","isApiServer":false,"lastHeartbeat":"2024-09-23T10:07:13Z","memberId":"localhost:97c88ccc3975703ebd0b7277d394ec8768f88b31775e8df038572d2547c240a0","os":{"architecture":"amd64","distribution":"3.10.0-957.1.3.el7.x86_64","name":"Linux"},"securityLevel":"MEDIUM","startedAt":"2024-09-20T15:50:41Z","title":"PRIMARY JOC COCKPIT","url":"http://localhost:4446","version":"2.7.2"},{"clusterNodeState":{"_text":"inactive","severity":1},"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerConnectionStates":[{"role":"PRIMARY","state":{"_text":"established","severity":0}},{"role":"BACKUP","state":{"_text":"established","severity":0}}],"current":false,"host":"localhost","id":1,"instanceId":"joc#1","isApiServer":false,"lastHeartbeat":"2024-09-23T10:07:12Z","memberId":"localhost:97c88ccc3975703ebd0b7277d394ec8768f88b31775e8df038572d2547c240a0","os":{"architecture":"amd64","distribution":"3.10.0-957.1.3.el7.x86_64","name":"Linux"},"securityLevel":"MEDIUM","startedAt":"2024-09-20T15:50:40Z","title":"SECONDARY JOC COCKPIT","url":"http://localhost:4446","version":"2.7.2"}]}
# get severity from status information
echo "$response" | jq -r '.clusterState.severity // empty'
echo "$response" | jq -r '.controllers[0].componentState.severity // empty'
echo "$response" | jq -r '.controllers[0].connectionState.severity // empty'
echo "$response" | jq -r '.controllers[1].componentState.severity // empty'
echo "$response" | jq -r '.controllers[1].connectionState.severity // empty'
echo "$response" | jq -r '.jocs[0].componentState.severity // empty'
echo "$response" | jq -r '.jocs[0].connectionState.severity // empty'
echo "$response" | jq -r '.jocs[0].version // empty'
echo "$response" | jq -r '.database.componentState.severity // empty'
echo "$response" | jq -r '.database.connectionState.severity // empty'

...

":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerConnectionStates":[{"role":"PRIMARY","state":{"_text":"established","severity":0}},{"role":"BACKUP","state":{"_text":"established","severity":0}}],"current":true,"host":"localhost","id":3,"instanceId":"joc#0","isApiServer":false,"lastHeartbeat":"2024-09-23T10:07:13Z","memberId":"localhost:97c88ccc3975703ebd0b7277d394ec8768f88b31775e8df038572d2547c240a0","os":{"architecture":"amd64","distribution":"3.10.0-957.1.3.el7.x86_64","name":"Linux"},"securityLevel":"MEDIUM","startedAt":"2024-09-20T15:50:41Z","title":"PRIMARY JOC COCKPIT","url":"http://localhost:4446","version":"2.7.2"},{"clusterNodeState":{"_text":"inactive","severity":1},"componentState":{"_text":"operational","severity":0},"connectionState":{"_text":"established","severity":0},"controllerConnectionStates":[{"role":"PRIMARY","state":{"_text":"established","severity":0}},{"role":"BACKUP","state":{"_text":"established","severity":0}}],"current":false,"host":"localhost","id":1,"instanceId":"joc#1","isApiServer":false,"lastHeartbeat":"2024-09-23T10:07:12Z","memberId":"localhost:97c88ccc3975703ebd0b7277d394ec8768f88b31775e8df038572d2547c240a0","os":{"architecture":"amd64","distribution":"3.10.0-957.1.3.el7.x86_64","name":"Linux"},"securityLevel":"MEDIUM","startedAt":"2024-09-20T15:50:40Z","title":"SECONDARY JOC COCKPIT","url":"http://localhost:4446","version":"2.7.2"}]}

# reads severity from response
echo "$response" | jq -r '.clusterState.severity // empty'
echo "$response" | jq -r '.controllers[0].componentState.severity // empty'
echo "$response" | jq -r '.controllers[0].connectionState.severity // empty'
echo "$response" | jq -r '.controllers[1].componentState.severity // empty'
echo "$response" | jq -r '.controllers[1].connectionState.severity // empty'
echo "$response" | jq -r '.jocs[0].componentState.severity // empty'
echo "$response" | jq -r '.jocs[0].connectionState.severity // empty'
echo "$response" | jq -r '.jocs[0].version // empty'
echo "$response" | jq -r '.database.componentState.severity // empty'
echo "$response" | jq -r '.database.connectionState.severity // empty'

Code Block

language	bash
title	Examples for Getting Agent Status Information
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get status information for indicated Standalone Agents
response=$(./operate-joc.sh status-agent "${request_options[@]}" --controller-id=controller --agent-id=agent_001,agent_002)

# returns response
{"agents":[{"agentId":"agent_001","agentName":"primaryAgent","controllerId":"testsuite","disabled":false,"healthState":{"_text":"ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED","severity":0},"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"url":"https://agent-2-0-primary:4443","version":"2.7.2-SNAPSHOT"},{"agentId":"agent_002","agentName":"secondaryAgent","controllerId":"testsuite","disabled":false,"healthState":{"_text":"ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED","severity":0},"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"url":"https://agent-2-0-secondary:4443","version":"2.7.2-SNAPSHOT"}],"deliveryDate":"2024-11-11T18:45:28.855Z","surveyDate":"2024-11-11T18:45:06.798Z"}

# read severity from response
echo "$response" | jq -r '.agents[0].state.severity // empty'


# get status information for Agent Cluster
response=$(./operate-joc.sh status-agent "${request_options[@]}" --controller-id=controller --agent-cluster)

# returns response
{"agents":[{"agentId":"agent_cluster_001","agentName":"AgentCluster001","clusterState":{"_text":"ClusterCoupled","severity":0},"controllerId":"testsuite","healthState":{"_text":"ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED","severity":0},"runningTasks":0,"subagents":[{"agentId":"agent_cluster_001","disabled":false,"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"subagentId":"director_primary_001","url":"https://diragent-2-0-primary:4443","version":"2.7.2-SNAPSHOT","clusterNodeState":{"_text":"active","severity":0},"isDirector":"PRIMARY_DIRECTOR"},{"agentId":"agent_cluster_001","disabled":false,"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"subagentId":"director_secondary_001","url":"https://diragent-2-0-secondary:4443","version":"2.7.2-SNAPSHOT","clusterNodeState":{"_text":"inactive","severity":1},"isDirector":"SECONDARY_DIRECTOR"},{"agentId":"agent_cluster_001","disabled":false,"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"subagentId":"subagent_primary_001","url":"https://subagent-2-0-primary:4443","version":"2.7.2-SNAPSHOT","isDirector":"NO_DIRECTOR"},{"agentId":"agent_cluster_001","disabled":false,"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"subagentId":"subagent_secondary_001","url":"https://subagent-2-0-secondary:4443","version":"2.7.2-SNAPSHOT","isDirector":"NO_DIRECTOR"},{"agentId":"agent_cluster_001","disabled":false,"runningTasks":0,"state":{"_text":"COUPLED","severity":0},"subagentId":"subagent_third_001","url":"https://subagent-2-0-third:4443","version":"2.7.2-SNAPSHOT","isDirector":"NO_DIRECTOR"}]}]}

# reads cluster state from status information
echo "$response" | jq -r '.agents[0].clusterState.severity // empty'

# reads Primary and Secondary Director Agent component state
echo "$response" | jq -r '.agents[0].subagents[0].state.severity // empty'
echo "$response" | jq -r '.agents[0].subagents[1].state.severity // empty'

# reads Primary and Secondary Director Agent cluster node state
echo "$response" | jq -r '.agents[0].subagents[0].clusterNodeState.severity // empty'
echo "$response" | jq -r '.agents[0].subagents[1].clusterNodeState.severity // empty'

Anchor
#examples_health_checks
#examples_health_checks
Performing Health Checks

Code Block

language	bash
title	Examples for performing Health Checks
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# perform health check for JOC Cockpit, Controller and Agents
./operate-joc.sh health-check "${request_options[@]}" --controller-id=controller

# log output of the command can look like this with 2 Agents not being available
Database: MySQL 5.7.33
    Component State    : operational (0)
    Connection State   : established (0)
JOC Cockpit: PRIMARY JOC COCKPIT, URL: https://joc-2-0-primary.sos:7443, Date: 2024-11-11T15:11:01.19Z
    Cluster Node State: active (0)
    Component State:    operational (0)
    Connection State:   established (0)
JOC Cockpit: SECONDARY JOC COCKPIT, URL: http://centostest_primary.sos:7546, Date: 2024-11-11T15:11:01.19Z
    Cluster Node State: inactive (1)
    Component State:    operational (0)
    Connection State:   established (0)
JOC Cockpit Cluster State: ClusterCoupled (0)
PRIMARY Controller: PRIMARY CONTROLLER, ID: testsuite, URL: https://controller-2-0-primary:4443, is coupled: true, Date: 2024-11-11T15:11:01.186Z
    Cluster Node State: inactive (1)
    Component State:    operational (0)
    Connection State:   established (0)
BACKUP Controller: SECONDARY CONTROLLER, ID: testsuite, URL: https://controller-2-0-secondary:4443, is coupled: true, Date: 2024-11-11T15:11:01.158Z
    Cluster Node State: active (0)
    Component State:    operational (0)
    Connection State:   established (0)
STANDALONE Agent: primaryAgent, ID: agent_001, URL: https://agent-2-0-primary:4443, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z
    Component State:    COUPLED (0)
STANDALONE Agent: apmaccsAgent, ID: agent_005, URL: http://192.11.3.3:4449, Controller ID: testsuite, Disabled: true, Date: 2024-11-11T15:11:01.111Z
    Component State:    UNKNOWN (2)
[WARN] Fatal Component State: UNKNOWN (2)
STANDALONE Agent: apmacwinAgent, ID: agent_006, URL: http://192.11.2.2:4245, Controller ID: testsuite, Disabled: true, Date: 2024-11-11T15:11:01.111Z
    Component State:    UNKNOWN (2)
[WARN] Fatal Component State: UNKNOWN (2)
CLUSTER Agent: AgentCluster001, ID: agent_cluster_001, Controller ID: testsuite, Date: 2024-11-11T15:11:01.111Z
  PRIMARY DIRECTOR:     Subagent ID: director_primary_001, URL: https://diragent-2-0-primary:4443
    Cluster Node State: active (0)
    Component State:    COUPLED (0)
  SECONDARY DIRECTOR:   Subagent ID: director_secondary_001, URL: https://diragent-2-0-secondary:4443
    Cluster Node State: inactive (1)
    Component State:    COUPLED (0)
STANDALONE Agent: secondaryAgent, ID: agent_002, URL: https://agent-2-0-secondary:4443, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z
    Component State:    COUPLED (0)
STANDALONE Agent: oracleAgent, ID: agent_010, URL: http://minos.sos:4445, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z
    Component State:    COUPLED (0)
STANDALONE Agent: testAgent, ID: agent_011, URL: http://centostest_primary.sos:7775, Controller ID: testsuite, Disabled:

Code Block

language	bash
title	Examples for performing Health Checks
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# perform health check for JOC Cockpit, Controller and Agents
./operate-joc.sh health-check "${request_options[@]}" --controller-id=controller

# Log output of the command can look like this with 2 Agents not being available
Database: MySQL 5.7.33
    Component State    : operational (0)
    Connection State   : established (0)
JOC Cockpit: PRIMARY JOC COCKPIT, URL: https://joc-2-0-primary.sos:7443, Date: 2024-11-11T15:11:01.19Z111Z
    ClusterComponent Node State: active   COUPLED (0)
STANDALONE Agent: wintestAgent, ID: agent_021, URL:  Component State:    operational (0)http://192.11.0.146:4445, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z
    ConnectionComponent State:    establishedCOUPLED (0)
JOCSTANDALONE CockpitAgent: SECONDARYwinutf8Agent, JOC COCKPITID: agent_022, URL: http://centostest_primary.sos:7546192.11.0.146:4245, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.19Z111Z
    Cluster Node State: inactive (1)
    Component State:    operationalCOUPLED (0)
[ERROR] health check identified Connection2 State:   established (0)
JOC Cockpit Cluster State: ClusterCoupled (0)
PRIMARY Controller: PRIMARY CONTROLLER, ID: testsuite, URL: https://controller-2-0-primary:4443, is coupled: true, Date: 2024-11-11T15:11:01.186Z
    Cluster Node State: inactive (1)
    Component State:    operational (0)
    Connection State:   established (0)
BACKUP Controller: SECONDARY CONTROLLER, ID: testsuite, URL: https://controller-2-0-secondary:4443, is coupled: true,fatal problems

Code Block

language	bash
title	Examples for performing Health Checks for Host Shutdown Scenario
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# performs health check for JOC Cockpit, Controller and Agents assuming the shutdown of the Primary Controller's host
./operate-joc.sh health-check "${request_options[@]}" --controller-id=controller --agent-cluster --whatif-shutdown=controller-2-0-primary

Database: MySQL 5.7.33
    Component State    :  Date: 2024-11-11T15:11:01.158Z
    Cluster Node State: active (0)
    Component State:    operational (0)
    Connection State:   : established (0)
STANDALONEJOC Agent: primaryAgent, ID: agent_001Cockpit: PRIMARY JOC COCKPIT, URL: https://agentjoc-2-0-primary:4443, Controller ID: testsuite, Disabled: , .sos:7443, Date: 2024-11-11T15:1116:0141.111Z664Z
    Cluster ComponentNode State:   active COUPLED (0)
STANDALONE Agent: apmaccsAgent, ID: agent_005, URL: http://192.11.3.3:4449, Controller ID: testsuite, Disabled: true, Date: 2024-11-11T15:11:01.111Z Component State:    operational (0)
    ComponentConnection State:   established UNKNOWN (20)
[WARN] Fatal Component State: UNKNOWN (2)
STANDALONE Agent: apmacwinAgent, ID: agent_006    What if host is shutdown: controller-2-0-primary: ok
JOC Cockpit: SECONDARY JOC COCKPIT, URL: http://192.11.2.2:4245, Controller ID: testsuite, Disabled: true, centostest_primary.sos:7546, Date: 2024-11-11T15:1116:01.111Z41.664Z
    Cluster Node State: inactive (1)
    Component State:    UNKNOWNoperational (20)
[WARN]   Fatal ComponentConnection State:   UNKNOWNestablished (20)
CLUSTER Agent: AgentCluster001, ID: agent_cluster_001, Controller ID: testsuite, Date: 2024-11-11T15:11:01.111Z
  PRIMARY DIRECTOR:     Subagent ID: director_primary_001 What if host is shutdown: controller-2-0-primary: ok
JOC Cockpit Cluster State: ClusterCoupled (0)
PRIMARY Controller: PRIMARY CONTROLLER, ID: testsuite, URL: https://diragentcontroller-2-0-primary:4443, is coupled: true, Date: 2024-11-11T15:16:41.659Z
    Cluster Node State: activeinactive (01)
    Component State:    COUPLEDoperational (0)
  SECONDARY DIRECTOR:  Connection Subagent IDState: director_secondary_001, URL: https://diragent-2-0-secondary:4443
    Cluster Node State: inactive (1 established (0)
    ComponentWhat State:if host is  COUPLED (0)
STANDALONE Agent: secondaryAgentshutdown: controller-2-0-primary: ok
BACKUP Controller: SECONDARY CONTROLLER, ID: agent_002testsuite, URL: https://agentcontroller-2-0-secondary:4443, Controlleris IDcoupled: testsuitetrue, Disabled: , Date: 2024-11-11T15:1116:0141.111Z638Z
    Cluster ComponentNode State:    COUPLEDactive (0)
STANDALONE Agent: oracleAgent, ID: agent_010, URL: http://minos.sos:4445, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z Component State:    operational (0)
    ComponentConnection State:    COUPLEDestablished (0)
STANDALONE    What if host is shutdown: controller-2-0-primary: ok
CLUSTER Agent: testAgentAgentCluster001, ID: agent_011, URL: http://centostest_primary.sos:7775cluster_001, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z
  PRIMARY  Component StateDIRECTOR:    COUPLED (0)
STANDALONE Agent: wintestAgent,  Subagent ID: agentdirector_primary_021001, URL: httphttps://192.11.0.146:4445, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Zdiragent-2-0-primary:4443
    Cluster Node State: active (0)
    Component State:    COUPLED (0)
STANDALONE  SECONDARY AgentDIRECTOR: winutf8Agent,  Subagent ID: agentdirector_secondary_022001, URL: httphttps://192.11.0.146:4245, Controller ID: testsuite, Disabled: , Date: 2024-11-11T15:11:01.111Z
    Componentdiragent-2-0-secondary:4443
    Cluster Node State: inactive   COUPLED (01)
[ERROR] health check identified 2 fatal problems


# perform health check for JOC Cockpit, Controller and specific Agents
./operate-joc.sh health-check "${request_options[@]}" --controller-id=controller --agent=primaryAgent,secondaryAgent

Code Block

language	bash
title	Examples for performing Health Checks for Outage Scenario
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# performComponent State:    COUPLED (0)
  What if host is shutdown: controller-2-0-primary: ok
health check identified no problem if host is shutdown: controller-2-0-primary


# performs health check for JOC Cockpit, Controller and Agents assuming the outageshutdown of the Primary Controller's and Secondary Director Agent host
./bin/operate-joc.sh health-check "${request_options[@]}" --controller-id=controllertestsuite --agent-cluster --whatif-shutdown=controllerdiragent-2-0-primary,diragent-2-0-secondary

Database: MySQL 5.7.33
    Component State    : operational (0)
    Connection State   : established (0)
JOC Cockpit: PRIMARY JOC COCKPIT, URL: https://joc-2-0-primary.sos:7443, Date: 2024-11-11T1511T20:1645:4133.664Z983Z
    Cluster Node State: activeinactive (01)
    Component State:    operational (0)
    Connection State:   established (0)
    What if host is shutdown: controllerdiragent-2-0-primary,diragent-2-0-secondary: ok
JOC Cockpit: SECONDARY JOC COCKPIT, URL: http://centostest_primary.sos:7546, Date: 2024-11-11T1511T20:1645:4133.664Z983Z
    Cluster Node State: inactiveactive (10)
    Component State:    operational (0)
    Connection State:   established (0)
    What if host is shutdown: controllerdiragent-2-0-primary,diragent-2-0-secondary: ok
JOC Cockpit Cluster State: ClusterCoupled (0)
PRIMARY Controller: PRIMARY CONTROLLER, ID: testsuite, URL: https://controller-2-0-primary:4443, is coupled: true, Date: 2024-11-11T1511T20:1645:4133.659Z978Z
    Cluster Node State: inactive (1)
    Component State:    operational (0)
    Connection State:   established (0)
    What if host is shutdown: controllerdiragent-2-0-primary,diragent-2-0-secondary: ok
BACKUP Controller: SECONDARY CONTROLLER, ID: testsuite, URL: https://controller-2-0-secondary:4443, is coupled: true, Date: 2024-11-11T1511T20:1645:4133.638Z958Z
    Cluster Node State: active (0)
    Component State:    operational (0)
    Connection State:   established (0)
    What if host is shutdown: controllerdiragent-2-0-primary,diragent-2-0-secondary: ok
CLUSTER Agent: AgentCluster001, ID: agent_cluster_001, Controller ID: testsuite, Date:
  PRIMARY DIRECTOR:     Subagent ID: director_primary_001, URL: https://diragent-2-0-primary:4443
    Cluster Node State: active (0)
    Component State:    COUPLED (0)
  SECONDARY DIRECTOR:   Subagent ID: director_secondary_001, URL: https://diragent-2-0-secondary:4443
    Cluster Node State: inactive (1)
    Component State:    COUPLED (0)
 [WARN] What if host is shutdown: controllerdiragent-2-0-primary,diragent-2-0-secondary: okfailure
[ERROR] health check identified no1 problemproblems if host is shutdown: controllerdiragent-2-0-primary,diragent-2-0-secondary

Getting Version Information

Code Block

language	bash
title	Examples for Getting Version Information
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get JOC Cockpit version
./operate-joc.sh version "${request_options[@]}"
# returns
2.7.2

# get Controller version
./operate-joc.sh version "${request_options[@]}" --controller-id=controller
# returns
2.7.2

# get Standalone Agent version
./operate-joc.sh version "${request_options[@]}" --agent-id=StandaloneAgent
# returns
2.7.2

# get Agent Cluster version
./operate-joc.sh version "${request_options[@]}" --agent-id=AgentCluster
# returns
2.7.2

# get version of specific Controller and of all Agents in Agent Cluster
response=$(./operate-joc.sh version "${request_options[@]}" --controller-id=controller --agent-id=AgentCluster --json)
# returns response
{
  "agentVersions":[
    {"agentId":"AgentCluster","compatibility":"COMPATIBLE","uri":"https://diragent-2-0-primary:4443","version":"2.7.2"},
    {"agentId":"AgentCluster","compatibility":"COMPATIBLE","subagentId":"director_primary_001","uri":"https://diragent-2-0-primary:4443","version":"2.7.2"},
    {"agentId":"AgentCluster","compatibility":"COMPATIBLE","subagentId":"director_secondary_001","uri":"https://diragent-2-0-secondary:4443","version":"2.7.2"},
    {"agentId":"AgentCluster","compatibility":"COMPATIBLE","subagentId":"subagent_primary_001","uri":"https://subagent-2-0-primary:4443","version":"2.7.2"},
    {"agentId":"AgentCluster","compatibility":"COMPATIBLE","subagentId":"subagent_secondary_001","uri":"https://subagent-2-0-secondary:4443","version":"2.7.2"},
    {"agentId":"AgentCluster","compatibility":"COMPATIBLE","subagentId":"subagent_third_001","uri":"https://subagent-2-0-third:4443","version":"2.7.2"}
  ],
  "controllerVersions":[
    {"compatibility":"COMPATIBLE","controllerId":"controller","uri":"https://controller-2-0-standalone:4443","version":"2.7.2"}
  ],
  "jocVersion":"2.7.2"
}
# getread version of specifc Agent
echo "$response" | jq -r '.agentVersions[] | select(.subagentId == "director_primary_001") | .version // empty'

...

Code Block

language	bash
title	Example Examples for Restarting and Running Services
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# restart proxy service
./operate-joc.sh restart-service "${request_options[@]}" --proxies

# restart service: cluster, history, dailyplan, cleanup, monitor
./operate-joc.sh restart-service "${request_options[@]}" --service-type=history

# run service: dailyplan, cleanup
./operate-joc.sh run-service "${request_options[@]}" --service-type=cleanup

...

Code Block

language	bash
title	Example for Getting and Storing Settings
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get settings
settings=$(./operate-joc.sh get-settings "${request_options[@]}")

# update settings
settings=$(echo "$settings" | jq '.dailyplan.days_ahead_submit.value = "4"')
settings=$(echo "$settings" | jq '.dailyplan.days_ahead_plan.value = "6"')

# store settings
./operate-joc.sh store-settings "${request_options[@]}" --settings="$settings"

...

Using encrypted Passwords

Secrets can be encrypted and decrypted as explaind with JS7 - Encryption and Decryption.
Encryption/decryption require related Java libraries that are available from the ./lib sub-directory.
For creation of a Private Key and Certificate see find details from JS7 - How to create X.509 Encryption Keys.

Code Block

language	bash
title	Example for Encrypting and DecryptingUse of encrypted Password
linenumbers	true

# create Private Key
openssl ecparam -name secp384r1 -genkey -noout -out encrypt.key

# create Certificate Signing Request, adjust the subject to your needs
openssl req -new -sha512 -nodes -key encrypt.key -out encrypt.csr -subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=Encrypt"

# create Certificatecreate Certificate, adjust the validity period to your needs
openssl x509 -req -sha512 -days 1825 -signkey encrypt.key -in encrypt.csr -out encrypt.crt -extfile <(printf "keyUsage=critical,keyEncipherment,keyAgreement\n")


# encrypt athe secret such as a passwordpassword "root" using the Certificate, the encryption result will be returned and will look like: : enc:BEXbHYa...
MY_JS7_PASSWORD=$(./operate-joc.sh encrypt --in="root" --cert=encrypt.crt)

# store the environment variable to your profile ($HOME/.bash_profile or similar) to make the encrypted password available to the shell
# export MY_JS7_PASSWORD=enc:BEXbHYa...
./operate-joc.sh encrypt --in="root" --cert=encrypt.crt

# options for connection to the JS7 REST API can specify the encryption result as password and the Private Key for decryption
request_options=(--url=http://localhost:4446 --user=root --password="enc:BEXbHYa...$MY_JS7_PASSWORD" --key=encrypt.key --controller-id=controller)

# for example, when gettingreading version information, the Private Key is used to decrypt the password on-the-fly for access to the REST API on-the-fly
./operate-joc.sh version "${request_options[@]}"

# decrypt an encrypted secret using the Private Key
./operate-joc.sh decrypt --in="enc:BEXbHYa..." --key=encrypt.key

Resources

API
- JS7 - REST Web Service API
- JS7 - PowerShell Module
Workflow Deployment Operations
- JS7 - Unix Shell CLI for Workflow Deployment
Workflow Status Operations
- JS7 - Unix Shell CLI for Workflow Status Operations
Controller Deployment Operations
- JS7 - Unix Shell CLI for Controller Deployment
Controller Status Operations
- JS7 - Unix Shell CLI for Controller Status Operations
Identity Service Deployment Operations
- JS7 - Unix Shell CLI for Identity Service Deployment

Space shortcuts

Page tree

Versions Compared

Old Version 23

New Version Current

Key

Anchor
#examples_health_checks
#examples_health_checks
Performing Health Checks

Getting Version Information

Using encrypted Passwords

Resources

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 23

New Version Current

Key

Anchor#examples_health_checks#examples_health_checksPerforming Health Checks

Getting Version Information

Using encrypted Passwords

Resources

Anchor
#examples_health_checks
#examples_health_checks
Performing Health Checks