| Code Block |
|---|
usage: topo <subcommand> <options> |
...
convert
| Code Block |
|---|
Usage: topo convert [-c, --container <container>] [-g, --container-group <container group>] [--dry-run] [-f, --file <filename>] |
Use topo convert to move the configuration of a specific XML file to STR.
| Option | Description |
|---|
[-c, --container <container>] | Use this option to specify a target container. |
[-g, --container-group <container group>] | Use this option to specify a target container group. |
[--dry-run] | Use this option to validate that the conversion and display the result of the conversion without updating the STR. |
[-f, --file <filename> | Use this option to specify the source XML file. |
| Info |
|---|
| title | Example - Converting an XML file |
|---|
|
| Code Block |
|---|
| $ mzsh topo convert --container main1 |
|
diff
| Code Block |
|---|
Usage: topo diff [-e, --show-entries] [-f, --from <registry>] [-q, --brief] |
Use topo diff to view differences between the master repository and the active repository in the STR.
| Option | Description |
|---|
| [-e, --show-entries] | Use this option for viewing differences in an easy-to-read format. By default, the output from the command displays topo set commands that correspond to the staged changes. | Info |
|---|
| title | Example - Output from diff command |
|---|
| With -e option: | Code Block |
|---|
UPDATE (containers/main1/picos/ec1.conf) config.properties.aaa:"2" # (was: "1") |
Without -e option: | Code Block |
|---|
mzsh topo set topo://container:main1/pico:ec1/val:config.properties.aaa "2" # (was: "1") |
|
|
| [-f, --from] <registry> | Use this option when you want to compare the active registry with the backup registry |
[-q, --brief] | Use this option to only view the names of the updated registry files. The default value is false. |
| Info |
|---|
| title | Example - Comparing registry files |
|---|
|
Run the following command to view the differences between the active registry and the master registry. | Code Block |
|---|
| $ mzsh topo diff |
or | Code Block |
|---|
| $ mzsh topo diff --from master |
Run the following command to view the differences between the active registry and the backup registry. | Code Block |
|---|
| $ mzsh topo diff --from backup
|
|
env
| Code Block |
|---|
Usage: topo env [-e, --effective] [--update-java-home <value>] [--update-mz-container <value>] [--update-mz-home <value>]
[--update-mz-platform <value>] |
Use topo env to display or set environment variables that are used my the mzsh command. These variables are written to the script file MZ_HOME/bin/mzsh.
| Option | Description |
|---|
| [-e, --effective] | Use this option to read the environment parameters in runtime, i e the "effective values" after accounting for overrides. The default behaviour is to read the values as they are defineds in the mzsh script file, not accounting for the possibility to override these values with environment variables. |
[--update-java-home <value>] | Use this option to update the value of JAVA_HOME |
[ --update-mz-container <value>] | Use this option to update the value of MZ_CONTAINER. |
[--update-mz-home <value>] | Use this option to update the value of MZ_HOME. |
[--update-mz-platform <value>] | Use this option to update the mzsh value of MZ_PLATFORM. |
| Info |
|---|
| title | Example - Reading the environment variables |
|---|
|
| Code Block |
|---|
$ mzsh topo env
export JAVA_HOME="/opt/Java/JavaVirtualMachines/jdk1jdk-17.80.0_1212.jdk/Contents/Home"
export MZ_CONTAINER="main1"
export MZ_CONTAINER_TYPE="platform"
export MZ_PLATFORM="http://localhost:9000"
export MZ_HOME="/user/home/mz/main1" |
|
| Info |
|---|
| title | Example - Setting the environment variable JAVA_HOME |
|---|
|
| Code Block |
|---|
$ mzsh topo env --update-java-home /opt/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home |
|
get
| Code Block |
|---|
Usage: topo get [--default-val <value>] [ --exclude-dynamic] [--format <full | data-only>] [-l, --local] [-p, --perspective] <target path>] |
...
| Option | Description |
|---|
[-c, --container <container>] | Use this option to specify a different container than the local one, which is the default value. |
| [-g, --container-group <container group>] | Use this option to setup remote access to a container in specific container group. This is useful when you have multiple containers with identical names in different containers groups. |
| [--host-key <path>] | Use this option to use a pre-generated host key instead of the one that is generated when you run topo setupremote. |
| [--java-home <path>] | Use this option when the target container is located on a different host. The default value is specified by the environment variable JAVA_HOME in the current shell. |
| [--no-authorized-key] | By default, the topo setupremote command will obtain a public authorization key from the user home directory on the Platform Container host and store it in the STR, i e the file mz.conf. Use the option --no-authorized-key to skip this operation. |
| [--no-host-key] | By default, the topo setupremote command will store the public host key of the Execution Container in the STR, i e the file mz.conf. Use the option --no-host-key to skip this operation. |
| [--no-ssh-details] | Use this option to exclude ssh-username and ssh-address from STR. These attributes are required for remote access. If you use this option you will need to update the STR manually. |
| [--ssh-address <ip/host>] | Use this option when the target container is located on a different host or when you want to bind to a specific IP address or hostname. The default value is specified by the address attribute for container in mz.conf. |
| [--ssh-port <port>] | Use this option when you want to use a different port than 22 for SSH. |
| [--ssh-username <username>] | Use this option when the target container is located on a different host or when a specific username is required for SSH. The default SSH user is the OS user that runs the topo setupremote command. |
...