Managing Composer Microservices Using the Command Line Utility

You can use the zdmanage CLI command to manage the various microservices that are deployed in the Composer environment. This command line utility is automatically installed when installing Composer using the automated installation script. This utility script wraps underlying UNIX commands to help you perform common management operations such as stopping and starting Composer 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 Composer microservices installed in your deployment.
status Provides a status of all Composer microservices in your environment.
start Starts Composer microservices. The order in which microservices should be restarted is described in Composer Microservice Startup Order.
stop Stops Composer microservices.
restart Restarts Composer microservices.
enable Enables Composer microservices automatically when the OS starts up.
disable Shuts down Composer microservices automatically when the OS starts up.
configure Opens the specified Composer property file.

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

Common Commands

Show all Composer microservices installed:

sudo /opt/zoomdata/bin/zdmanage services list

Provide a status of all installed Composer microservices:

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

Show the status of the Composer web microservice:

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

Stop a specific Composer microservice:

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