General commands
connect
This command connects to a specific runtime from a command console, either from Semarchy xDI Designer or from the startcommand script.
connect [to <host>] [port <port>] [user <user>] [password <password>] [silent]| Option | Mandatory | Description |
|---|---|---|
|
No |
Hostname or IP address of the host. The protocol must be part in the string, such as https://example.com. If not set, defaults to When connecting to a local runtime that listens to local connections only , use |
|
No |
Network port the runtime is listening on. |
|
No |
Runtime user to connect with. |
|
No |
Password of the runtime user. The password can be in plain text, or in its encrypted form. |
|
No |
Prevents text feedback from being written to the standard output. |
encrypt
This command encrypts a password, and returns the encrypted string.
You can use the encrypted string in various places, such as properties that ask for an encrypted password, or in configuration files.
encrypt <password> [cipheringKey <encryption_key>]| Option | Mandatory | Description |
|---|---|---|
|
Yes |
Password to encrypt. |
|
No |
Specifies a custom encryption key from a predefined keystore to use for encryption. When this option is not set, uses default xDI encryption settings. |
execute commands in file
This command executes one or more commands saved in a text file.
execute commands in file <file>| Option | Mandatory | Description |
|---|---|---|
|
Yes |
Path to a file containing a list of runtime commands, with one command per line. |
execute delivery myDelivery synch
execute delivery myDelivery2
stop runtimehelp
This command shows the list of available commands, or the description for a specific command.
help [on <commandName>]Option |
Mandatory |
Description |
|
No |
Shows help information for a specific command. |
kill runtime
This command stops the connected runtime without waiting for active sessions to complete.
kill runtimereload-modules
This command reloads the modules in the connected runtime.
reload-modules
You can configure automated modules reload using the moduleRefreshMode runtime parameter.
|
stop runtime
This command stops the connected runtime. All services are stopped, and all running sessions are killed.
stop runtime [wait sessions]| Option | Mandatory | Description |
|---|---|---|
|
No |
When specified, the runtime waits for all the running sessions to complete before stopping. During that period, the runtime will not start additional sessions. |