Help & Documentation
Open Support Ticket

Configure System Variables Using mi-config CLI Tool

Beginning in v7.2.0, System Variables can be configured using the mi-config CLI tool inside the web container.

The tool provides a command-line interface for retrieving, updating, and listing System Variables stored in the Metric Insights database, with validation applied to ensure supported values are used.  

An optional debug mode is available to display the underlying operations performed during configuration changes.

TABLE OF CONTENTS:

  1. Access the Web Container
  2. Get System Variable Value
  3. Set System Variable Value
  4. List System Variables
  5. Debugging

NOTE: Run mi-config --help to view built-in usage information.

1. Access the Web Container

  • Simple Install:
mi-web
  • Kubernetes:
 kubectl exec -it <webmaster-pod-name> -n <MI-namespace> -- bash
  • OpenShift:
oc exec -it <webmaster-pod-name> -n <MI-namespace> -- bash
  • Docker Swarm:
docker exec -it <webmaster-container-id> bash

2. Get System Variable Value

Retrieve the current value of a System Variable and its available values (if applicable):

mi-config get [VARIABLE_NAME]
  • Replace [VARIABLE_NAME] with the actual System Variable name.
    • See List System Variable(s) for information on how to display all System Variables or the ones matching the filter.

NOTE: System Variable values that contain sensitive information are displayed in encrypted form.

Example

Get the current value and available values for CACHE_LAYER_1_SAVE_HANDLER:

mi-config get CACHE_LAYER_1_SAVE_HANDLER

Output:

files
Possible values: files, redis, memcached

3. Set System Variable Value

Set the System Variable value:

mi-config set [VARIABLE_NAME] [VARIABLE_VALUE]
  • Replace [VARIABLE_NAME] and [VARIABLE_VALUE] with the name of the System Variable and the value you want to assign to it.
    • If no value was provided, you will be prompted to enter it.

Example

Assign CYBERARK_LOGGING to N:

mi-config set CYBERARK_LOGGING N

Output:

2026-01-07 18:49:35  INFO: Configuration variable "CYBERARK_LOGGING" updated successfully

4. List System Variables

List all System Variables:

mi-config show

List all System Variables that contain the specified filter text:

mi-config show [FILTER]
  • Replace [FILTER] with text that the returned System Variables must contain.

Optionally, specify the number of columns in which the returned System Variables are displayed:

mi-config show [FILTER] -c [NUMBER_OF_COLUMNS]
  • Replace [NUMBER_OF_COLUMNS] with the desired number of display columns.

Example

List all System Variables that contain the word "enable" and display the result in three columns:

/opt/mi$ mi-config show enable -c 3

Output:

CUSTOM_SCRIPT_ENABLED                             ENABLE_CONCIERGE                                  ENABLE_R_SHINY_WITHIN_APPS
DATA_ANALYZER_LOGGING_ENABLED                     ENABLE_CONCIERGE_ICON                             ENABLE_SCIM_REQUEST_LOGGER
DATA_COLLECTION_RESULT_LOGGING_ENABLED            ENABLE_DB_PROFILER                                ENABLE_SMART_FOLDERS
ENABLE_ADVANCED_APPS                              ENABLE_EMAIL_TRACKING                             ENABLE_TABLEAU_CROSS_SITE_WORKAROUND
ENABLE_ADVANCED_LOGGER                            ENABLE_EXTERNAL_DATASETS                          ENABLE_VOICE_SEARCH
ENABLE_AFTER_LOGIN_PAGE                           ENABLE_LOGIN_PAGE                                 SAML_ENABLED
ENABLE_APPLE_APP_BANNER                           ENABLE_METADATA_COLLECTION                        SAML_GUEST_LOGIN_ENABLED
ENABLE_APPLICATION_ERROR_LOGGING_INTO_DB          ENABLE_METRIC_VALUE_CHANGE_LOGGING                TABLEAU_CLIENT_IP_MATCHING_ENABLED
ENABLE_APP_BUILDER                                ENABLE_MOBILE_VIEW                                TABLEAU_MULTIPLE_GATEWAY_ENABLED
ENABLE_BURST_PDF_REPORT_PACK                      ENABLE_PENDO                                      UI_DATA_FETCH_LOGGING_ENABLED
ENABLE_BURST_PPT_REPORT_PACK                      ENABLE_PERSIST_HOMEPAGE_FILTERS_BETWEEN_SESSIONS  USER_SESSION_LOGGING_ENABLED
ENABLE_CERTIFICATION_FILTERING                    ENABLE_POWERBI_STICKY_FILTERS
ENABLE_CERTIFICATION_LEVELS                       ENABLE_PUBLISHING_WORKFLOW_AUTOMATION_RULES

5. Debugging

Debug mode can be enabled to display the exact commands executed by mi-config. To enable the debug mode, append --debug or -v after mi-config and before other parameters of the command; e.g.:

mi-config -v set [VARIABLE_NAME] [VARIABLE_VALUE]

NOTE: All three commands (get, set, show) can be executed in debug mode.

Example

Set DATA_PROCESSOR_LOGGING_LEVEL to NONE and run the command in the debug mode:

mi-config -v set DATA_PROCESSOR_LOGGING_LEVEL NONE

Output:

2026-01-07 21:05:56 DEBUG: Setting configuration variable: DATA_PROCESSOR_LOGGING_LEVEL
2026-01-07 21:05:56 DEBUG: SQL: SELECT config_variable_id, mask_value_ind, available_values FROM config_variable WHERE name = %s
2026-01-07 21:05:56 DEBUG: Binds: ['DATA_PROCESSOR_LOGGING_LEVEL']
2026-01-07 21:05:56 DEBUG: Connecting to database...
2026-01-07 21:05:56 DEBUG: Host: mysql
2026-01-07 21:05:56 DEBUG: Database: dashboard
2026-01-07 21:05:56 DEBUG: User: mi_setup
2026-01-07 21:05:56 DEBUG: Database connection established
2026-01-07 21:05:56 DEBUG: Value validated against available_values: ALL,REQUEST ONLY,NONE
2026-01-07 21:05:56 DEBUG: Updating database...
2026-01-07 21:05:56 DEBUG: SQL: UPDATE config_variable SET value = %s WHERE name = %s
2026-01-07 21:05:56 DEBUG: Binds: ['NONE', 'DATA_PROCESSOR_LOGGING_LEVEL']
2026-01-07 21:05:56 DEBUG: Transaction committed
2026-01-07 21:05:56 DEBUG: Variable updated successfully
2026-01-07 21:05:56  INFO: Configuration variable "DATA_PROCESSOR_LOGGING_LEVEL" updated successfully
2026-01-07 21:05:56 DEBUG: Triggering const.php regeneration...
2026-01-07 21:05:56 DEBUG: Running variable_update.py to update const.php...
2026-01-07 21:05:56 DEBUG: Command: /usr/local/bin/python3 /opt/mi/lib/mi/bin/variable_update.py --prefix /opt/mi --db-host mysql --db-user mi_setup --db-pass iiug02lT2NVubJ34 --db-port 3306 --db-name dashboard --verbose