Code Block |
---|
usage: topo <subcommand> <options> |
This command is used to register containers in STR and to create, update, remove, and view pico configurations.
...
Note!
This command is valid only for the MZ_HOME owner.
When you make changes in pico configurations , using topo
, these are automatically validated before they are copied to the active registry.
If the command and its arguments can be parsed but fails fail the validation, you can update the configuration or use a reset command to undo the changes. An error message will appear if the validation fails. You can disable the validation by using the option --no-activation
. Changes performed by the mzsh topo
will then remain in the master registry until you submit a separate topo activate
command.
You can use the following subcommands with topo:
activate
container
convert
diff
env
get
hash
help
migrate
open
rebase-configs
register
reset
set
setupremote
show
unset
The option --allow-disconnected
is available for all subcommands except for setupremote
. You should only include this option when the Platform is unreachable and you want to use cached data.
...
Use topo activate
to move staged changes in the master registry to the active registry.
Option | Description |
---|---|
[--dry-run] | Use this option to validate the staged changes without performing the activation. |
[–hash <hash value>] | Compare the provided hash value with the actual hash that represents the current state of active registry. The activation fails if the values are not equal. For further information, see hash below, |
[-v, --verbose] | Use this option for detailed information about the changes. |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...
Use topo container
to display the name of the current container.
Option | Description |
---|---|
[--allow-disconnected] | Use this option when the Platform is unreachable and you want to operate on cached data. |
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 | |||||
---|---|---|---|---|---|
Example - Converting an XML fileFile
|
...
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
|
| |||||
[ -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 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example - Comparing registry filesRegistry Files Run the following command to view the differences between the active registry and the master registry.
or
Run the following command to view the differences between the active registry and the backup registry.
|
env
Code Block |
---|
Usage: topo env [-e, --effective] [--update-java-home <value>] [--update-mz-container <value>] [--update-mz-home <value>] [--update-mz-platform <value>] |
...
[-e, --effective]
...
Use topo env
to display or set environment variables that are used my by the mzsh command. These variables are written to the script file MZ_HOME/bin/mzsh
.
...
Option
...
Description
The variables, MZ_PLATFORM
, MZ_CONTAINER
and MZ_CONTAINER_TYPE
, are handled differently than the rest. To update the value in the script file you use the parameters starting with --update-<value>
as per the below table. To update the value in the script file and use the value immediately, you need to combine the --update-<value>
parameter with the -e
parameter.
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 | ||
---|---|---|
Example - Reading the environment variablesEnvironment Variables
|
Info | ||
---|---|---|
Example - Setting the environment variableEnvironment Variable JAVA_HOME
|
...
Code Block | ||
---|---|---|
| ||
topo://container:<container>/pico:<pico>/val:<attribute> |
Option | Description | |||||||
---|---|---|---|---|---|---|---|---|
[--default-val <value>] | Use this option to replace a missing value in the target path with a default value.
| |||||||
[ --exclude-dynamic] | Use this option to exclude non-static data in the output e g | |||||||
[--format <full|data-only>] | Use this option to exclude metadata from the command output.
Default: | |||||||
[-l, --local] | Use this option to select the local container, unless another container is specified in the target path. Default: | |||||||
[-p, --perspective <resolve | default>] | Use this option to retrieve the attributes of templates instead of the template names.
Default: |
Info | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Example - Viewing pico configurationsPico Configurations Run the following command to view one or more pico configurations.
You can view multiple pico configurations by replacing the full path with a regular expression.
|
Info | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Example - Viewing pico attributesPico Attributes Run the following command to view a specific attribute in a pico configuration.
You can retrieve the attributes of multiple pico processes by replacing the full path with a regular expression.
|
...
Use topo hash
to retrieve a value that represents the current state of the active registry. This is useful when you need to handle concurrent changes of the STR. For instance, an application may need to retrieve a pico configuration to evaluate the required changes. In the meantime, a second application or a user may update the same configuration
Info | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example - Using hash valuesHash Values
|
...
Use topo open
to open a cell, container- or pico configuration file in a text editor. When you save and close the editor, the command will call topo activate
to move the staged changes in the master registry to the active registry.
Option | Description |
---|---|
[-n, --no-activation] | Use this option to skip activation after changes in master registry. |
Run the following command to open a cell configuration:
Code Block | ||
---|---|---|
| ||
$ mzsh topo open cell:<cell> |
Info | |||||
---|---|---|---|---|---|
Example - Opening a cell configurationCell Configuration
|
...
Code Block | ||
---|---|---|
| ||
$ mzsh topo open <container> |
Info | |||||
---|---|---|---|---|---|
Example - Opening a container configurationContainer Configuration
|
...
Code Block | ||
---|---|---|
| ||
$ mzsh topo open <pico> |
Info | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Example - Opening a pico configurationPico Configuration
or
|
If the pico name is not unique in the system, you will be prompted to specify the container.
Info | |||||
---|---|---|---|---|---|
Example - Multiple pico configuration sharing the same namePico Configurations Sharing the Same Name
|
...
Code Block | ||
---|---|---|
| ||
$ mzsh topo open services:<custom|standard> |
Info | |||||
---|---|---|---|---|---|
Example - Opening a service configurationService Configuration
|
Tip |
---|
Hint! When you save the configuration, |
By default, the command opens the vi editor. To use a different editor set the environment variable EDITOR
.
Info | ||
---|---|---|
Example - Setting nano as the default editorDefault Editor
|
...
For further information about templates, see STR File Structure.
Option | Description |
---|---|
[-a, --activate] | Use this option to immediately activate after changes in master registry. |
Info | ||||
---|---|---|---|---|
Example - Rebasing an EC configurationConfiguration
or
|
...
When you install an execution container, and the Platform is running, it is automatically registered in the Platform Container. If the platform is not running during the installation, use topo register
to register the Execution Container manually.
Option | Description |
---|---|
[-a, --address <ip/host>] | Use this when you need to set a different host address for the container than the one that is specified in the common property |
[-c, --container <container>] | Use this option when you need to change the existing container name. This option is typically used together with the |
[-g, --container-group <container group>] | Use this option when you need to change the existing container group. This option is typically used together with the |
[--mz-home <path>] | Use this option when you need to set a different home directory for the container than the one that is specified in the environment variable MZ_HOME, which is the default value. |
[-u] | Use this option to allow updates of an already registered container. By default, updates are not allowed and the command will attempt to register a new container. |
reset
Code Block |
---|
Usage: topo reset |
...
Use topo set
to create and update pico configurations in the specified target-path of STR.
Option | Description |
---|---|
[-l, --local ] | Use this option to select the local container, unless another container is specified in the target path. |
[--no-activation, -n] | Use this option to skip activation after changes in master registry. |
[-s, --strict-json] | Use this option when you want to specify the configuration in JSON format instead of HOCON format. |
Run the following command to create a new pico configuration.
...
The <config>
argument may contain a key-value pair that specifies a template or a pico configuration in HOCON format.
Info | |||||
---|---|---|---|---|---|
Example - Creating a new pico configuration basedNew Pico Configuration Based on a templateTemplate
|
Info | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example .- Creating pico configurationPico Configuration When you specify a pico configuration that consists of multiple attributes, it is recommended that you use multi-line strings. HOCON Format:
JSON Format:
Add the pico group setting by using the following topo command
This command makes the Execution context "EC1" a member of the "ec1" and "ec2" groups. This is the HOCON example format adding in ECs to a pico group.
|
...
mzsh topo set topo://container:<container>/pico:<pico>/val:<attribute> <attribute value>
Info | |||||
---|---|---|---|---|---|
Example - Updating a pico attributePico Attribute
|
...
The <config>
argument may contain a pico configuration in HOCON format.
Info | |||||||
---|---|---|---|---|---|---|---|
Example - Updating a pico objectPico Object This command adds the properties
The following commands does not overwrite the properties
|
...
Use the command topo setupremote
to enable remote access via SSH to an Execution Container, e g from the Platform container.
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 |
[--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 |
the file | |
[--no-host-key] | By default, the |
[--no-ssh-details] | Use this option to exclude |
[--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 |
[--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 |
show
Use topo show to retrieve various types of information about pico instances that are defined in the STR.
Code Block | ||
---|---|---|
| ||
Usage: topo show [ --exclude-dynamic] [--format <format>] [-l, --local] [--timeout-seconds <time>] <view> |
Option | Description |
---|---|
[ --exclude-dynamic] | Exclude non-static data in the output e g |
[ --format <format>] | Set the format of the returned data:
|
[ -l, --local ] | Use this option to view pico instances in the local container only. By default, all containers are included. |
[--timeout-seconds <time>] | Use this option to limit the time for retrieving dynamic information, e g |
The following views are available:
jvm-args
- Displays the JVM arguments that are used by the pico instances in the system. JVM arguments that are set in templates are included.status
- Displays the container name, pico name, pico type and running state.status-sc
- Displays similar view asstatus
but only includes SCs.status-ec
- Displays similar view asstatus
but only includes ECs.status-long
- Displays similar view asstatus
but also includes the status of replication between Platform Container and Execution Containers.pico-view
- Displays similar view asstatus
but also includes memory usage and the pico response time.pico-view2
- Displays similar view aspico-view
but also includes uptime.ports
- Displays the ports that are used by the pico instances in the system. Ports that are set in templates and on cell- and container level, are included. If both webserver and httpd ports are displayed, then webserver ports take precedence.
Info | ||||||
---|---|---|---|---|---|---|
Example - Views
|
unset
Code Block |
---|
Usage: topo unset [-l, --local] [-n, --no-activation] <target path> |
Use topo unset
to remove pico configurations in the specified target-path of STR.
Option | Description |
---|---|
[-l, --local] | Use this option to select the local container, unless another container is specified in the target path. |
[-n, --no-activation] | Use this option to skip activation after changes in master registry. |
Run the following command to remove a pico configuration.
mzsh topo unset topo://container:<container>/pico:<pico>
Info | |||||
---|---|---|---|---|---|
Example - Removing a pico configurationPico Configuration
|
Info |
---|
Example - Removing a |
...
Pico Attribute
|
Excerpt | ||
---|---|---|
File Paths in AttributesWhen you enter a path that is relative to MZ_HOME in the value of an attribute, it is recommend that you use In the following example MZ_HOME will be resolved to its current value e g
|
...
The next example uses a path that is always relative to MZ_HOME.
|
...
|
...
title | Note! |
---|
|
...
Conflicting AttributesThe name of an attribute may contain the full name of another attribute. For instance, In this case you must ensure that the name of both properties are surrounded by quotes, or one of the properties will be overwritten at activation.
|
...
When there are conflicting properties and you are using the mzsh topo command, also add single quotes, surrounding the target path (topo://..).
|
...
|
...
|
Updating IP, Hostname, and Ports in JDBC URL
You can update the IP address, hostname, and ports int he JDBC URL using the mzsh topo get
and mzsh topo set
commands as shown in the examples below.
Info | |||||
---|---|---|---|---|---|
Example - Get Current Config
|
Info | |||||
---|---|---|---|---|---|
Example - Update URL with set
|
Note |
---|
Caution! When you have set the new JDBC URL, run shutdown and startup on the platform to ensure that your changes take effect properly. |
Return Codes
Listed below are the different return codes for the topo command:
Code | Description |
---|---|
0 | Will be returned if the command is successful. |
1 | Will be returned if the argument count is incorrect or argument(s) are invalid. |
3 | Will be returned if the target path argument for the subcommand |