Zoomdata Version

Managing Zoomdata Microservices Using the Command Line Utility

You can use the zdmanage CLI command to manage the various microservices that are deployed in the Zoomdata environment. This command line utility is automatically installed when installing Zoomdata using the automated installation script. This utility script wraps underlying UNIX commands to help you perform common management operations such as stopping and starting Zoomdata microservices.

Prerequisites

To use the command line utility tool, you need root access.

Using the Command Line Utility Tool

The 'zdmanage' command line utility is located in the following directory:

/opt/zoomdata/bin/zdmanage

The zdmanage CLI command syntax is as follows:

zdmanage services <command> <service_name>

The following commands (<command>) are supported:

Command Action
list Displays all of the Zoomdata microservices installed in your deployment.
status Provides a status of all Zoomdata microservices in your environment.
start Starts Zoomdata microservices. The order in which microservices should be restarted is described in Zoomdata Microservice Startup Order.
stop Stops Zoomdata microservices.
restart Restarts Zoomdata microservices.
enable Enables Zoomdata microservices automatically when the OS starts up.
disable Shuts down Zoomdata microservices automatically when the OS starts up.
configure Opens the specified Zoomdata property file.

For <service_name>, specify the microservice name or all (to apply the command to all Zoomdata microservices). A complete list of the Zoomdata microservices can be found in Zoomdata Microservice Name Reference.

Common Commands

Show all Zoomdata microservices installed:

sudo /opt/zoomdata/bin/zdmanage services list

Provide a status of all installed Zoomdata microservices:

sudo /opt/zoomdata/bin/zdmanage services status all

Show the status of the Zoomdata web microservice:

sudo /opt/zoomdata/bin/zdmanage services status zoomdata

Stop a specific Zoomdata microservice:

sudo /opt/zoomdata/bin/zdmanage services stop [zoomdata-service_name]

Was this topic helpful?