IBM Support

Environment Variables Type

How To


Summary

Use the environment variables object type to define environment variables for your apps in your app's manifest file.

The environment variables object is not an IBM® QRadar® application type. The following environment variables are set automatically by QRadar and are available to use in your app.

Steps

Name
Description
APP_GROUP_ID The group id for appuser. In App framework v2, processes in the container no longer run as root instead they run as a new user called appuser.
APP_ROOT The app root directory. In App framework v2, the root directory is /opt/app-root/app.
APP_USER_ID The user id for appuser.
LANG The language code and character encoding that is used by the QRadar Console UI when the app is installed.

LOG_COLLECTOR_RATE_LIMIT

 The log collector rate limit.
QRADAR_APPHOST_EXISTS This variable is set to true if there is an apphost in the deployment, false otherwise.
QRADAR_APPLICATION_BASE_URL The web URL for the app.

Note: If you need to forward Syslog events from your app, you can use the QRADAR_APPLICATION_BASE_URL value instead of the QRADAR_CONSOLE_IP.
QRADAR_APP_ID The app instance id
QRADAR_APP_RUNNING_ON_APPHOST This variable is set to true if the app is running on an apphost, false otherwise
QRADAR_APP_UUID The app definition UUID.
QRADAR_BUILD_VERSION The QRadar build version.
QRADAR_CONSOLE_FQDN The console FQDN.
QRADAR_CONSOLE_HOST_NAME The host name of the console.
QRADAR_CONSOLE_IP Deployment considerations for the QRADAR_CONSOLE_IP environment variable:
  • Apps that run on the Console use the Console IP address.
  • Apps that runs on a nonencrypted App Host use the Console IP address.
  • Apps that runs on an encrypted App Host use the docker network IP address (169.254.x.x) for tunneled connections.

To confirm the environment variable:
  1. Use SSH to log in to the QRadar Console as the root user.
  2. To get your application ID, type /opt/qradar/support/recon ps
  3. Connect to the app, type /opt/qradar/support/recon connect {Appid}
  4. To confirm the environment variable, type: env | grep CONSOLE
  5. The output displays the current environment variables: 
    QRADAR_CONSOLE_IP=169.254.3.1
QRADAR_CONSOLE_FQDN=ip-143-135.example.com
QRADAR_CONSOLE_HOSTNAME=ip-143-135
Note: If your app needs to support forwarding Syslog events to QRadar, you can use the QRADAR_APPLICATION_BASE_URL environmental variable, instead of QRADAR_CONSOLE_IP.
QRADAR_HTTP_PROXY HTTP proxy details are read from autoupdate settings in QRadar. For more information, see Proxy Support.

Note: The HTTP proxy details are set at runtime when there is an autoupdate setting present. If there is an autoupdate setting, the environment variable is used in the app code.
QRADAR_HTTPS_PROXY HTTPS proxy details are read from autoupdate settings in QRadar. For more information, see Proxy Support.

Note: The HTTPS proxy details are set at runtime when there is an autoupdate setting present. If there is an autoupdate setting, the environment variable is used in the app code.
QRADAR_NO_PROXY No proxy details with entries for the local server. For more information, see Proxy Support.

Note: The no proxy details are set at runtime when there is an autoupdate setting present. If there is an autoupdate setting, the environment variable is used in the app code.
QRADAR_VERSION The QRadar version.
REQUESTS_CA_BUNDLE The path the CA cert bundle.

TZ

 The timezone from the QRadar console.
http_proxy HTTP proxy details are read from autoupdate settings in QRadar. For more information, see Proxy Support.

Note: The HTTP proxy details are set at runtime when there is an autoupdate setting present. If there is an autoupdate setting, the environment variable is used in the app code.
https_proxy HTTPS proxy details are read from autoupdate settings in QRadar. For more information, see Proxy Support.

Note: The HTTPS proxy details are set at runtime when there is an autoupdate setting present. If there is an autoupdate setting, the environment variable is used in the app code.
no_proxy No proxy details with entries for the local server. For more information, see Proxy Support.

Note: The no proxy details are set at runtime when there is an autoupdate setting present. If there is an autoupdate setting, the environment variable is used in the app code.

Environment variables that you define in an app's manifest file are specific to that app and have no effect outside the app container.

The following code sample shows how to configure the environment_variables block in the manifest file.

{
...
"environment_variables": [
        {
            "name": "ENV_VAR1",
            "value": "1"
        },
        {
            "name": "ENV_VAR2",
            "value": "2"
        },
        {
            "name": "ENV_VAR3",
            "value": "3"
        }
    ],
...
}

The following table explains the manifest fields for the environment_variables block.

Field Type Description Required
name string The name of the environment variable.
Environment variable names cannot begin with a number, or contain an equals (=) sign.		 Yes
value string The value of the environment variable. Yes

Document Location

Worldwide

[{"Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSBQAC","label":"IBM Security QRadar SIEM"},"ARM Category":[{"code":"a8m0z000000cwt3AAA","label":"QRadar Apps"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
14 June 2023

UID

ibm16437505

Page Feedback