The list of available CLI commands provides a comprehensive overview of the command-line interface (CLI) commands that can be used to manage and interact with the agent. This section is essential for understanding the various operations you can perform through the CLI, including installation, configuration, and maintenance tasks. By familiarizing yourself with these commands, you can efficiently execute and automate processes, troubleshoot issues, and ensure proper management of the agent within your environment. This list serves as a reference guide to help you navigate and utilize the CLI effectively throughout your workflow.
CLI commands for Agent
This section provides an overview of the CLI commands used to manage and control the agent within the Data Integrity Suite.
| Category | Command | Description |
|---|---|---|
| Agent Migration |
Pre-requisites
Agent migration command: ./discli agent migrate
|
Use this command to transition the agent's authentication mechanism from AWS IAM-based long-term credentials to IoT device certificate-based credentials, which are automatically rotated to improve security. When executed, the following actions are performed:
Note: This operation is required only if an update link is displayed before the mailbox.
|
| Renew Certificates of IoT Agent |
./discli agent renewCerts
|
Use this command when the agent’s certificate has expired, become invalid, or failed to renew automatically—resulting in the agent becoming non-functional. Actions performed:
Note: Run this command only after reviewing the cloud credential management logs to confirm that the certificate renewal process has failed.
|
| Agent CLI version |
./discli version
|
Retrieves the current CLI version. |
./discli checkForUpdate
|
Checks to see if a new version is available. | |
./discli updateCli
|
Updates the CLI version. | |
| Agent CLI help |
./discli help
|
Views a list of available CLI commands. |
|
OR
|
Accesses help for a specific CLI command. | |
| Agent Kafka service Manual Update |
./discli agent applyKafkaVersion x.x.x
|
Manually update the Kafka service if necessary, or if the service fails to start. |
| Operator Version |
./discli agent applyOperatorVersion x.x.x
|
Apply operator version if necessary. |
CLI commands for Agent Operations
This section explains the basic CLI commands used to manage the agent in the Data Integrity Suite. These commands allow you to start, stop, update, and perform other actions. The CLI helps ensure the agent runs smoothly and supports efficient data replication.
| Category | Command | Description |
|---|---|---|
| Agent Install |
Agent install command: ./discli agent install <agent_id> <registration_key> <service_url>
|
Installs a new agent. |
| Agent Start |
./discli agent start
|
Starts all of the agent services. |
./discli agent start <service-name>
|
Starts a specific service of the agent. | |
| Agent Stop |
./discli agent stop
|
Stops all of the agent services. |
./discli agent stop <service-name>
|
Stops a specific service of the agent. | |
| Agent Restart |
./discli agent restart
|
Restarts all of the agent services. |
./discli agent restart <service-name>
|
Restarts a specific service of the agent. | |
| Agent Status |
./discli agent status
|
Checks the status of all the running services. |
| Agent List All Services |
./discli agent services
|
Retrieves the names of all the services. |
| Agent Service Logs |
./discli agent logs -s <service-name> -n <no-of-lines>
|
Retrieves the logs of a specific service Note: The
-s or --serviceName is mandatory while the -n is an optional parameter. |
| Agent Details |
./discli agent details
|
Retrieves the agent details from the Cloud. |
| Agent Update Service |
./discli agent update -s <service name> --version <version-name> -l <log-level>
|
Updates the specific service version. Note: The
-s or --serviceName and --version are mandatory while the -l is an optional parameter. |
| Agent Cleanup |
./discli agent cleanup
|
Cleans up the installation of agent. |
| Agent Preflight |
./discli agent pre-flight
|
Checks the environment compatibility before installation. Note: Run this command before the install command.
|