Managing bundles by using the configurator.sh script

Edit online

Use the configurator.sh script to list the installed modules and bundles that are managed by GIM, and to display and change any parameter for the bundles.

The configurator.sh script is installed with the GIM bundle on the database server, and is located in the UTILS folder.

The GIM and S-TAP clients do not need restarting after you run this script.

The syntax is:
<GIM installation directory>/UTILS/current/files/bin/configurator.sh [--set <param name> <param value>| --get <module name> | --list | --delayed_bundle_deployment <enable|disable>
Parameter Description
delayed_bundle_deployment
  • enable: suspends any scheduled installations
  • disable: scheduled installations take place
Default = disable
get <module name> Returns the value of all the parameters that are specified for the module.
list Lists all the GIM modules and their status.
set <parameter name> <value> Set the module’s parameter to the specified value.
The following examples show the usage of configurator.sh:
  • To list the GIM-managed modules and bundles, and their status.
    /usr/local/IBM/modules/UTILS/current/files/bin/configurator.sh --list

    The output looks similar to the following example.

    [Wed Jan 20 08:58:56 2021] STAP-UTILS     11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] SUPERVISOR     11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] COMPONENTS     11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] STAP           11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] UTILS          11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] BUNDLE-GIM     11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] KTAP           11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] GIM            11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] BUNDLE-STAP    11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] INIT           11.1.0.11_r109779_1    INSTALLED
[Wed Jan 20 08:58:56 2021] ATAP           11.1.0.11_r109779_1    INSTALLED

    For information on the modules and bundles, see GIM modules and bundles.

  • To view the GIM parameter values:
    /usr/local/IBM/modules/UTILS/current/files/bin/configurator.sh --get GIM

    The output looks similar to the following example.

    GIM_ALLOW_CUSTOMED_BUNDLES=0
GIM_ALLOW_IP_HOST_COMBO=0
GIM_AUTO_SET_CLIENT_IP=0
GIM_CA_FILE=gim_ca.pem
GIM_CERT_FILE=gimListenerServer.cert.pem
GIM_CLIENT_IP=nn.nn.nn.nn
GIM_DEBUG=0
GIM_DISKSPACE=1000
GIM_ENABLED=1
GIM_FAILOVER_URL=
GIM_INTERVAL=60
GIM_KEY_FILE=gimListenerServer.key.pem
GIM_LISTENER_PORT=8445
GIM_PACKAGE=guard-GIM-11.1.0.11_r109779_v11_1_1-rhel-7-linux-x86_64.tar.gz.signed
GIM_PART_OF_BUNDLE=BUNDLE-GIM
GIM_RESPONSE_TIMEOUT=600
GIM_SYMVERSION=11.1.0.11_r109779_v11_1_1
GIM_URL=<server name>
GIM_URL_PORT=8081
GIM_URL_SSL_NO_AUTH_PORT=8444
GIM_URL_SSL_PORT=8446
GIM_USE_SSL=1
GIM_VERSION=11.1.0.11_r109779_1
COMMON_ALIVE_INTERVAL=900
COMMON_DEBUG=0
COMMON_INSTALL_DIR=/usr/local/IBM/modules
COMMON_OS=Linux
COMMON_OS_BITS=64
COMMON_OS_VENDOR=rhel
COMMON_OS_VENDOR_VERSION=7
COMMON_OS_VERSION=
COMMON_PATH=/usr/local/IBM/modules:/usr/xpg4/bin:/bin:/sbin:/usr/sbin:/usr/bin:/usr/local/bin:/usr/contrib/bin:
COMMON_PERL_DIR=/usr/bin
COMMON_PLATFORM_PROCESSOR=x86_64
COMMON_PROTOCOL_VERSION=100_r0_3
  • To change the value of the GIM_URL parameter:
    /usr/local/IBM/modules/UTILS/current/files/bin/configurator.sh --set GIM_URL nn.nn.nn.nn
  • To disable any GIM upgrades from deploying: 
    /usr/local/IBM/modules/UTILS/current/files/bin/configurator.sh --delayed_bundle_deployment enable

GIM modules and bundles

The GIM installed modules and bundles are:
  • BUNDLE_GIM - defines the internal modules that are associated with the BUNDLE_GIM installer package. This module includes the internal modules: GIM, INIT, SUPERVISOR, and UTILS. These internal modules are installed or upgraded as part of the BUNDLE_GIM installer; they cannot be installed or upgraded independently.
    Within the BUNDLE_GIM installer package:
    • The INT module orchestrates the workflow for installing, uninstalling, updating, starting, stopping, and fetching the status of each module in the GIM environment on the database client.
    • The GIM, SUPERVISOR, and UTILS modules define the operational logic for handling events such as installation, uninstallation, start, and stop.
  • BUNDLE_STAP - defines the internal modules that are associated with the BUNDLE_STAP installer package. This module includes the internal modules: ATAP, COMPONENTS, KTAP, STAP, and STAP-UTILS. These internal modules are installed or upgraded as part of the BUNDLE_STAP installer; they cannot be installed or upgraded independently.

    Within the BUNDLE_STAP installer package, the ATAP, COMPONENTS, KTAP, STAP, and STAP-UTILS modules define the operational logic for handling specific events such as installation, uninstallation, start, and stop.