Linux-UNIX: Installing the S-TAP client with GIM Setup by Client

Use the Guardium® Installation Manager Setup by Client to install the S-TAP agent either from a stand-alone Guardium appliance, or from the Central manager to schedule installation on one or more databases.

Before you begin

About this task

After the installation, you can manage all parameters and monitor processes that were installed under its control. If you install by using one of the other installation methods, fewer agent parameters can be modified using GIM.

Procedure

  1. Verify that the GIM client is installed on the database server. See Installing the GIM client on a UNIX server.
  2. Upload the relevant S-TAP module to the Guardium Installation Manager appliance.
    1. Go to Manage > Module Installation > Upload Modules.
    2. Click Choose File and select the S-TAP module that you want to install.
    3. Click Upload to upload the module to the appliance.
      The module appears in the Import Uploaded Modules table.
    4. In the Import Uploaded Modules table, click the check box next to the S-TAP module you want to install.
      The module imports and becomes available for installation. The Upload Modules page resets and the Import Uploaded Modules table is now empty.
  3. Navigate to Manage > Module Installation > Set up by Client.
  4. In the Choose clients section, select the database servers where you want to install the S-TAP module. Select individual clients using check boxes in the table, or use the Select client group menu to select a group of clients. Click Next to continue.
    Attention:
    • To create a client group, click new group to open the Create client group dialog. Click Add Clients to open the Existing Clients window, select the clients, and click OK.
    • To import clients from a CSV file. Click Import from CSV, and selecting your CSV file. Modify the field delimiter if relevant. Click Load to create a group of type Client Hostname, with Application type of Public. This group can be accessed and managed from the Group Builder.
    • After you modify the client list, click Refresh to update the display.
    • Use Reset Connection to remove GIM client information from the Guardium system before reregistering the client. After clicking Reset Connection, it might take a few minutes before the status of the GIM client process is reflected.
    • Select a client and click View Installed Modules. The View Installed Modules window shows all the modules that are installed on this client (including S-TAP), their versions, and if any module is in pending state for all the selected clients. (The module COMMON, if it appears, can be ignored.)
    • When you create or update a group and edit the Client Name of GIM clients, the host name and address must reflect a valid value for a GIM client that is connected to the Guardium system. If an invalid host name is specified, the edited client does not appear as a member of the group. Adding clients by IP address is not supported.
  5. In the Choose bundle section, use the Select a bundle menu to identify the software you want to install.
    After selecting a software bundle, the Selected bundle action column indicates Install, the action that will be performed for each client:
    Tip:
    • You can filter the clients, for example, by name, module, Selected bundle actions, and client OS. The resulting selection is persistent; the action is applied only to the filtered list of clients. You can see that the number of clients in the Choose Clients section is greater than the number in Configure Clients section.
    • Clear the Show only latest versions checkbox to view and work with earlier versions of a bundle.
    • Clear the Show only bundles checkbox to identify individual modules within a bundle.
    • Select the Show only compatible clients checkbox to hide clients that are not compatible with the selected bundle.
    Attention:
    • By default, the Select a bundle menu shows only the latest uploaded bundle version regardless of platform or compatibility with selected clients. To install a different bundle version for a specific platform or client, clear the Show only latest versions check box and select the required bundle.
    • If you upload and import new bundles while using the Set up by Client tool, refresh the browser to see the new bundles.
    • If you already have a bundle scheduled for installation, installing a new bundle removes the existing schedule.
    Click Next to continue.
  6. In the Choose parameters section, specify values for required and optional parameters. Use the add or remove to add or remove optional parameters. Use the search icon to search for parameters by name or description.
    These parameters are mandatory:
    • STAP_TAP_IP: the IP address or FQDN of the database server or node on which the STAP is being installed (equivalent to the -taphost command line parameter). If not specified, the GIM_CLIENT_IP value is used.
    • STAP_SQLGUARD_IP: the IP address or FQDN of the primary collector with which this STAP communicates (equivalent to the -appliance command line parameter). If not specified, then, the GIM_URL value is used.
    Attention: See the enterprise load balancing parameters in Linux-UNIX: S-TAP GIM installation parameters.
    Important: Unless identified as a client-specific parameter, values provided in the Choose parameters section are applied to all client installations. For client-specific parameters, the value field is disabled and values are defined per-client in the Configure clients section.
    Click Next to continue.
  7. In the Configure clients section, use the table to review and edit parameter values for each client.
    Editable parameters show a edit icon next to the parameter value. Click the edit icon to edit the value.
  8. Click Install to begin the software installation. Use the date picker icon to schedule the installation, then click OK to continue.

What to do next

Verify S-TAP status:
  • In the Success popup, click Show Status to open the Status window to monitor the software install/upgrade. Click Refresh to refresh the results. If an install/upgrade has a failed status, click Uninstall if you see the button, otherwise, click Reset connection.
  • View the module status in the report at Manage > Reports > Install Management > GIM Clients Status
  • Verify that the row of the S-TAP has a green status (first column) in Monitor > Maintenance > S-TAP Logs > S-TAP Staus