JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 37

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 38

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

  • 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 separated by comma, for example: --whatif-shutdown=host1.example.com,host2.example.com. The check implies verifying if the JS7 scheduling environment will remain operational in case that the given host or hosts will be shut down.
  • 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 proxy services when used with the --proxies switch.
    • Allows to restart JOC Cockpit background services. One of the following services 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.
  • report-daily-plan
    • Returns Daily Plan information about orders.
    • Users can filter results
      • by workflows, folders and recursive processing of sub-folders,
      • by specifying Daily Plan dates, for example use of the --date-from="2024-12-09" --date-to="2024-12-09" options limits results to the given Daily Plan date range,
      • by tags, for example using the --tag=ScheduledExecution,MutualExclusion option for workflows and the --order-tag=Important,Critical option for orders,
      • by specifying one or more Daily Plan order states, for example using --state=PLANNED,SUBMITTED.
    • Results are returned in JSON format. Users can specify the --csv switch to receive output in CSV format.
  • report-order-history
    • Returns history order information.
    • Users can filter results
      • by workflows, folders and recursive processing of sub-folders, 
      • by specifying the order history's date range, for example --date-from="2024-12-09 08:00:00" --date-to="2024-12-09 14:00:00" will limit results to a period of 6 hours on the given day.
        • If dates are not specified in the UTC time zone, then users can indicate the applicable time zone using for example the  --time-zone=Europe/London option.
        • The following examples for Unix using bash shell calculate the UTC date independently from the machine's time zone for a date range:
          • begin of current day: --date-from="$(TZ=Etc/UTC;date +'%Y-%m-%d 00:00:00')"
          • begin of previous day: --date-from="$(TZ=Etc/UTC;date --date="1 day ago" +'%Y-%m-%d 00:00:00')"
          • begin of next day: --date-to="$(TZ=Etc/UTC;date --date="+1 day" +'%Y-%m-%d 00:00:00')"
      • by specifying tags similar to the report-daily-plan command,
      • by specifying one or more history states, for example using --state=SUCCESSFUL,FAILED.
    • Results are returned in JSON format. Users can specify the --csv switch to receive output in CSV format.
  • report-task-history
    • Returns history information about job executions.
    • Users can filter results
      • by workflows, folders and recursive processing of sub-folders,
      • by specifying the task history's date range similar to use with the report-order-history command,
      • by specifying tags similar to the report-daily-plan command,
      • by specifying one or more history states, for example using --state=SUCCESSFUL,FAILED.
    • Results are returned in JSON format. Users can specify the --csv switch to receive output in CSV format.
  • 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.

...

  • --url
  • --user
    • Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the --client-cert and --client-key options then their common name (CN) attribute has to match the user account.
    • If a user account is specified then a password can be specified using the --password option or interactive keyboard input can be prompted using the -p switch.
  • --password
    • Specifies the password used for the account specified with the --user option for login to JOC Cockpit.
    • Password input from the command line is considered insecure.
      • Consider use of the -p switch offering a secure option for interactive keyboard input.
      • Consider use of the encrypt command to encrypt a password: ./operate-joc.sh encrypt --in=root --cert=encrypt.crt.
        • The encryption result will include the prefix enc: followed by the encrypted symmetric key, initialization vector and encrypted secret separated by space.
        • If an encrypted password is specified, then it will be decrypted using the Private Key file: ./operate-joc.sh <command> --password="enc:BF8J8KP7TPlxy..." --key=encrypt.key.
  • --ca-cert
    • Specifies the path to a file in PEM format 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 file in PEM format that holds the Client Certificate if HTTPS mutual authentication is used..
  • --client-key
    • Specifies the path to a file in PEM format that holds the Client Private Key if HTTPS mutual authentication is used..
  • --timeout
    • Specifies the maximum duration for requests to the JS7 REST Web Service. Default: 60 seconds.
  • --controller-id
    • Specifies the identification of the Controller.
  • --agent-id
    • The Agent ID specifies a unique identifier for a Standalone Agent or Agent Cluster that cannot be changed later on.
    • Agents are identified from their Agent ID.
  • --service-type
    • When used with the restart-service command, specifies the service that should be restarted.
    • One of the following services can be specified: cluster, history, dailyplan, cleanup, monitor
  • --validity-days
    • When used with the checck-license command, specifies the number of days before expiration of a JS7 license.
      • 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.
  • --settings
    • When used with the store-settings command, specifies settings from their JSON format.
  • --whatif-shutdown
  • --order-id
    • When used with the report-daily-plan command, a number of Order IDs can be specified separated by comma to limit results.
    • When used with the report-order-history command, a single Order ID can be specified to filter results. The Order ID can include wildcard characters:
      • * matching zero or more characters,
      • ? matching any single character.
  • --order-tag
    • When used with the report-* commands, specifies one or more order tags to limit results. Order tags are typically specified by schedules.
  • --workflow
    • When used with the report-* commands, specifies one or more workflows from their name to limit results.
  • --folder
    • When used with the report-* commands, specifies one or more folders holding workflows to limit results.
    • Use of the --recursive switch will include sub-folders.
  • --schedule
    • When used with the report-* commands, specifies one or more schedules from their name to limit results.
  • --schedule-folder
    • When used with the report-daily-plan command, specifies one or more folders holding schedules to limit results.
    • Use of the --recursive switch will include sub-folders.
  • --tag
    • When used with the report-* commands, specifies one or more worfklow tags to limit results.
  • --limit
    • When used with the report-order-history and report-task-history commands, limits the number of orders that will be returned.
  • --job
    • When used with the report-task-history command, filters jobs by name.
    • It is recommended to specify the --workflow or --folder option too to speed up querying the history.
  • --criticality
    • When used with the report-task-history command, filters jobs by the indicated critiicality.
    • One or more values can be specified for example using --criticality=minor,normal,major,critical.
  • --date-from
    • When used with the report-* commands, specifies the date starting from which history entries will be returned.
    • The report-daily-plan command command allows to specifiy specify the Daily Pl.an date. The report-order-history and report-task-history commands allow to specify date and time.
  • --date-to
    • When used with the report-* commands, specifies the date until which history entries results will be returned.
    • Values are specified similarly to use of the --date-from option.
  • --date-from-completed
    • When used with the report-order-history and report-task-history commands, specifies the date starting from which orders/tasks are required to be completed.
    • Values are specified similarly to use of the --date-from option.
  • --date-to-completed
    • When used with the report-order-history and report-task-history commands, specifies the date until which orders/tasks are required to be completed.
    • Values are specified similarly to use of the --date-from option.
  • --time-zone
    • Specifies the applicable time zone for values of the --date-from, --date-to, --date-from-completed and --date-to-completed options. Default: Etc/UTC.
  • --state
    • When used with the report-* commands, offers to limit results to orders holding the following states:
      • report-daily-plan:    --state=PLANNED,SUBMITTED,FINISHED
      • report-order-history: --state=SUCCESSFUL,FAILED,INCOMPLETE
      • report-task-history:  --state=SUCCESSFUL,FAILED,INCOMPLETE
  • --key
    • When used with the decrypt command, specifies the path to a file that holds the Private Key in PEM format used for decryption.
  • --cert
    • When used with the encrypt command, specifies the path to a file that holds the CA-signed or self-signed X.509 Certificate. Alternatively, the path to a file holding the Public Key can be specified. The Certificate/Public Key is expected in PEM format.
    • For encryption the Certificate/Public Key must match the Private Key used for later decryption specified with the --key option.
  • --key-password
    • When used with the decrypt command, specifies the password for access to the key file using the --key option.
    • Password input from the command line is considered insecure.
      • Consider use of the -k switch or more elaborate mechanisms, for example by temporarily populating the system keystore form a security key such as a YubiKey® or similar.
      • Consider use of encrypted passwords as explained with the --password option.
  • --in
    • When used with the encrypt and decrypt commands, specifies the input value that should be encrypted or decrypted.,
    • One of the options --in or --infile can be specified.
  • --infile
    • When used with the encrypt and decrypt commands, specifies the path to the input file that should be encrypted/decrypted.
    • One of the options --in or --infile can be specified. This option requires use of the --outfile option.
  • --outfile
    • When used with the encrypt command, specifies the path to the output file that will be created holding the encrypted content of the input file.
    • When used with the decrypt command, specifies the path to the output file that will be created holding the decrypted content of the input file.
    • The option is required if the --infile option is specified
  • --java-home
    • When used with the encrypt and decrypt commands or with encrypted passwords, specifies the Java home directory. By default the JAVA_HOME environment variable is used to determine the location of Java.
    • The Java home directory is the top-level directory of a Java installation. The directory includes the bin sub-directory and java executable.
  • --java-lib
    • When used with the encrypt and decrypt commands or with encrypted passwords, a number of Java libraries are required to perform encryption/decryption.
    • The Java libraries are expected in the lib sub-directory of the JS7 Unix Shell CLI. Default: ./lib.
  • --audit-message
    • Specifies a message that is made available to the Audit Log.
    • Specification of Audit Log messages can be enforced on a per user basis and for a JS7 environment.
  • --audit-time-spent
    • Specifies the time spent to perform an operation which is added to the Audit Log.
    • The option can be specified if the --audit-message option is used.
  • --audit-link
    • Specifies a link (URL) which is added to the Audit Log.
    • The option can be specified if the --audit-message option 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: operate-joc.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
    • For example: operate-joc.2022-03-19T20-50-45.log

...