Command reference for OCI containers

This reference lists and describes the commands for administering the OCI containers.

On Linux®, the following separate command-line interfaces (CLIs) are merged into a single CLI in Z Anomaly Analytics and Z Operational Log and Data Analytics 5.1.1.10 or later:

Problem Insights server CLI
Z Data Analytics Platform CLI
Z Anomaly Analytics OCI container CLI

You can run the single CLI by using one of the following commands:

Docker:
```
<ZOA_HOME>/bin/dockerManageZoa.sh
```
Podman:
```
<ZOA_HOME>/bin/podmanManageZoa.sh
```

where <ZOA_HOME> is the directory into which the Z Data Analytics platform and Z Anomaly Analytics OCI-based capabilities are installed.

Commands for administering installed software containers

Table 1. Commands for administering installed software containers
Command	Explanation
backup-data	Back up data from one named volume to the host file system.
config-certificates	Configure or reconfigure TLS certificates. You must 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 even if a prior set exists. generate If no TLS artifacts exist, generate a set of TLS artifacts. 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. Note: This command was updated in `5.1.x.14`.
config-parser-pipeline	Configure or reconfigure the pipelines for the parser component. Note: This command was newly added in `5.1.x.14`.
config-rulesengine	Configure Rules Engine rules for metric-based machine learning. Note: This command was newly added in `5.1.x.14`. This command is applicable to IBM Z® Anomaly Analytics use cases only.
datastore	Manage data store indices. You must provide one of the following subcommands: list-indices List indices containing operational data that is present in the data store. You can list all indices or provide a pattern of index names for a filtered list. delete-indices Delete indices containing operational data from the data store. You can provide a pattern of index names to delete. Note: This command was newly added in `5.1.x.14`.
delete-pi-library	Delete a message library from the Problem Insights service.
down	Stop and remove containers and networks.
export-custom-objects	Export custom searches, visualizations, and dashboards from a Z Data Analytics Platform workspace.
export-pi-library	Export a message library from the Problem Insights service.
gather	Collect configuration and log files and compress them in a ZIP archive for submission to IBM® Support.
get-log-level	View log level of a specific container. Note: This command was renamed from "`getLogLevel`" in `5.1.x.14`.
get-pi-libraries	List the message libraries that are imported into the Problem Insights service.
help	Show usage information.
import-custom-objects	Import previously exported custom searches, visualizations, and dashboards into a Z Data Analytics Platform workspace.
import-pi-library	Import a message library into the Problem Insights service. You must provide one of the following subcommands: default Import message libraries that are shipped with the Z Data Analytics Platform. custom Import a custom-made message library.
inspect-images	Print information about OCI images. Note: This command was renamed from "`inspectImages`" in `5.1.x.14`.
kafka-console-consumer	Show contents of a Kafka topic.
kafka-consumer-groups	Show information about a Kafka consumer group.
kafka-prune	Prune data from a Kafka topic and optionally configure data retention duration for that topic. You must provide one of the following subcommands: ZLDA Process Kafka topics for the Z Data Analytics Platform. ZAA Process Kafka topics for Z Anomaly Analytics. ZDiscovery Process Kafka topics for the Z Resource Discovery Data Service component. Note: This subcommand was newly added in `5.1.x.14`. This subcommand is applicable to the ServiceNow CMDB integration use cases only.
kafka-topics	Manage Kafka topics. Note: This subcommand was enhanced in `5.1.x.16`. It now provides a broader set of capabilities, including the ability to view topic details, alter topic configuration, or delete topics. The additional capability is provided to improve serviceability and should be used under the guidance of IBM Support.
logs	View output from containers.
manage-security-tenants	Create, update, or delete security tenants. Here are the available sub-commands: create: Create a new security tenant. update: Update the configuration of an existing security tenant. The update can be performed either as a replacement of the existing configuration, or as an additive update. delete: Delete an existing security tenant and all artifacts that are associated with it. Note: This command was newly added in `5.1.x.16`.
manage-zdap-secrets	List, create, update, or delete secrets containing sensitive information that are required by the extended features of the Z Data Analytics Platform. Note: This command was newly added in `5.1.x.16`.
migrate-index-pattern	Migrate custom visualizations and searches from versions prior to 5.1.`x`.10. Note: This command was newly added in `5.1.x.14`.
move-data	Move data from one named volume to another.
process-cdp-policy	Generate index templates for non-curated data streams from a Z Common Data Provider policy file. Note: This command was renamed from processCdpPolicy in `5.1.x.14`.
ps	List containers.
purge	Stop and remove containers and networks and purge data volumes.
reconfig-insight-packs	Reconfigure Problem Insights service insight packs when the gateway hostname or port has changed.
reset-datastore-api-password	Create a new, randomly generated password for API access to the datastore service. Note: This command was newly added in `5.1.x.16`.
reset-datastore-security	Initialize IBM-provided default security configuration for the datastore service. Note: This command was newly added in `5.1.x.16`. The command is automatically run when Fix Pack `5.1.x.16` is installed. After the fix pack is installed, use this command only if IBM Support instructs you to do so.
restart	Restart running services.
restore-data	Restore backup data on the host file system to the named volume.
seed-ldap	Seed the authentication service with LDAP user IDs based on an input file. Note: This command was newly added in `5.1.x.14`.
set-log-level	Set a log level for a specific container. Note: This command was renamed from "`setLogLevel`" in `5.1.x.14`.
start	Start stopped services.
stop	Stop running services.
up	Create and start containers.