Manage ComposerMicroservices 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 your software using the automated installation script. This utility script wraps underlying UNIX commands to help you perform common management operations such as stopping and starting 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 |
|---|---|
|
Displays all the microservices installed in your deployment. |
|
Provides a status of all microservices in your Composer environment. |
|
Starts microservices. The order in which microservices should be restarted is described in Microservice Startup Order. |
|
Stops microservices. |
restart |
Restarts microservices. |
|
Enables microservices automatically when the OS starts up. |
|
Shuts down microservices automatically when the OS starts up. |
|
Opens the specified Composer property file. |
For <service_name>, specify the microservice name or all (to apply the command to all Composer microservices). For a complete list of microservices, see Composer Microservice Name Reference.
Common Commands
Show all Composer microservices installed:
sudo /opt/zoomdata/bin/zdmanage services list
Provide a status of all installed microservices:
sudo /opt/zoomdata/bin/zdmanage services status all
Show the status of the web microservice:
sudo /opt/zoomdata/bin/zdmanage services status zoomdata
Stop a specific microservice:
sudo /opt/zoomdata/bin/zdmanage services stop [zoomdata-service_name]
Comments
0 comments
Please sign in to leave a comment.