Commands for managing the software containers

This reference describes the commands for managing the installed software containers.

About the command line interface (CLI)

To open the CLI, run one of the following commands, where ZOA_HOME is the directory in which the OCI container images for IBM Z® Z Resource Discovery are installed.

Docker


ZOA_HOME/bin/dockerManageZoa.sh

Podman


ZOA_HOME/bin/podmanManageZoa.sh

Command references

Table 1. Commands and descriptions
Commands	Description
backup-data	Back up data from one named volume to the host file system.
config-certificates	Configure or reconfigure TLS certificates. Provide one of the following subcommands: delete-cert Delete a certificate from the truststore. export Export the existing set of TLS artifacts from the OCI volume in which they stored. force-generate Generate a set of TLS artifacts, regardless of whether a prior set exists. generate If no TLS artifacts exist, generate a set of TLS artifacts. generate-csr-only Generate and export a certificate signing request that is based on an existing private key. import-cert Import the certificate for an external application into the truststore to establish a trust relationship with that application. list-certs List certificates that are installed in the truststore. use-provided Install a set of externally provided TLS artifacts (for example, CA-signed artifacts).
config-ztopology	Configure the IBM Z Resource Discovery Data Service.
down	Stop and remove containers and networks.
enable-jcl-processing	Enable processing of JCL files.
gather	Collect configuration and log files, and compress them in an archive file for submission to IBM Support.
help	Show usage information.
inspect-images	Print information about software container image.
kafka-console-consumer	Show the contents of a Kafka topic.
kafka-consumer-groups	Show information about Kafka consumer groups.
kafka-debug-logging	Enable or disable debug logging for the kafkabroker service. enable Set the overall logging level for the kafkabroker service to `DEBUG`. disable Reset the overall logging level for the kafkabroker service.
kafka-prune	Prune data from a Kafka topic and, optionally, configure data retention duration for that topic. Provide the ZDiscovery subcommand to prune topics specific to ZRDDS.
kafka-topics	Manage Kafka topics.
load-routecard	Load routecard required for JCL processing.
logs	View output from containers.
move-data	Move data from one named volume to another.
ps	List containers.
purge	Stop and remove containers and networks and purge data volumes.
restart	Restart running services.
restore-data	Restore backup data on the host file system to the named volume.
start	Start stopped services.
stop	Stop running services.
up	Create and start containers.