General Commands
Connect
This command connects a specific runtime from Semarchy xDI Designer console, 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 included in the value, such as http://hostname or https://hostname. If not set,
|
||
|
No |
Runtime port. |
||
|
No |
User to connect with. |
||
|
No |
Password of the user. This can be specified encrypted or as plain text. |
||
|
No |
Avoids the feedback normally written on the standard output. |
| The legacy uncryptedPassword parameter is deprecated. Use the password parameter instead, that accepts both a clear or encrypted value. |
Runtime Version
This command returns the version of the currently connected runtime.
runtime version
The legacy versions command is deprecated. If you were using it, we recommand using the runtime version command instead.
|
Execute Commands
This command runs a list of commands from a 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 runtime
Encrypt
This command encrypts a password and returns the encrypted string.
The output can be used in various places in Semarchy xDI, for example in action properties requiring an encrypted password, or in configuration files.
You can specify a custom encryption key defined in the runtime configuration. If no encryption key is specified, the default runtime encryption key will be used.
encrypt <password> encrypt <password> cipheringKey <encryption_key>
Reload 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. The services are all stopped and all running sessions are killed.
stop runtime [wait sessions]
| Option | Mandatory | Description |
|---|---|---|
|
No |
When this option is specified, the runtime waits for all the running sessions to complete before stopping. During that period, no additional session may be started on the runtime. |