Page History

...

...

• status

  • Returns status information about JOC Cockpit & Controller 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	Severity
    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	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)

    
    

    
    

• status-agent

  • 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.
    • 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.
    • When used with the --agent-state option, allows to filter Agents by state.: COUPLED, RESETTING, RESET, INITIALISED, COUPLINGFAILED, SHUTDOWN, UNKNOWN. More than one Agent state can be specified separated by comma, for example: --agent-state=COUPLED,COUPLINGFAILED.
    • When used with the --agent-cluster switch, limits the scope to clustered Agents.
    • When used with the --no-hidden switch, limits the scope to Agents that are not hidden.
    • The health check will return exit code 0 for a healthy environment and exit 2 for an unhealthy envirornment.
  • 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 by comma, for example: --whatif-shutdown=host1.example.com,host2.example.com. The check implies to verify if the JS7 scheduling environment will remain operational in case that the given host or hosts will be shut down.
    • The check returns exit code 0 for an operational environment and exit code 3 for an 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, 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 background services. One of the following services can 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.

...