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 i.e. in App framework v2 this would be /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 will be set to true if there is an apphost in the deployment, false otherwise
QRADAR_APPLICATION_BASE_URL The web URL for the app.
QRADAR_APP_ID The app instance id
QRADAR_APP_RUNNING_ON_APPHOST This variable will be 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 The IP address of QRadar console.
QRADAR_HTTP_PROXY Http proxy details read from autoupdate settings in QRadar. Note this will only be set if there is an autoupdate setting present. (This would then be used in the app code)
QRADAR_HTTPS_PROXY Https proxy details read from autoupdate settings in QRadar. Note this will only be set if there is an autoupdate setting present. (This would then be used in the app code)
QRADAR_NO_PROXY No proxy details with entries for the local server. Note this will only be set if there is an autoupdate setting present. (This would then be 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 read from autoupdate settings in QRadar. Note this will only be set if there is an autoupdate setting present.
https_proxy Https proxy details read from autoupdate settings in QRadar. Note this will only be set if there is an autoupdate setting present.
no_proxy No proxy details read from autoupdate settings in QRadar. Note this will only be set if there is an autoupdate setting present.

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:
30 March 2021

UID

ibm16437505