Code Block |
---|
usage: topo <subcommand> <options> |
This command is used to register containers in STR and to create, update, remove, and view pico configurations.
...
Info | |||||
---|---|---|---|---|---|
Example - Converting an XML fileFile
|
...
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.
|
...
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 | ||
---|---|---|
Example - Reading the environment variablesEnvironment Variables
|
Info | ||
---|---|---|
Example - Setting the environment variable Environment Variable JAVA_HOME
|
...
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
|
...
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
|
...
Info | ||
---|---|---|
Example - Setting nano as the default editorDefault Editor
|
...
Info | ||||
---|---|---|---|---|
Example - Rebasing an EC configurationConfiguration
or
|
...
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 based New 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
|
...
mzsh topo unset topo://container:<container>/pico:<pico>
Info | |||||
---|---|---|---|---|---|
Example - Removing a pico configurationPico Configuration
|
Info | |||||
---|---|---|---|---|---|
Example - Removing a pico attributePico 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.
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://..).
|
...
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 Current Config
|
...