Page History
...
Operation | Object | Documentation | |
---|---|---|---|
terminate / restart | Standalone Controller Controller InstanceCluster | ||
cancel / restart | |||
check | |||
switch-over | Controller Cluster | ||
appoint-nodes | |||
confirm-loss | |||
enable / disable | Standalone Agent Instance | ||
reset / reset force | |||
switch-over | Agent Cluster | reset / reset force||
confirm-loss | |||
reset | |||
enable / disable | Subagent | ||
reset / reset force |
The script is offered for download and can be applied for frequently used status operations:
...
jq ships with the MIT license, see https://opensource.org/licenses/MIT.
Download
Download: operate-controller.sh
Usage
Invoking the script without arguments displays the usage clause:
...
Code Block | ||
---|---|---|
| ||
Usage: deployoperate-workflowcontroller.sh [Command] [Options] [Switches] Commands: exportterminate --file [--format] --path --type controller-id [--usecontroller-short-pathurl] [--start-folder] [--for-signing] switch-over] ..restart --controller-fileid [--formatcontroller-url] --folder [--recursive] [--type] [--use-short-path] [--for-signing]]switch-over] cancel --controller-id [--controller-url] cancel-restart [--nocontroller-draft]id [--nocontroller-deployedurl] [--no-released] [--no-invalid] switch-over import --controller-id appoint-nodes --file [--format] [--folder] [--overwrite] [--prefix] [--suffix]controller-id importconfirm-deployloss --file [--format] [--folder] [--algorithm]controller-id deploycheck --path --type [--date-from] [--nocontroller-draft]id [--nocontroller-deployed]url .. enable-agent --folder [--recursive] [--date-from] [--no-draft] [--no-deployed]--controller-id --agent-id revokedisable-agent --controller-pathid --typeagent-id ..reset-agent --folder--controller-id --agent-id [--recursiveforce] release switch-over-agent --controller-id --agent-id confirm-loss-agent --path controller--typeid [--dateagent-from]id ..enable-subagent --controller-id --subagent-id disable-subagent --folder [--recursive] [controller-id --datesubagent-from]id recallreset-subagent --path --type .. --controller-id --subagent-id [--force] Options: --url=<url> --folder [--recursive] store | required: JOC Cockpit URL --path --type --file user=<account> remove --path --type [--date-from] .. | required: JOC Cockpit user account --password=<password> --folder [--date-from] restore | optional: JOC Cockpit password --ca-cert=<path> --path --type --new-path [--prefix] [--suffix] .. | optional: path to CA Certificate used for JOC Cockpit login --folder --new-path [--prefix] [--suffix] client-cert=<path> delete | optional: --path --type to Client Certificate used ..for login --client-key=<path> --folder revalidate | optional: path to Client Key used --folder [--recursive] Options: for login --urltimeout=<url><seconds> | optional: timeout for | required: JOC Cockpit URLrequest, default: 60 --controller-id=<id[,id]><id> | required: Controller ID --usercontroller-url=<account><url> | optional: Controller URL for | required: JOC Cockpit user accountconnection test --password=<password>agent-id=<id[,id]> | optional: JOCAgent Cockpit passwordIDs --casubagent-cert=<path> id=<id[,id]> | optional: path to CA Certificate used for JOC Cockpit loginSubagent ID --clientaudit-cert=<path> message=<string> | optional: pathaudit to Client Certificate used for loginlog message --audit-clienttime-keyspent=<path><number> | optional: pathaudit tolog Clienttime Keyspent usedin for loginminutes --timeout=<seconds>audit-link=<url> | optional: timeoutaudit for request, default: 60log link --log-file=<path> dir=<directory> | optional: path to exportdirectory fileholding orthe import file --format=<ZIP|TAR_GZ>script's log files Switches: -h | --help | optional: format of export file or import file --folder=<folder[,folder]> | displays usage -v | optional:--verbose list of inventory folders holding objects --start-folder=<folder> | optional:displays startverbose folderoutput, forrepeat exportto withincrease relative pathsverbosity --path=<path[,path]>p | --password | optional: list of inventory| pathsasks tofor objectspassword --type=<type[,type]>o | --switch-over | optional: list of object types such as WORKFLOW,SCHEDDULEswitches over the active role to the standby instance -f | -new-path=<path>force | optional: new object path | forces reset on restoreAgent --prefix=<string>show-logs | optional: prefix for duplicate objects on| import shows log output if --suffix=<string> log-dir is used --make-dirs | optional: suffix for duplicate objects on import --algorithm=<identifier> | creates directories if they do not | optional: signature algorithm for import, default: SHA512withECDSA --date-from=<date> | optional: update daily plan start date for deploy/release operation --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 -r | --recursive | specifies folders to be looked up recursively -o | --overwrite | overwrites objects on import -s | --for-signing | exports objects for digital signing -u | --use-short-path | exports relative paths --no-draft | excludes draft objects --no-deployed | excludes deployed objects --no-released | excludes released objects --no-invalid | excludes invalid objects --show-logs | shows log output if --log-dir is used --make-dirs | creates directories if they do not exist |
...
exist
see https://kb.sos-berlin.com/x/9YZvCQ |
Anchor | ||||
---|---|---|---|---|
|
terminate
- Allows to export objects such as workflows to an archive file in .zip or .tar.gz format. The command comes in two flavors:
- export individual objects specified by the
--path
and--type
options.- Should relative paths be used in the archive file then the
--start-folder
option and--use-short-path
switch can be applied.
- Should relative paths be used in the archive file then the
- export objects from folders using the
--folder
option and--recursive
switch.- Optionally one or more object types can be specified and otherwise all objects will be exported, see
--type
option. - Should relative paths be used in the archive file then the
--use-short-path
switch can be applied. - Export of objects can further be limited by use of the
--no-*
switches, see section Switches.
- Optionally one or more object types can be specified and otherwise all objects will be exported, see
- export individual objects specified by the
- The archive file is specified from the
--file
and--format
options. - If JOC Cockpit is operated for the High Security Level then the
--for-signing
switch can be used to export Controller Objects that should be digitally signed. Objects and signatures can be imported using theimport-deploy
command.
- Allows to export objects such as workflows to an archive file in .zip or .tar.gz format. The command comes in two flavors:
restart
- Imports an archive file to the inventory. The operation applies to use of JOC Cockpit with the Low and Medium Security Level.
- Users can specify if existing objects will be overwritten or if duplicate objects from the import file will be assigned a prefix or suffix or will be ignored.
- cancel
- Imports an archive file to the inventory and deploys the included objects. The operation is applicable if JOC Cockpit is operated for the High Security Level.
- As a prerequisite the archive file must be exported using the
--for-signing
switch. - Workflows and Job Resources from the archive file are digitally signed by the user. Signature files are added to the archive file.
- As a prerequisite the archive file must be exported using the
- On import the objects in the archive file are deployed to related Controllers as specified during export.
- Imports an archive file to the inventory and deploys the included objects. The operation is applicable if JOC Cockpit is operated for the High Security Level.
cancel-restart
- Allows to deploy Controller Objects such as workflows. The command can be used in two flavors:
- deploy individual objects specified by the
--path
and--type
options. - deploy objects from folders using the
--folder
option and--recursive
switch.
- deploy individual objects specified by the
- Deploying objects forwards them to Controllers and Agents.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
- Allows to deploy Controller Objects such as workflows. The command can be used in two flavors:
switch-over
- Allows to undeploy Controller Objects such as workflows. The command can be used in two flavors:
- revoke individual objects specified by the
--path
and--type
options. - revoke objects from folders using the
--folder
option and--recursive
switch.
- revoke individual objects specified by the
- Revoking Controller objects deletes them from the Controller and Agents, objects remain in draft status in the inventory.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
- Allows to undeploy Controller Objects such as workflows. The command can be used in two flavors:
appoint-nodes
- Allows to release Automation Objects such as schedules. The command can be used in two flavors:
- release
export
- Allows to export objects such as workflows to an archive file in .zip or .tar.gz format. The command comes in two flavors:
- export individual objects specified by the
--path
and--type
options. - Should relative paths be used in the archive file then the --start-release objects from folders using the
--folder
option and--recursive
switch.
- export individual objects specified by the
- Releasing objects activates them for example for use -short-path switch can be applied.
- export objects from folders using the
--folder
option and--recursive
switch.- Optionally one or more object types can be specified and otherwise all objects will be exported, see
--type
option. - Should relative paths be used in the archive file then the
--use-short-path
switch can be applied. - Export of objects can further be limited by use of the
--no-*
switches, see section Switches.
- Optionally one or more object types can be specified and otherwise all objects will be exported, see
- Allows to release Automation Objects such as schedules. The command can be used in two flavors:
- The archive file is specified from the
--file
and--format
options. - If JOC Cockpit is operated for the High Security Level then the
--for-signing
switch can be used to export Controller Objects that should be digitally signed. Objects and signatures can be imported using theimport-deploy
command.
import
- Imports an archive file to the inventory. The operation applies to use of JOC Cockpit with the Low and Medium Security Level.
- Users can specify if existing objects will be overwritten or if duplicate objects from the import file will be assigned a prefix or suffix or will be ignored.
- Imports an archive file to the inventory and deploys the included objects. The operation is applicable if JOC Cockpit is operated for the High Security Level.
- As a prerequisite the archive file must be exported using the
--for-signing
switch. - Workflows and Job Resources from the archive file are digitally signed by the user. Signature files are added to the archive file.
- As a prerequisite the archive file must be exported using the
- On import the objects in the archive file are deployed to related Controllers as specified during export.
- by the Daily Plan.
confirm-loss
- Allows to unrelease Automation Objects such as schedules. The command can be used in two flavors:
- recall individual objects specified by the
--path
and--type
options. - recall objects from folders using the
--folder
option and--recursive
switch.
- recall individual objects specified by the
- Recalling objects deactivates them from further use, objects remain in draft status in the inventory.
check
- Allows to store an object such as a workflow or schedule from a file to the inventory.
- The
--file
option specifies the file that holds the JSON representation of an object. - The
--type
option specifies the object type. - The
--path
option specifies the folders and object name of the objects inventory location.
- The
- Objects are stored to the inventory in draft status and can be deployed or released using the related commands.
enable-agent
- Allows to remove objects such as workflows or schedules from the inventory. The command can be used in two flavors:
- remove individual objects specified by the
--path
and--type
options. - remove objects from folders recursively using the
--folder
option.
- remove individual objects specified by the
- Controller objects such as workflows are removed from the Controller and from the inventory. Automation objects such as schedules are removed from the inventory.
- Removing objects moves them to the trash from which they can be restored or deleted
disable-agent
- Allows to restore objects such as workflows or schedules from the trash
deploy
- Allows to deploy Controller Objects such as workflows. The command can be used in two flavors:
- deploy restore individual objects specified objects specified by the
--path
and--type
options. - deploy restore objects from folders recursively using the
--folder
option and--recursive
switch.
- deploy restore individual objects specified objects specified by the
- Deploying objects forwards them to Controllers and Agents.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
revoke
- .
- Restoring objects moves them from the trash to the inventory from which they can be deployed or released.
reset-agent
- Allows to delete objects such as workflows or schedules from the trash
- Allows to undeploy Controller Objects such as workflows. The command can be used in two flavors:
- revoke delete individual objects specified by the
--path
and--type
options. - revoke delete objects from folders recursively using the
--folder
option and--recursive
switch.
- revoke delete individual objects specified by the
- Revoking Controller objects deletes Deleting objects will permanently wipe them from the Controller and Agents, objects remain in draft status in the inventory.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
release
- trash.
switch-over-agent
- Allows to revalildate objects such as workflows or schedules from the inventory, for example after import
- Allows to release Automation Objects such as schedules. The command can be used in two flavors:
- release individual objects specified by the
--path
and--type
options. - release objects from folders using the
--folder
option and--recursive
switch.
- release individual objects specified by the
- Releasing objects activates them for example for use by the Daily Plan.
recall
- Allows to unrelease Automation Objects such as schedules. The command can be used in two flavors:
- recall individual objects specified by the
--path
and--type
options. - recall objects from folders using the
--folder
option and--recursive
switch.
- recall individual objects specified by the
- Recalling objects deactivates them from further use, objects remain in draft status in the inventory.
store
- Allows to store an object such as a workflow or schedule from a file to the inventory.
- The
--file
option specifies the file that holds the JSON representation of an object. - The
--type
option specifies the object type. - The
--path
option specifies the folders and object name of the objects inventory location.
- The
- Objects are stored to the inventory in draft status and can be deployed or released using the related commands.
remove
- Allows to remove objects such as workflows or schedules from the inventory. The command can be used in two flavors:
- remove individual objects specified by the
--path
and--type
options. - remove objects from folders recursively using the
--folder
option.
- remove individual objects specified by the
- Controller objects such as workflows are removed from the Controller and from the inventory. Automation objects such as schedules are removed from the inventory.
- Removing objects moves them to the trash from which they can be restored or deleted
restore
- Allows to restore objects such as workflows or schedules from the trash. The command can be used in two flavors:
- restore individual objects specified by the
--path
and--type
options. - restore objects from folders recursively using the
--folder
option.
- restore individual objects specified by the
- Restoring objects moves them from the trash to the inventory from which they can be deployed or released.
delete
- Allows to delete objects such as workflows or schedules from the trash. The command can be used in two flavors:
- delete individual objects specified by the
--path
and--type
options. - delete objects from folders recursively using the
--folder
option.
- delete individual objects specified by the
- Deleting objects will permanently wipe them from the trash.
revalidate
- Allows to revalildate objects such as workflows or schedules from the inventory, for example after import. The command can be used for inventory folders.
...
--url
- Specifies the URL by which JOC Cockpit is accessible using
<http|https>://<host>:<port>
. - Example: http://centostest-primary.sos:4446
- Example: https://centostest-primary.sos:4443
- Specifies the URL by which JOC Cockpit is accessible using
--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.
- Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the
--password
- Specifies the password used for the account specified with the
--user
option for login to JOC Cockpit. - Consider use of the
-p
switch offering a secure option for interactive keyboard input.
- Specifies the password used for the account specified with the
--controller-id
- Specifies the identification of the Controller that holds related orders.
- More than one Controller ID can be specified, separated by comma, for the
export
operation when using the--for-signing
switch.
--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.
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default:
--file
- Specifies the location of an archive file that is used with
export
,import
andimport-deploy
commands. - On export an existing archive file will be overwritten.
- Specifies the location of an archive file that is used with
--format
- Specifies the format of the archive file indicated with the
--file
option. - The format can be one of
ZIP
orTAR_GZ
. Default:ZIP
. The JS7 can process archive files in .zip format on Unix.
- Specifies the format of the archive file indicated with the
--folder
- Specifies the inventory folder used for the related operation.
- Folder specification starts from a
/
followed by one or more sub-folders. - More than one folder can be specified using comma as in
--folder=/ProductDemo/AgentCluster,/ProductDemo/ScheduledExecution
.
- Folder specification starts from a
- When used with the
import
andimport-deploy
commands, a single folder can be specified that is prepended the folders included with the archive file.
- Specifies the inventory folder used for the related operation.
--start-folder
- Specifies the inventory folder used for relative paths in archive files when using the
export
command with the--path
option, see--use-short-path
switch.
- Specifies the inventory folder used for relative paths in archive files when using the
--path
- Specifies the path of an object such as a workflow, job resource, schedule. A path starts from a /, optionally followed by a hierarchy of sub-folders, and the object name.
- Objects are identified from thier path and object type.
--type
- Specifies the object type such as a workflow or schedule that is indicated together with the
--path
option to identify an object.- Controller Object types include:
WORKFLOW,FILEORDERSOURCE,JOBRESOURCE,NOTICEBOARD,LOCK
- Automation Object types include:
SCHEDULE,WORKINGDAYSCALENDAR,NONWORKINGDAYSCALENDAR,JOBTEMPLATE,INCLUDESCRIPT,REPORT
- Controller Object types include:
- When used with the
export
command for folders then more than one object type can be specified separated by comma, for example--type=WORKFLOW,JOBRESOURCE
- Specifies the object type such as a workflow or schedule that is indicated together with the
--new-path
- When used with the
restore
command, the new path is specified to which the object will be restored in the inventory.
- When used with the
--prefix
- When used with the
import
command, a prefix can be specified that is prepended all objects that are imported. - If an object with the same name and prefix exists, then the object will not be imported.
- When used with the
--suffix
- When used with the
import
command, a suffix can be specified that is appended all objects that are imported. - If an object with the same name and suffix exists, then the object will not be imported.
- When used with the
--algorithm
- When used with the
import-deploy
command, the signature algorithm is specified that was used to digitally sign objects. Default:SHA512withECDSA
. - The algorithm name is made up of the hash algorithm name such as SHA256, SHA512 and the encryption type of the Private Key such as ECDSA or RSA.
- This offers to specify the following algorithm names:
SHA256withECDSA
,SHA256withRSA
,SHA512withECDSA
,SHA512withRSA
.
- When used with the
--date-from
- Specifies the date starting from which the Daily Plan will be updated:
- The
--date-from=now
option value specifies that the Daily Plan will be updated for orders starting from now. - The Daily Plan date in ISO date format can be specified, for example
--date-from=2023-10-23
. - If omitted then the Daily Plan will not be updated.
- The
- Orders in the Daily Plan can be updated for example if the underlying workflow or schedule is changed.
- Specifies the date starting from which the Daily Plan will be updated:
--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:
deploy-workflow.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example:
deploy-workflow.2022-03-19T20-50-45.log
...
-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>
.
- Asks the user for interactive keyboard input of the password used for the account specified with the
-r | --recursive
- Specifies that folders will be looked up recursively if the
--folder
option is used.
- Specifies that folders will be looked up recursively if the
-o | --overwrite
- Specifies that objects with the same name and type will be overwritten when used with the
import
command.
- Specifies that objects with the same name and type will be overwritten when used with the
-s | --for-signing
- Specifies that objects are exported for digital signing when used with the
export
command. For JS7 environments operated for the High Security Level digitally signed objects can be imported using theimport-deploy
command.
- Specifies that objects are exported for digital signing when used with the
-u | --use-short-path
- Specifies that relative object paths will be applied to archive files when used with the
export
command. - An object path
/a/b/c/workflow
will be added as/c/workflow
to the archive file. A folder/a/b/c
will be added as/c
to the archive file.
- Specifies that relative object paths will be applied to archive files when used with the
--no-draft
- Specifies that draft objects will be excluded when used with the
export
anddeploy
command.
- Specifies that draft objects will be excluded when used with the
--no-deployed
- Specifies that deployed objects will be excluded when used with the
export
anddeploy
command.
- Specifies that deployed objects will be excluded when used with the
--no-released
- Specifies that released objects will be excluded when used with the
export
command.
- Specifies that released objects will be excluded when used with the
--no-invalid
- Specifies that invalid objects will be excluded when used with the
export
command.
- Specifies that invalid objects will be excluded when used with the
--show-logs
- Displays the log output created by the script if the
--log-dir
option is used.
- Displays the log output created by the script if the
--make-dirs
- If directories are missing that are indicated with the
--log-dir
option then they will be created.
- If directories are missing that are indicated with the
...
0:
operation successful1
: argument errors3
: no objects found4
: JS7 REST Web Service is not reachable or reports errors
Examples
The following examples illustrate typical use cases.
Exporting Objects
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# export workflows
./deploy-workflow.sh export ${request_options[@]} \
--file=export.zip --path=/ap/ap3jobs,/ap/Agent/apRunAsUser --type=WORKFLOW
# export draft schedules
./deploy-workflow.sh export ${request_options[@]} \
--file=export.zip --path=/ap/Agent/apAgentSchedule01,/ap/Agent/apAgentSchedule02 --type=SCHEDULE --no-released
# export objects from folder
./deploy-workflow.sh export ${request_options[@]} \
--file=export.zip --folder=/ap --recursive
# export objects from folder using relative path
./deploy-workflow.sh export ${request_options[@]} \
--file=export.zip --folder=/ap/Agent --recursive --use-short-path
# export objects from folder, limiting object types and validity, feeding audit log
./deploy-workflow.sh export ${request_options[@]} \
--file=export.zip --folder=/ap --recursive --type=WORKFLOW,JOBRESOURCE --no-invalid --audit-message="export to production" |
Importing Objects
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# import objects
./deploy-workflow.sh import ${request_options[@]} \
--file=export.zip --overwrite
# import objects to a new top-level folder and apply suffix
./deploy-workflow.sh import ${request_options[@]} \
--file=export.zip --folder=/Version22 --suffix=v22
# revalidate objects from folder
./deploy-workflow.sh revalidate ${request_options[@]} \
--folder=/Version22 --recursive |
Exporting, Signing and Importing/Deploying for High Security Level
...
- Digital signing includes that based on the user's Private Key and Certificate signature files are created that have to be added to the archive file for later import & deployment.
- The steps to import and to deploy are available from a single operation to prevent tampering of objects after import.
- for inventory folders.
confirm-loss-agent
- A
enable-subagent
- A
disable-subagent
- A
reset-subagent
- A
Anchor | ||||
---|---|---|---|---|
|
--url
- Specifies the URL by which JOC Cockpit is accessible using
<http|https>://<host>:<port>
. - Example: http://centostest-primary.sos:4446
- Example: https://centostest-primary.sos:4443
- Specifies the URL by which JOC Cockpit is accessible using
--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.
- Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the
--password
- Specifies the password used for the account specified with the
--user
option for login to JOC Cockpit. - Consider use of the
-p
switch offering a secure option for interactive keyboard input.
- Specifies the password used for the account specified with the
--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.
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default:
--controller-id
- Specifies the identification of the Controller that holds related orders.
--controller-url
- When used with the
check
command, specifies the protocol, host and optionally port of the Controller instance to which the connection is tested. - When using the
terminate
,restart
,cancel
andcancel-restart
commands for a Controller Cluster, the Controller URL must be specified.
- When used with the
--agent-id
- The Agent ID specifies a unique identifier for a Standalone Agent or Agent Cluster. Agents are identified from their Agent ID.
--subagent-id
- The Subagent ID specifies a unique identifier for a Subagent in an Agent Cluster. Subagents are identified from their Subagent ID.
- When used with the
enable-subagent
,disable-subagent
andreset-subagent
commands, the option specifies the related Subagent.
--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:
deploy-workflow.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example:
deploy-workflow.2022-03-19T20-50-45.log
Anchor | ||||
---|---|---|---|---|
|
-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>
.
- Asks the user for interactive keyboard input of the password used for the account specified with the
-s | --switch-over
- Specifies that folders will be looked up recursively if the
--folder
option is used.
- Specifies that folders will be looked up recursively if the
-f | --force
- When used with the
reset-agent
command for a Standalone Agent or Cluster Agent, and when used with thereset-subagent
command for a Subagent, the option specifies that the Agent will terminate, will drop its journal and will restart. When resetting an Agent, any job processes running in the Agent will be forcibly terminated and orders will be set to the failed state. - The operation forces an Agent to be reiniitalized and to be dedicated to the current Controller. Users are recommended to double-check that an Agent is not dedicated to a different Controller before using the switch.
- When used with the
--show-logs
- Displays the log output created by the script if the
--log-dir
option is used.
- Displays the log output created by the script if the
--make-dirs
- If directories are missing that are indicated with the
--log-dir
option then they will be created.
- If directories are missing that are indicated with the
Anchor | ||||
---|---|---|---|---|
|
0:
operation successful1
: argument errors3
: no objects found4
: JS7 REST Web Service is not reachable or reports errors
Examples
The following examples illustrate typical use cases for status operations on Controller and Agents.
Terminating, Restarting, Cancelling Controllers
Termination and restart of a Controller instance are offered by a number of commands.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# terminate Standalone Controller
./operate-controller.sh terminate ${request_options[@]}
# restart Standalone Controller
./operate-controller.sh restart ${request_options[@]}
# cancel Standalone Controller
./operate-controller.sh cancel ${request_options[@]}
# cancel and restart Standalone Controller
./operate-controller.sh cancel-restart ${request_options[@]} |
When terminating/restarting a member in a Controller Cluster then --controller-url
option must be used to specify which Controller instance should be terminated/restarted.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# terminate Controller Cluster instance
./operate-controller.sh terminate ${request_options[@]} --controller-url=http://localhost:4444
# restart Controller Cluster instance
./operate-controller.sh restart ${request_options[@]} --controller-url=http://localhost:4444
# cancel Controller Cluster instance
./operate-controller.sh cancel ${request_options[@]} --controller-url=http://localhost:4444
# cancel and restart Controller Cluster instance
./operate-controller.sh cancel-restart ${request_options[@]} --controller-url=http://localhost:4444 |
Switching-over, Appointing Nodes and Confirming Node Loss for Controller Cluster
Users can switch-over the active role in a Controller Cluster. This is achieved by use of the switch-over
command and implicitly by use of the --switch-over
option with the terminate
and restart
commands.
The appoint-nodes
command is available in case that a Controller Cluster will not be coupled on initial operation.
The confirm-loss
command can be used in a situation when the active JOC Cockpit Cluster Watch was not available at the point in time of failure of the active Controller Cluster member. Users can confirm that the failed Controller Cluster member effectively is not running which allows the remaining Controller Cluster member to take the active role.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# switch-over active role in Controller Cluster
./operate-controller.sh switch-over ${request_options[@]}
# terminate Controller instance and switch-over Controller Cluster
./operate-controller.sh terminate ${request_options[@]} --controller-url=http://localhost:4444 --switch-over
# restart Controller instance and switch-over Controller Cluster
./operate-controller.sh restart ${request_options[@]} --controller-url=http://localhost:4444 --switch-over
# appoint nodes for Controller Cluster
./operate-controller.sh appoint-nodes ${request_options[@]}
# confirm node loss for Controller Cluster
./operate-controller.sh confirm-loss ${request_options[@]} |
Enabling, Disabling, Resetting Agents
When Agents are disabled,. they are not considered for job execution.
When an Agent is reset then the Agent will terminate and will restart. Job processes running in the Agent will be forcibly terminated and orders will be set to the failed state. When a forced reset is performed, then the operation forces an Agent to be reiniitalized, to drop its journal and to be dedicated to the current Controller. Users are recommended to double-check if an Agent is not dedicated to a different Controller before using the --force
switch.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# enable Standalone Agent
./operate-controller.sh enable-agent ${request_options[@]} --agent-id=StandaloneAgent
# disable Standalone Agent
./operate-controller.sh disable-agent ${request_options[@]} --agent-id=StandaloneAgent
# reset Standalone Agent
./operate-controller.sh reset-agent ${request_options[@]} --agent-id=StandaloneAgent
# reset/force Standalone Agent
./operate-controller.sh reset-agent |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# export objects from folder for signing
./deploy-workflow.sh export ${request_options[@]} \
--file=export.zip --folder=/myFolder --recursive --for-signing
# digitally sign objects
mkdir -p ./temp
rm -fr ./temp/*
unzip -d ./temp ./export.zip
./js7_sign_workflow.sh --dir=./temp --key=./ecdsa.key --cert=./ecdsa.crt --hash=sha512
rm -f ./import-from-signing.zip
cd ./temp
zip -r ../import-from-signing.zip *
cd -
# import/deploy objects
./deploy-workflow.sh import-deploy ${request_options[@]} \
--file=import-from-signing.zip |
Deploying and Revoking Objects
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)
# deploy workflows and update daily plan
./deploy-workflow.sh deploy ${request_options[@]} \
--path=/ap/ap3jobs,/ap/apEnv --type=WORKFLOW --date-from=now
# deploy objects from folder recursively and update daily plan
./deploy-workflow.sh deploy ${request_options[@]} \
--folder=/ap/Agent --recursive --date-from=now
# revoke workflows
./deploy-workflow.sh revoke ${request_options[@]} \
--path=/ap/ap3jobs,/ap/apEnv --type=WORKFLOW
# revoke objects from folder
./deploy-workflow.sh revoke ${request_options[@]} \
--folder=/ap/Agent --recursive |
Releasing and Recalling Objects
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # release schedules and update daily plan ./deploy-workflow.sh release ${request_options[@]} \ --path=/ap/Agent/apAgentSchedule01,/ap/Agent/apAgentSchedule02 --type=SCHEDULE --date-from=now # release objects from folder and update daily plan ./deploy-workflow.sh release ${request_options[@]} \ --folder=/ap/Agent --recursive --date-from=now # recall schedules ./deploy-workflow.sh recall--agent-id=StandaloneAgent --force |
For an Agent Cluster the reset-agent
command is available. Enabling/disabling is performed at Suagent level.
When resetting an Agent Cluster then similar behavior applies as for Standalone Agents. Users should be aware that all Subagents in an Agent Cluster will be reset.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # reset Agent Cluster ./operate-controller.sh reset-agent ${request_options[@]} \ --path=/ap/Agent/apAgentSchedule01,/ap/Agent/apAgentSchedule02 --type=SCHEDULE]}--agent-id=AgentCluster # recallreset/force objectsAgent from folderCluster ./deployoperate-workflowcontroller.sh recallreset-agent ${request_options[@]} \ --folder=/ap/Agent--agent-id=AgentCluster --recursiveforce |
Storing and Removing Objects
...
Switching-over and Confirming Node Loss for Agent Cluster
Users can switch-over the active role in an Agent Cluster. This is achieved by use of the switch-over-agent
command.
The confirm-loss-agent
command can be used in a situation when the active Controller Cluster Watch was not available at the point in time of failure of the active Agent Cluster member. Users can confirm that the failed Agent Cluster member effectively is not running which allows the remaining Agent Cluster member to take the active role
...
.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # store object ./deploy-workflow.sh store ${request_options[@]} \ --path=/ap/NewFolder01/NewWorkflow01root --typepassword=WORKFLOWroot --file=NewWorkflow01.workflow.jsoncontroller-id=controller) # remove object, update daily planswitch-over active role in Agent Cluster ./deployoperate-workflowcontroller.sh removeswitch-over-agent ${request_options[@]} \ --path=/ap/NewFolder01/NewWorkflow01 --type=WORKFLOW --date-from=nowagent-id=AgentCluster # removeconfirm objectsnode fromloss folder,for updateAgent daily planCluster ./deployoperate-workflowcontroller.sh removeconfirm-loss-agent ${request_options[@]} \ --folder=/ap/NewFolder01 --date-from=now |
Restoring and Deleting Objects
...
agent-id=AgentCluster |
Enabling, Disabling and Resetting Subagents
When Subagents in an Agent Cluster are disabled,. they are not considered for job execution.
When a Subagent is reset then the Subagent will terminate and will restart. Job processes running in the Subagent will be forcibly terminated and orders will be set to the failed state. When a forced reset is performed, then the operation forces a Subagent to be reiniitalized and to be dedicated to the current Agent Cluster. Users are recommended to double-check if a Subagent is not dedicated to a different Agent Cluster before using the --force
switch
...
.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # restore object from trash, using suffix for restored objectd ./deploy-workflow.sh restoreenable Subagent in Agent Cluster ./operate-controller.sh enable-subagent ${request_options[@]} --subagent-id=Subagent_01 # disable Subagent in Agent Cluster ./operate-controller.sh disable-subagent ${request_options[@]} \ --path=/ap/NewFolder01/NewWorkflow01 --type=WORKFLOW --new-path=/ap/NewFolder01/NewWorkflow01 --suffix=restoredsubagent-id=Subagent_01 # reset deleteSubagent objectin fromAgent trashCluster ./deployoperate-workflowcontroller.sh deletereset-subagent ${request_options[@]} \ --path=/ap/NewFolder01/NewWorkflow01 --type=WORKFLOWsubagent-id=Subagent_01 # deletereset/foce objectsSubagent fromin trashAgent by folderCluster ./deployoperate-workflowcontroller.sh deletereset-subagent ${request_options[@]} \ --folder=/ap/NewFolder01--subagent-id=Subagent_01 --force |
Resources
- APIWorkflow
- Controller Deployment Operations
- JS7 - Deployment of Scheduling ObjectsUnix Shell CLI for Controller Deployment
- Workflow Deployment
- JS7 - Secure Deployment of Scheduling ObjectsUnix Shell CLI for Workflow Deployment
- Workflow Status Operations
...