Set up by Client

Quickly deploy S-TAPs (Software TAPs) and other software packages by using the GIM Set up by Client tool.

Before you begin

Before you use the Set up by Client tool, verify the following items:
  • GIM clients are installed on database servers and connected to the Guardium system.
  • Compatible GIM bundles are uploaded and imported to the Guardium system.

About this task

The Set up by Client page includes a column named Installed Version. If the version ends with _0, it means that the operating system on the database changed (as part of a system reboot). In this scenario, the GIM client also needs upgrading. In this situation, upload the GIM client bundle that supports the new OS to the Guardium system. The do one of:
  • Enable the GIM Global parameter auto_install_on_db_server_os_upgrade on the Guardium system that is the GIM client, which automatically upgrades all of the GIM clients with the latest bundle of the OS they support.
  • Keep auto_install_on_db_server_os_upgrade disabled and do the upgrade yourself,

Procedure

  1. Go to Manage > Module Installation > Set up by Client.
  2. In the Choose clients section, select the database servers where you want to install or update software using GIM. Select individual clients using check boxes in the table, or use the Select client group menu to select a group of clients.
    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 select 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 you reregister the client. After you click 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 hostname and address must reflect a valid value for a GIM client that is connected to the Guardium system. If an invalid hostname is specified, the edited client does not appear as a member of the group. Adding clients by IP address is not supported.
    Click Next to continue.
  3. In the Choose bundle section, use the Select a bundle menu to identify the software you want to install or update. Click Next to continue.
    After selecting a software bundle, the Selected bundle action column indicates the action that is performed for each client:
    Install
    The selected bundle is installed on the client. This action indicates a first-time installation of the software on the client.
    Upgrade
    The bundle is upgraded on the client. This action indicates that an earlier version of the software is installed on the client.
    Update parameters
    The bundle parameters are updated on the client. This action indicates that the selected software and the currently-installed software are the same version.
    None (bundle not found)
    No actions are performed, indicating that there are no compatible actions on the client for the selected bundle.
    None (newer version installed)
    No actions are performed because the selected bundle is older than the version that is currently installed on the client. To install an older version of software, first uninstall the current version.

    The Available column indicates whether the selected software is available for installation from the GIM server. If the software is not available, click Import Bundles to upload and import the bundle or module.

    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 the 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 checkbox and select the required bundle.
    • If you upload and import new bundles while you are working in the Set up by Client tool, refresh the browser to see the new bundles.
    • If you have a bundle that is already scheduled for installation, installing a new bundle removes the existing schedule.
  4. In the Choose parameters section, specify values for the required and optional parameters. Use the add or remove icons to add or remove optional parameters. Use the search icon to search for parameters by name or description. Click Next to continue.
    Important: Unless identified as a client-specific parameter, values that are provided in the Choose parameters section are applied to all clients where the software is installed, upgraded, or updated. For client-specific parameters, the value field is unavailable and values are defined per-client in the Configure clients section.
  5. 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. The Selected bundle action column shows the action that is performed on each client.
  6. Click Install to begin the software installation. Use the date picker icon to schedule the installation, then click OK to continue.
  7. To create the Guardium API syntax for the current configuration in the Setup by Client, click Generate GuardAPI. If enough information is available, it generates API commands for multiple clients in the GuardAPI commands dialog. If there isn't enough information, it shows a default template.

What to do next

In the Success dialog, 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.

If you see a Failed installation status for a bundle or module, open the Choose bundle section, select the client,click Uninstall, and use the refresh icon to monitor the installation status. If the Uninstall button is not available, open the Choose clients pane, select the affected client, and click Reset connection. Use the refresh icon to monitor the client list as the connection is reset.