Manage SymphonyMicroservices Using the Command Line Utility
This applies to: Visual Data Discovery
You can use the zdmanage CLI command to manage the various microservices that are deployed in the Symphony 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 Symphony 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 Symphony microservices installed in your deployment. |
|
Provides a status of all Symphony microservices in your environment. |
|
Starts Symphony microservices. The order in which microservices should be restarted is described in Symphony Microservice Startup Order. |
|
Stops Symphony microservices. |
restart |
Restarts Symphony microservices. |
|
Enables Symphony microservices automatically when the OS starts up. |
|
Shuts down Symphony microservices automatically when the OS starts up. |
|
Opens the specified Symphony property file. |
For <service_name>, specify the microservice name or all (to apply the command to all Symphony microservices). A complete list of the Symphony microservices can be found in Symphony Data Discovery Microservice Name Reference.
Common Commands
Show all Symphony microservices installed:
sudo /opt/zoomdata/bin/zdmanage services list
Provide a status of all installed Symphony microservices:
sudo /opt/zoomdata/bin/zdmanage services status all
Show the status of the Symphony web microservice:
sudo /opt/zoomdata/bin/zdmanage services status zoomdata
Stop a specific Symphony microservice:
sudo /opt/zoomdata/bin/zdmanage services stop [zoomdata-service_name]