Windows: S-TAP GIM installation parameters

Understand the parameters (each with a short description) that are typically used in your GIM installation.

All parameters are listed in Editing the protocol 7 S-TAP configuration parameters.
CAUTION:
Do not modify advanced parameters unless you are an expert user or you are consulting with IBM Technical Support.
Attention: If a parameter is available through both the Guardium installation manager (GIM) and the command line interface (CLI), then the GIM parameter, including any defaults, always overwrites any value that is available from WINSTAP_CMD_LINE.
Table 1. Parameters applicable to all .NET installers
GIM parameter Description
QUIET Install silently. (Does not require value)
WINSTAP_INSTALL_DIR The installation directory. The default installation path is C:\Program Files\IBM\Windows S-TAP
Table 2. Other S-TAP parameters
GIM parameter Description
WINSTAP_AUTO_DISCOVERY Controls auto-discovery of database instances. During installation, when enabled, the agent discovers database instances on the server, populates inspection engines, and updates the configuration files guard_tap.ini. The parameter value is 1 during a fresh installation and changes to 0 after the initial installation. For more information, see Windows: Auto discovery of database instances during installation and upgrade. Valid values:
  • 0: disable
  • 1: enable
WINSTAP_ENABLED

Enables or disables S-TAP and its services. Default is enabled (1).

WINSTAP_ENABLEGAM Enables the Guardium Agent Monitor service (GAM). Default is disabled (0).
WINSTAP_INSTALLER_LOG_DIR Specifies the location for storing the S-TAP installer log files. Use this parameter if you don't want to use the default location (C:).
WINSTAP_SQLGUARD_IP The SQLGUARD IP. You can set up multiple appliances by specifying this parameter multiple times, each with a unique value.
WINSTAP_TAP_IP The local/client IP. Required for unattended installation.
Table 3. S-TAP parameters that default to ON. The following parameters are set to either ON (or 1 for some parameters) by default. Setting these parameters to any value other than ON or 1 disables the parameter.
GIM parameter Description
WINSTAP_TCP_DRIVER_INSTALLED To use the TCP driver, set WINSTAP_TCP_DRIVER_INSTALLED=1 (the default).

To disable the TCP driver, set this parameter to 0.

WINSTAP_NAMED_PIPE_DRIVER_INSTALLED To use the named pipe driver, set NAMED_PIPE_DRIVER_INSTALLED=1 (the default). Specifies the named pipe that is used by MS SQL Server for local access. If a named pipe is used, but nothing is specified in this parameter, S-TAP attempts to retrieve the named pipe name from the registry.

In rare cases, the S-TAP named pipes driver can interact with other third-party software in ways that slow the server down. To turn off the named pipes driver, set this parameter to 0. The named pipes driver is removed at the next system reboot.

Note: If you turn off the named pipes driver, then the S-TAP does not capture named pipes traffic.

WINSTAP_DB2_TAP_INSTALLED Enables sniffing Db2 shared memory traffic.
WINSTAP_DB2_EXIT_DRIVER_INSTALLED Enables Db2 Integration with S-TAP.
WINSTAP_ORA_DRIVER_INSTALLED Enables sniffing Oracle ASO and SSL traffic.

Table 4. Enterprise load-balancing parameters. For more information, see Enterprise load balancing.
GIM parameter Description
WINSTAP_LOAD_BALANCER_IP Required if you are configuring enterprise load balancing. If blank, enterprise load balancing is disabled.
The IP address or hostname of the central manager or managed unit this S-TAP uses for load balancing.
Dynamic parameter. When you modify the value in the guard_tap.ini, you do not need to restart the S-TAP for the updated values to take effect.
WINSTAP_INITIAL_BALANCER_TAP_GROUP The name of the S-TAP group that this S-TAP belongs to, for enterprise load balancing.
WINSTAP_INITIAL_BALANCER_MU_GROUP The name of the managed unit group that the app-group is associated with. Requires a defined LB-APP-GROUP. The managed unit group must exist on the central manager before it can be used during installation of the S-TAP.
WINSTAP_LOAD_BALANCER_NUM_MUS The number of managed units the enterprise load balancer allocates for this S-TAP.
Note: S-TAP parameters cannot be changed via the interactive installer during upgrade. Use the GuardiumĀ® UI after the upgrade to change S-TAP parameters.