Windows: S-TAP command line installation parameters

Understand the parameters (each with a short description) that you can use in your script and GIM installation.

In a CLI installation, you install an S-TAP by using setup.exe with the appropriate parameters, as follows,

setup.exe -PARAMETER value

Do not use “=” signs to assign values to the parameters. The only time “=” is used when you want to add a parameter to the TAP section of the guard_tap.ini file directly as it is typed in the command line.

To add parameters that are not specified here but are required in the guard_tap.ini file, append the [TAP] section by specifying the parameter and value with an = sign, for example:

setup.exe -UNATTENDED -INSTALLPATH "C:\Program Files\IBM/Windows S-TAP" -APPLIANCE 10.0.148.160 -TAPHOST 10.0.146.160 QRW_INSTALLED=0 QRW_DEFAULT_STATE=0

Important: The TAPHOST, APPLIANCE, INSTALLPATH attributes are required.

Attention: If a parameter is available through both the 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
Command line parameter	GIM parameter	Description
UNATTENDED	QUIET	Install silently. (Does not require a value).
INSTALLPATH	WINSTAP_INSTALL_DIR	The installation directory. Default installation path is C:\Program Files\IBM\Windows S-TAP
UNINSTALL		Uninstall. A value is not required.
CUSTOMER		Change a customer name.
COMPANY		Change a company name.
SERVICEUSER		Specify a user to run the service under.
SERVICEPASSWORD		The password for the user.

Table 2. Other S-TAP Parameters
Command line parameter	Description
APPLIANCE	The SQLGUARD IP. You can set up multiple appliances by specifying this parameter multiple times, each with a unique value.
ENABLEGAM	Enables the Guardium Agent Monitor service (GAM).
DISCOVERY-PORT	S-TAP Discovery connects to the Guardium system with this port. Default=8443. Only used in UNATTENDED mode.
INSTALLERLOGPATH	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:).
NOAUTODISCOVERY	Prevents database instance discovery from running during the installation. A value is not required. For more information, see Windows: Auto discovery of database instances during installation and upgrade.
START	Controls whether S-TAP is started or not after installation. Attention: This parameter defaults to on and can be disabled only by setting its value to `0`. Any value other than `0` set the parameter to on.
TAPHOST	The local/client IP. Required for unattended installation.

Table 3. S-TAP Parameters that default to `ON`.. Unless otherwise noted, the default value for each parameter is `ON`. Enter any other value to turn off the parameter.
Command line parameter	GIM parameter	Description
V8PROTOCOL	WINSTAP_V8_PROTOCOL	Default = OFF. Note: To use V8 protocol, set this parameter to `ON`.
TCP	WINSTAP_TCP_DRIVER_INSTALLED	Use TCP driver.
NMP	WINSTAP_NAMED_PIPE_DRIVER_INSTALLED	Allows you to specify the named pipe 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.
DB2SHMEM	WINSTAP_DB2_TAP_INSTALLED	Enables sniffing Db2 shared memory traffic.
DB2EXIT	WINSTAP_DB2_EXIT_DRIVER_INSTALLED	Enables Db2 integration with S-TAP.
ORACLEPLUGIN	WINSTAP_ORA_DRIVER_INSTALLED	Enables sniffing Oracle ASO and SSL traffic.

Table 4. Enterprise Load Balancing parameters
Command line parameter	GIM parameter	Description
LOAD-BALANCER-IP	WINSTAP_LOAD_BALANCER_IP	Required if you are configuring load balancing. This option specifies the IP address of the central manager or managed unit for the S-TAP to use for load balancing. S-TAP parameters cannot be changed via the interactive installer during upgrade. Use the Guardium® UI after the upgrade to change S-TAP parameters. To configure the enterprise load balancer to run on a managed unit, the S-TAP must be at V10.1 or higher.
LB-APP-GROUP	WINSTAP_INITIAL_BALANCER_TAP_GROUP	Optional. The application group name that this S-TAP belongs to for enterprise load balancing. Attention: Group names with spaces or special characters are not supported.
LB-MU-GROUP	WINSTAP_INITIAL_BALANCER_MU_GROUP	Optional. The managed unit group name to associate with the app-group. Requires a defined LB-APP-GROUP. A managed unit group must exist on the central manager before it can be used during installation of S-TAP. Attention: Group names with spaces or special characters are not supported.
LB-NUM-MUS	WINSTAP_LOAD_BALANCER_NUM_MUS	The number of managed units the enterprise load balancer allocates for this S-TAP.