Available CLI commands

Data Integrity Suite

Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2025

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

  1. Keytool Installation: This command automatically downloads and installs keytool. However, if internet access is restricted or public URL downloads are blocked, manual installation is required as outlined below.
    • For RHEL (Red Hat Enterprise Linux):
      sudo yum install -y java-1.8.0-openjdk-devel 
      export JAVA_HOME=$(readlink -f /usr/bin/java | sed "s:bin/java::")
      export PATH=$JAVA_HOME/bin:$PATH
    • For Ubuntu:
      sudo apt install -y openjdk-11-jdk
      export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
      echo "export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64" >> ~/.bashrc
  2. BC FIPS JAR (bc-fips-2.0.0.jar) : The CLI attempts to automatically download and place the Bouncy Castle FIPS JAR in /precisely/agent/libs/. If this fails due to restricted internet access, follow the steps below to install it manually.
    • Manual Installation Steps:
      sudo mkdir -p /precisely/agent/libs/
      sudo chmod -R 777 /precisely/agent/libs/
      wget -O /precisely/agent/libs/bc-fips-2.0.0.jar https://repo1.maven.org/maven2/org/bouncycastle/bc-fips/2.0.0/bc-fips-2.0.0.jar

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:
  • IAM credentials are removed from both the Mailbox and Operator.

  • A Certificate Signing Request (CSR) is generated and a certificate is requested from the cloud.

  • The following modules are installed:

    • trust-manager

    • credentials-management

  • End-to-end asymmetric encryption is enabled for communication between the cloud and the customer environment.
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:
  • Generates a new Certificate Signing Request (CSR).

  • Requests a new certificate from the trust-manager.

  • Installs the new certificate to restore agent functionality.

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.

./discli agent install --help

OR

./discli updateCli --help

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.