dev <command group> [--details|-d] [--asciidoc]

Alias of "help --dev".

<command group>: (optional) the command group of which the commands should be shown
[--details|-d]: show details of the commands
[--asciidoc]: output in asciidoc format

dm create-test-data [--prefix <prefix>] [--workflows <workflow number>] [--iterations <iterations number>] [--allowedDeviation <deviation>] [--smallfiles|-s] [--bigfiles|-b]

Creates test data in the database.

[--prefix <prefix>]: prefix for created workflows
[--workflows <workflow number>]: name for created workflows
[--iterations <iterations number>]: number of iterations
[--allowedDeviation <deviation>]: allowed deviation in %, standard value is 20%
[--smallfiles|-s]: small input files for components
[--bigfiles|-b]: big input files for components

dummy

Prints a test message.

force-crash <delay>

"kills" the instance without proper shutdown at <delay> milliseconds after the command is executed.

<delay>: delay in milliseconds

im configure <instances…​> [--set-rce-version <version>] [--apply-template <template name>] [--set-name <name>] [--set-comment <comment>] [--set-relay-option <(is relay)>] [--set-workflow-host-option <(is worflow host)>] [--set-custom-node-id <node id>] [--set-tempdir-path <tempdir>] [--add-server-port <id> <host> <port>] [--add-connection <id> <host> <port> <auto-connect>] [--remove-connection <id>] [--configure-ssh-server <ip> <port>] [--add-ssh-account <username> <role> <enable ssh-account> <password>] [--remove-ssh-account <username>] [--set-ip-filter-option <(has ip-filter)>] [--enable-im-ssh-access <port>] [--set-request-timeout <r timeout>] [--set-forwarding-timeout <f timeout>] [--add-allowed-inbound-ip <ip>] [--remove-allowed-inbound-ip <ip>] [--add-ssh-connection <name> <display name> <host> <port> <login name>] [--remove-ssh-connection <name>] [--add-uplink-connection <ip> <hostname> <port> <client id> <is gateway> <connect on startup> <auto-retry> <username> <passwrod keyword> <password>] [--remove-uplink-connection <id>] [--publish-component <name>] [--unpublish-component <name>] [--set-background-monitoring <id> <interval>] [--reset] [--wipe] [--disable-ssh-server]

Configures the configuration.json file of the specified RCE instance(s).

<instances…​>: list of instances to manage
[--set-rce-version <version>]: sets the rce version of the instances. (Does not work on existing instances.)
[--apply-template <template name>]: applies (i.e. copies) the given template as the new configuration
[--set-name <name>]: sets the name of the instance
[--set-comment <comment>]: sets a general comment
[--set-relay-option <(is relay)>]: sets or clears the relay flag
[--set-workflow-host-option <(is worflow host)>]: sets or clears the workflow host flag
[--set-custom-node-id <node id>]: adds an override value for the node’s network id; use with caution!
[--set-tempdir-path <tempdir>]: sets the root path for RCE’s temporary files directory
[--add-server-port <id> <host> <port>]: adds a new server port and sets the ip and port number to bind to
[--add-connection <id> <host> <port> <auto-connect>]: adds new connection to the given ip/hostname and port, and whether it should auto-connect
[--remove-connection <id>]: removes a connection
[--configure-ssh-server <ip> <port>]: enables the ssh server and sets the ip and port to bind to
[--add-ssh-account <username> <role> <enable ssh-account> <password>]: adds an SSH account
[--remove-ssh-account <username>]: removes an SSH account
[--set-ip-filter-option <(has ip-filter)>]: enables or disables the ip filter; default: true
[--enable-im-ssh-access <port>]: enables and configures SSH forwarding of RCE console commands by the IM "master" instance
[--set-request-timeout <r timeout>]: sets the request timeout in msec
[--set-forwarding-timeout <f timeout>]: sets the forwarding timeout in msec
[--add-allowed-inbound-ip <ip>]: adds/allows an inbound IP address to the filter
[--remove-allowed-inbound-ip <ip>]: removes/disallows an inbound IP address from the filter
[--add-ssh-connection <name> <display name> <host> <port> <login name>]: adds a new ssh connection
[--remove-ssh-connection <name>]: removes a ssh connection
[--add-uplink-connection <ip> <hostname> <port> <client id> <is gateway> <connect on startup> <auto-retry> <username> <passwrod keyword> <password>]: adds a new uplink connection
[--remove-uplink-connection <id>]: removes an uplink connection
[--publish-component <name>]: publishes a new component
[--unpublish-component <name>]: unpublishes a component
[--set-background-monitoring <id> <interval>]: enables background monitoring with the given interval (in seconds)
[--reset]: resets the instance to an empty configuration
[--wipe]: wipes the instance
[--disable-ssh-server]: disables the ssh server

im dispose <instances…​>

Disposes the specified instance meaning deletion of the profile directory.

<instances…​>: list of instances to manage

im info

Shows additional information.

im install <install policy: if-missing|force-download|force-reinstall> <major version> <installation id> [--timeout <timeout>]

Downloads and installs a new RCE installation.

<install policy: if-missing|force-download|force-reinstall>: specify install policy
<major version>: syntax format: [<major version>]/<url version id/part>
<installation id>: id for the installation
[--timeout <timeout>]: specifies the maximum length of time this command is allowed to run (in seconds) - default = 60s

im list <affected items: all|instances|installations|templates>

Lists information about instances, installations or templates.

<affected items: all|instances|installations|templates>: specify group of affected items

im reinstall <install policy: if-missing|force-download|force-reinstall> <major version> <installation id>

Stops all instances running the given installation id, downloads and installs the new RCEinstallation, and starts the instances again with the new installation.

<install policy: if-missing|force-download|force-reinstall>: specify install policy
<major version>: syntax format: [<major version>]/<url version id/part>
<installation id>: id for the installation

im restart <instances…​> <installation id> [--timeout <timeout>] [--gui <start with gui>] [--command-arguments <command arguments>]

Restarts a list of RCE instances with the given instance IDs and the given installation.

<instances…​>: list of instances to manage
<installation id>: id for the installation
[--timeout <timeout>]: specifies the maximum length of time this command is allowed to run (in seconds) - default = 60s
[--gui <start with gui>]: option to start with gui - standard <false>
[--command-arguments <command arguments>]: additional command arguments

im start <instances…​> <installation id> [--timeout <timeout>] [--gui <start with gui>] [--command-arguments <command arguments>]

Starts a list of new RCE instances with the desired instance IDs and the desired installation.

<instances…​>: list of instances to manage
<installation id>: id for the installation
[--timeout <timeout>]: specifies the maximum length of time this command is allowed to run (in seconds) - default = 60s
[--gui <start with gui>]: option to start with gui - standard <false>
[--command-arguments <command arguments>]: additional command arguments

im start-all <installation id> [--timeout <timeout>] [--command-arguments <command arguments>]

Starts all available instances. Uses the given installation.

<installation id>: id for the installation
[--timeout <timeout>]: specifies the maximum length of time this command is allowed to run (in seconds) - default = 60s
[--command-arguments <command arguments>]: additional command arguments

im stop <instances…​> [--timeout <timeout>]

Stops a list of running RCE instances.

<instances…​>: list of instances to manage
[--timeout <timeout>]: specifies the maximum length of time this command is allowed to run (in seconds) - default = 60s

im stop-all <installation id> [--timeout <timeout>]

Stops all running instances.

<installation id>: id for the installation
[--timeout <timeout>]: specifies the maximum length of time this command is allowed to run (in seconds) - default = 60s

net bench <taskdef>

Run communication benchmark.

<taskdef>: <targetNode|*>([<numMessages>],[<requestSize>],[<responseSize>],[<responseDelay(msec)>],[<threadsPerTarget>])

net graph <base name> [--all|-a]

Generates a Graphviz file of the current network topology.

<base name>: base name parameter
[--all|-a]: include unreachable nodes

net np

Show known RCE node properties.

osgi <command> [-o <filename>]

Executes an OSGi/Equinox console command; use -o to write text output to a file.

<command>: osgi command
[-o <filename>]: text output to a file

ra cancel <session token>

Cancels a session.

<session token>: token of the session

ra describe-tool <tool id> <tool version> [-n <tool node id>] [--template|-t]

Prints names and data types of the tool’s or workflow’s intputs and outputs.

<tool id>: id of the tool
<tool version>: version of the tool
[-n <tool node id>]: set tool node id
[--template|-t]: make template

ra describe-wf <workflow id> <workflow version>

Prints names and data types of the tool’s or workflow’s intputs and outputs.

<workflow id>: id of the workflow
<workflow version>: version of the workflow

ra dispose <session token>

Releases resources used by a remote access session.

<session token>: token of the session

ra get-doc-list <tool id> <tool version>

Get tool documentation list.

<tool id>: id of the tool
<tool version>: version of the tool

ra get-tool-doc <session token> <tool id> <tool version> <tool node id> <hash value>

Download documentation.

<session token>: token of the session
<tool id>: id of the tool
<tool version>: version of the tool
<tool node id>: id of the tool node
<hash value>: hash value

ra init [--compact|-c]

Initializes a remote access session, and returns a session token.

[--compact|-c]: compact output

ra list-tools [-f <format>] [--with-load-data <time span> <time limit>]

Lists all available tool ids and versions for the "run-tool"command.

[-f <format>]: output format
[--with-load-data <time span> <time limit>]: load data

ra list-wfs [-f <format>]

Lists all available workflow ids and versions for the "list-wfs"command.

[-f <format>]: output format

ra protocol-version

Prints the protocol version of this interface.

ra run-tool <session token> <tool id> <tool version> [-n <tool node id>] [-p <parameters…​>] [--dynInputs <dyn inputs>] [--dynOutputs <dyn outputs>] [--nonReqInputs <non req inputs>] [--show-output|-o] [uncompressed upload|-u] [simple description format|--simple]

Invokes a tool by its id and version.

<session token>: token of the session
<tool id>: id of the tool
<tool version>: version of the tool
[-n <tool node id>]: set tool node id
[-p <parameters…​>]: additional parameters
[--dynInputs <dyn inputs>]: dynamic inputs
[--dynOutputs <dyn outputs>]: dynamic outputs
[--nonReqInputs <non req inputs>]: non required inputs
[--show-output|-o]: shows output
[uncompressed upload|-u]: This is a command flag
[simple description format|--simple]: This is a command flag

ra run-wf <session token> <workflow id> <workflow version> [-p <parameters…​>] [--show-output|-o]

Invokes a published workflow by its id.

<session token>: token of the session
<workflow id>: id of the workflow
<workflow version>: version of the workflow
[-p <parameters…​>]: additional parameters
[--show-output|-o]: shows output

run-test <tag name filters…​> <build under test id> [--format <pretty|json>]

Run a test.

<tag name filters…​>: filter for tag names
<build under test id>: build version to be used
[--format <pretty|json>]: output format

run-tests <tag name filters…​> <build under test id> [--format <pretty|json>]

(alias of "run-test").

<tag name filters…​>: filter for tag names
<build under test id>: build version to be used
[--format <pretty|json>]: output format

stats

Show internal statistics.

tasks [--all|-a] [--unique|-i]

Show information about internal tasks.

[--all|-a]: Show all tasks, including inactive ones
[--unique|-i]: Extended information: list tasks with a unique id

tc close_view <close view parameter>

Closes a GUI view.

<close view parameter>: one of the following view keys is a valid input:[Workflow_List, Log, Optimizer, Data_Management_Browser, CPACS_Writer, Properties, Component_Publishing, Cluster_Job_Monitor, TIGL_Viewer, Workflow_Console, Timeline, Excel, Parametric_Study, Command_Console, Network]

tc close_welcome

Closes the welcome screen if present.

tc compare_wf_runs <abs export workflow path> <abs export workflow path>

Compares the two given workflowruns and indicates if they are identical or wether their are differences.

<abs export workflow path>: absolute path to exported workflowrun
<abs export workflow path>: absolute path to exported workflowrun

tc export_all_wf_runs <abs path to export dir>

Exports all workflow runs into the given export directory.

<abs path to export dir>: absolute path to export directory

tc export_wf_run <absolute directory path> <workflow title>

Exports the run corresponding to the workflowtitle to the given directory.

<absolute directory path>: absolute path to directory
<workflow title>: title of the workflow

tc open_view <open view parameter>

Opens a GUI view and sets focus to it.

<open view parameter>: one of the following view keys is a valid input:[Workflow_List, Log, Optimizer, Data_Management_Browser, CPACS_Writer, Properties, Component_Publishing, Cluster_Job_Monitor, TIGL_Viewer, Workflow_Console, Timeline, Excel, Parametric_Study, Command_Console, Network]

wf check-self-test-cases

Check if all test workflows are part of at least one test case.

wf graph <workflow file>

Prints .dot string representation of a workflow (can be used to create graph visualization with Graphviz).

<workflow file>: path to the workflow file

wf list-self-test-cases

List available test cases for wf self-test.

wf self-test [--dispose <onfinished|never|always>] [--delete <onfinished|never|always>] [--pr <parallel runs>] [--sr <sequential runs>] [--python <python exe path>] [--cases <cases…​>]

Batch test workflow files of the test workflow files bundle.

[--dispose <onfinished|never|always>]: dispose behaviour
[--delete <onfinished|never|always>]: deletion behaviour
[--pr <parallel runs>]: number of parallel runs
[--sr <sequential runs>]: number of sequential runs
[--python <python exe path>]: path to python.exe
[--cases <cases…​>]: parameter for the cases