Metric Insights CLI Tools

This article describes CLI tools that can be executed from the Metric Insights application containers.

Tools Available for Simple Installation

Command Description
Entering application containers
mi-web Enter the Web container
mi-dataprocessor Enter the Data Processor container
mi-redis Enter the Redis container
mi-data-analyzer Enter the Data Analyzer container
mi-image-generator Enter the Image Generator container
mi-console Enter the MI Console container
mi-mysql Enter the MySQL container
mi-chatbot Enter the MI Chatbot container
Other commands
mi-chatbot-version Display the version of MI Chatbot if it is installed
mi-control Controls MI app deployment for Simple Install.

NOTES:

  • This tool is a wrapper for docker-compose
  • Run mi-control --help to see the list of available options

mi-location
Change the current location to the folder where the MI application is installed.

Tools Available from Web Container

These tools are available for all deployment types from the web container.

NOTE: Run the command with the --help parameter to see the list of available options.

  • Example: mi-app-backup --help
Command Description
mi-adduser Create a new user in Metric Insights
mi-app-backup Create a backup of your Metric Insights instance
mi-app-restore Restore your Metric Insights instance from a previously created backup
mi-console-access Grant access to MI Console
mi-cron Manage MI cron tasks
mi-dataset-usersync Sync users and group membership using a Dataset
mi-db-mgr Manage the Metric Insights database schema
mi-db-move Migrate the Metric Insights database to a new location
mi-db-rename Create a copy of the Metric Insights database with a new name
mi-deluser Remove a user from Metric Insights
mi-info Show application information
mi-ldap-usersync Sync users and groups from LDAP/AD
mi-maintenance Configure MI maintenance
mi-o365-usersync Sync users and groups from Office 365
mi-okta-usersync Sync users and groups from Okta
mi-passwd Change the selected user’s password
mi-patcher Manage patches
mi-saml-config Manage SAML configuration
mi-support A utility that includes the Telnet tool and shows the system information

mi-version

Display the Metric Insights application version.
  • NOTE: This command is available from the host and the Web container.

Tools Available from Console Container

Command Description
mi-2fa-reset
Reset 2FA for the selected user