Versions Compared

Old Version 3

changes.mady.by.user Kevin Wu

Saved on

compared with

New Version 4

changes.mady.by.user Kevin Wu

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Code Block
usage: topo <subcommand> <options>

...

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.

...

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.

...