Page History
...
All commands of the xuml-tool accept the following common options:
Option | Description | Allowed Values | Example | |
---|---|---|---|---|
-h | Show either the help of the xuml-tool (including a list of all available commands), or the help of the selected command. | xuml-tool deploy --verbose ./hello_world.rep | ||
--help-all | Show the complete help of the xuml-tool: all options, all commands. | |||
-log | Set the log level for the used command. | off | No logging. | |
critical | Only log critical errors. | |||
error | Log all errors. | |||
warning | Log errors and warnings. | |||
info | Log errors, warnings, and some general information (default). | |||
debug | Log errors, warnings, general and debug information. | |||
trace | Log a complete trace. | |||
-m | Disable all logging. | |||
-v --verbose | Enable debug logging. |
Commands
unpack
xuml-tool 1.0.0Unpack a given repository file to the destination directory.
The repository will be unpacked to a sub-directory in the destination directory. The name of the sub-directory is derived from the repository file name.
Parameters / Options | Mandatory | Description | Allowed Values | Example | |
---|---|---|---|---|---|
Path to a repository file. | a valid path | xuml-tool unpack ./hello_world.rep . | |||
Path to a parent directory to extract the repository to. | |||||
--create-directories | xuml-tool 1.5.0Create missing directories instead of aborting the command. | 0 | Do not create missing directories (default). | ||
1 | Create missing directories during the command. | ||||
--tmp-files-policy | xuml-tool 1.5.0Specify whether to keep or remove temporary files used during the execution of this command. |
| Keep the temporary files. | ||
| Remove the temporary files (default). | ||||
--service-directory-name | xuml-tool 1.6.0Specify the name of the deployment directory for the service. If not existent yet, the directory will be created automatically. If this option is not specified, the repository will be unpacked to the default directory bridge_<name of the service>. | a valid directory name |
deploy
xuml-tool 1.0.0Deploy a given repository to a given destination.
The repository will be unpacked to a sub-directory in the destination directory.The name of the sub-directory is derived from the composite service name.
...
Table Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.
...
Parameters / Options | Mandatory | Description | Allowed Values | Example | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
| a valid path | xuml-tool run ./hello_world.rep --server-config config.json | ||||||||
--server-config | Provide the path to an an xUML Runtime configuration file containing Runtime command line options. The contents of such a file are described on xUML Runtime Command Line Options. This file must at least contain a minimal configuration consisting of
| a valid path to a configuration file | |||||||||
--server-hostname | Specify a value for setting
| localhost | Default value if not specified. | ||||||||
a valid external host name | |||||||||||
--existing | Specify what to do if the repository being deployed is already existent in the target directory. | remove | Remove the repository from the target folder if already existent, and deploy the new repository. | ||||||||
delete | |||||||||||
overwrite | Overwrite files of an already existing repository. | ||||||||||
abort | Abort deployment if the repository is already existent (default). | ||||||||||
--forced-ps-owner-id | xuml-tool 1.4.0Set this value as a fix persistent state ower ID for this service.
| a positive integer | |||||||||
--global-variables-file | xuml-tool 1.5.0Replace global variables in setting values with the values specified in the given file. The file is a JSON file containing key/value pairs like
You need to manually create this file. | a valid JSON file containing the variable names and values | |||||||||
--create-directories | xuml-tool 1.5.0Create missing directories instead of aborting the command. | 0 | Do not create missing directories (default). | ||||||||
1 | Create missing directories during the command. | ||||||||||
--tmp-files-policy | xuml-tool 1.5.0Specify whether to keep or remove temporary files used during the execution of this command. |
| Keep the temporary files. | ||||||||
| Remove the temporary files (default). | ||||||||||
--service-directory-name | xuml-tool 1.6.0Specify the name of the directory the service has been deployed to. | a directory containing a deployed service | |||||||||
--keep |
| xuml-tool run ./hello_world.rep /opt/xuml_services |
dump-info
xuml-tool 1.3.0Display all information on a repository. This command prints the information returned by
...