Page History
...
Code Block | ||
---|---|---|
| ||
Usage: manage-controller.sh [Command] [Options] [Switches] Commands: register --primary-url [--primary-cluster-url] [--primary-title] [--secondary-url] [--secondary-cluster-url] [--secondary-title] unregister --controller-id check --controller-id --controller-url store-agent --controller-id --agent-id --agent-name --agent-url [--title] [--alias] [--process-limit] [--hide] .. --controller-id --agent-id --agent-name [--title] [--alias] [--process-limit] --primary-subagent-id --primary-url [--primary-title] --secondary-subagent-id --secondary-url [--secondary-title] delete-agent --controller-id --agent-id deploy-agent --controller-id --agent-id [--cluster] revoke-agent --controller-id --agent-id [--cluster] store-subagent --controller-id --agent-id --subagent-id --subagent-url [--title] [--role] delete-subagent --controller-id --subagent-id store-cluster --controller-id --cluster-id --agent-id --subagent-id [--priority] [--title] delete-cluster --controller-id --cluster-id deploy-cluster --controller-id --cluster-id revoke-cluster --controller-id --cluster-id export-agent --controller-id --file [--format] --agent-id import-agent --controller-id --file [--format] [--overwrite] 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[,id]> | required: Controller ID --controller-url=<url> | optional: Controller URL for connection test --primary-url=<url> | optional: Primary Controller/Director Agent URL --primary-cluster-url=<url> | optional: Primary Controller Cluster URL --primary-title=<string> | optional: Primary Controller/Director Agent title --primary-subagent-id=<id> | optional: Primary Director Agent Subagent ID --secondary-url=<url> | optional: Secondary Controller/Director Agent URL --secondary-cluster-url=<url> | optional: Secondary Controller Cluster URL --secondary-title=<string> | optional: Secondary Controller/Director Agent title --secondary-subagent-id=<id> | optional: Secondary Director Agent Subagent ID --file=<path> | optional: path to export file or import file --format=<ZIP|TAR_GZ> | optional: format of export file or import file --agent-id=<id[,id]> | optional: Agent IDs --agent-name=<name> | optional: Agent name --agent-url=<url> | optional: Agent URL --title=<string> | optional: Agent title or Subagent Cluster title --alias=<name[,name]> | optional: Agent alias name --process-limit=<number> | optional: Agent max. number of parallel processes --role=<primary|secondary|no>subagent-id=<id[,id]> | optional: Subagent role acting as Primary/Secondary Director Agent| optional: Subagent ID --subagent-id=<id[,id]>url=<url> | optional: Subagent IDURL --subagent-url=<url>role=<primary|secondary|no> | optional: Subagent role acting as Primary/Secondary | optional: Subagent URLDirector Agent --cluster-id=<id> | optional: Subagent Cluster ID --priority=<first|next> | optional: Subagent Cluster priority: active-passive, active-active --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 -o | --overwrite | overwrites objects on import -i | --hide | hides Agent -c | --cluster | signals a Cluster Agent --show-logs | shows log output if --log-dir is used --make-dirs | creates directories if they do not exist see https://kb.sos-berlin.com/x/9YZvCQ |
...
--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
--controllerca-idcert
- 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 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-fileid
- 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
...
- identification of the Controller.
--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 used with the
--primary-url
- When used with the
register
command, specifies the protocol, host and optionally port of a Standalone Controller or Primary Controller instance in a cluster. The JOC Cockpit will connect to the Controller instance using the URL specified. - When used with the
store-agent
command for an Agent Cluster, specifies the protocol, host and optionally port of the Primary Director Agent. The Controller will connect to the Director Agent insttance using the URL specified.
- When used with the
--primary-cluster-url
- Specifies the URL used by the Pirmary Controller instance to connect to the Secondary Controller instance in a cluster. The URL can be specified if it is different from the value specified with the
--primary-url
option used for access from JOC Cockpit to the Primary Controller instance. - .The option can be used for example if a proxy service is active between Controller instances.
- Specifies the URL used by the Pirmary Controller instance to connect to the Secondary Controller instance in a cluster. The URL can be specified if it is different from the value specified with the
--primary-title
- When used with the
register
command specifies the title of a Standalone Controller or Primary Controller instance. - When used with the
store-agent
command specifies the title of the Primary Director Agent.
- When used with the
--primary-subagent-id
- When used with the
store-agent
command specifies the identifier of the Primary Director Agent.
- When used with the
--secondary-url
- When used with the
register
command, specifies the protocol, host and optionally port of a Secondary Controller instance in a cluster. The JOC Cockpit will connect to the Controller instance using the URL specified. - When used with the
store-agent
command for an Agent Cluster specifies the protocol, host and optionally port of the Secondary Director Agent. The Controller will connect to the Director Agent insttance using the URL specified.
- When used with the
--secondary-cluster-url
- Specifies the URL used by the Secondary Controller instance to connect to the Primary Controller instance in a cluster. The URL can be specified if it is different from the value specified with the
--secondary-url
option used for access from JOC Cockpit to the Secondary Controller instance. - .The option can be used for example if a proxy service is active between Controller instances.
- Specifies the URL used by the Secondary Controller instance to connect to the Primary Controller instance in a cluster. The URL can be specified if it is different from the value specified with the
--secondary-title
- When used with the
register
command, specifies the title of the Secondary Controller instance. - When used with the
store-agent
command, specifies the title of the Secondary Director Agent.
- When used with the
--secondary-subagent-id
- When used with the
store-agent
command, specifies the identifier of the Secondary Director Agent.
- When used with the
--file
- Specifies the location of an archive file that is used with
export-agent
andimport-agent
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
--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.
--agent-name
- The Agent name specifies a unique identifier for a Standalone Agent or Agent Cluster that can be changed later on..
--agent-url
- When used with the
store-agent
command, the option specifies the protocol, host and port of a Standalone Agent.
- When used with the
--title
- Specifies the title of a Controller, Agent or Subagent Cluster with related
register
,store-agent
andstore-cluster
commands.
- Specifies the title of a Controller, Agent or Subagent Cluster with related
--alias
- When used with the
store-agent
command, the option specifies alternative names for a Standalone Agent or Subagent Cluster. Any number of alias names can be specified separated by comma. - Alias names can be used for assignment of Agents to jobs.
- When used with the
--process-limit
- Specifies the maximum number of processes running in parallel in a Standalone Agent or Agent Cluster.
- For an Agent Cluster the maximum number of processes is counted for all Subagents.
--subagent-id
- When used with the
store-subagent
anddelete-subagent
commands, the option specifies the related Subagent. - When used with the
store-cluster
command, any number of Subagent IDs can be specified separated by comma. This allows to specify Subagents that are members of a Subagent Cluster.
- When used with the
--subagent-url
- The option is used with the
store-subagent
command to specify the proocol, host and port by which the Subagent can be reached.
- The option is used with the
--role
- When used with the
store-subagent
command, the Subagent's role can be specified. In an Agent Cluster we find the following roles:- Primary Director
- Secondary Director
- No Director
- The option accepts the values
primary
,secondary
,no
. Default:no
.
- When used with the
--cluster-id
- Specifies the unique identifier of a Subagent Cluster. The Subagent Cluster ID cannot be changed after the Subagent Cluster is created.
- The option is used with the
store-cluster
,delete-cluster
,deploy-cluster
andrevoke-cluster
commands.
--priority
- Specifies an active-passive or active-active Subagent Cluster. The option accepts one fo the values
first
(active-passive) ornext
(active-active). Default:first
. - The option is used with the
store-cluster
command.
- Specifies an active-passive or active-active Subagent Cluster. The option accepts one fo the values
--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
-o | --overwrite
- Specifies that Agent configurations holding the same Agent ID will be overwritten on import when used with the
import-agent
command.
- Specifies that Agent configurations holding the same Agent ID will be overwritten on import when used with the
-i | --hide
- If a Standalone Agent is added or is updated using the
store-agent
command, then the switch specifies that the Agent will not be visible in the JOC Cockpit Dashboard view and Resources->Agents view..
- If a Standalone Agent is added or is updated using the
-c | --cluster
- Specifies that the operation is applied to an Agent Cluster if the
deploy-agent
orrevoke-agent
commands are used
- Specifies that the operation is applied to an Agent Cluster if the
-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
...
The following examples illustrate use cases for automated setup up management of an environment with Controller and Agents.
Registering, Checking and Unregistering Controller
...
Overview
Content Tools