All commands of the xuml-tool accept the following common options:

Option	Description	Allowed Values		Example
`-h --help`	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 /opt/xuml_services
`--help-all`	Show the complete help of the xuml-tool: all options, all commands.
`-log --log-level`	Set the log level for the used command. This option excludes the usage of `--mute` and `--verbose`.	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 --mute`	Disable all logging. This option excludes the usage of `--log-level` and `--verbose`.
`-v` `--verbose`	Enable debug logging. This option excludes the usage of `--log-level` and `--mute`.

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	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.		a valid path
`--create-directories`	xuml-tool 1.5.0Create missing directories instead of aborting the command.	`0`	Do not create missing directories (default).
`--create-directories`		`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.	`leave`	Keep the temporary files.
`--tmp-files-policy`		`remove`	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

name	deploy

Parameters / Options Mandatory Description Allowed Values Example

Path to a repository file.

a valid path

xuml-tool deploy ./hello_world.rep /opt/xuml_services

Path to a parent directory to extract the repository to.

--server-hostname

Specify a value for setting ${server_hostname}. Upon deploying to a Bridge, this setting is replaced automatically by the configured external host name. When deploying with xuml-tool, it must be set explicitly.

Info

icon	false

${server_hostname} can also be specified by environment variable XUMLT_SERVER_HOSTNAME .
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.

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.

Info

icon	false

The owner ID can also be specified by environment variable XUMLT_FORCED_PS_OWNER_ID .
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.

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

Code Block
{ "VAR_NAME": "variable value", .... }

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.

leave

Keep the temporary files.files.

remove

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 deployed to the default directory bridge_<name of the service>.

a valid directory name

--keep

Multiexcerpt

MultiExcerptName	keep_option

xuml-tool 1.6.0Prevent certain files from being overwritten by the deployment.

This option takes a file path relative to service directory. It can be given multiple times, thus protecting multiple files.

Info
This option can only be used if the `--existing` option is set to `overwrite`.

If the protected file path already exists, it will not be overwritten. If it does not exist, it will be copied from the source.

a valid path

xuml-tool deploy ./hello_world.rep /opt/xuml_services 
--existing overwrite --keep hello.db

remove

Remove the temporary files (default).

Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.

...

Parameters / Options Mandatory Description Allowed Values Example

Multiexcerpt

MultiExcerptName	repository

Path to a repository file or to a deployed repository.

For repository files:
Provide the path to the repository file to be deployed and started. The deploy target directory is derived from the configuration file specified with --server-config.
For deployed repositories:
Provide the path to the service directory of the service to be started. Usually this will be a directory name starting with bridge_....

a valid path

xuml-tool run ./hello_world.rep --server-config config.json 
--server-hostname scheer-acme.com

--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

the path to a license file (license)
the path to the bridgeserver binary directory (dirs.binary)
the path to the data directory (equivalent of the Bridge data directory) (dirs.data)

a valid path to a configuration file

--server-hostname

Specify a value for setting ${server_hostname}. Upon deploying to a Bridge, this setting is replaced automatically by the configured external host name. When deploying with xuml-tool, it must be set explicitly.

Info

icon	false

${server_hostname} can also be specified by environment variable XUMLT_SERVER_HOSTNAME .
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.

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.

Info

icon	false

The owner ID can also be specified by environment variable XUMLT_FORCED_PS_OWNER_ID .
Refer to xUML Service Settings below for an explanation of how to provide setting variables for deployment.

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

Code Block
{ "VAR_NAME": "variable value", .... }

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.

leave

Keep the temporary files.

remove

Remove the temporary files (default).

--service-directory-name

xuml-tool 1.6.0Specify the name of the directory the service has been deployed to.
This option needs to be specified if the service has not been deployed to the default directory bridge_<name of the service> (see option --service-directory-name for deploy.

a directory containing a deployed service

--keep

Multiexcerpt include

MultiExcerptName	keep_option
PageWithExcerpt	xuml-tool

xuml-tool run ./hello_world.rep /opt/xuml_services
--existing overwrite --keep hello.db

dump-info

xuml-tool 1.3.0Display all information on a repository. This command prints the information returned by

...

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Commands

unpack

deploy

dump-info

Page tree

Page History

Versions Compared

Old Version 3

New Version 4

Key

Commands

unpack

deploy

dump-info