SharePlex 9.2.8 - Installation and Setup for Oracle Source

SharePlex license utilities

Description

Use the SharePlex license utilities to view and add license keys to hosts in the SharePlex replication environment. Each installation of SharePlex requires a valid license key. There are three types of SharePlex license keys:

• Temporary license keys (demonstration licenses)
• Permanent license keys
• Site license keys

The current license model for SharePlex is to license for a specific host, which depending on edition is licensed by core(s) or socket(s) and specific message repository (i.e. database, JMS/text files) etc. Specifics of license terms should be obtained from your account manager.

If you do not have a valid license key, you may obtain one from Quest Technical Support or your Quest sales representative. Use the appropriate procedure in this documentation to obtain the necessary information to support your license request.

License utilities on Unix and Linux

On Unix and Linux systems, separate utilities are used to:

• Gather information to request a license
• Add a license key
• View a license key

Gather information to request a license

Use the splex_uname utility to collect information about the local host that is required for Quest to generate a license key. Run this utility from the util sub-directory of the SharePlex product directory.

$ /proddir/util/splex_uname

The information is similar to the following example:

Local system info:
Host Name	 	= irvspxu09
Host ID	 	= 2198894273 (831076C1 HEX)
Operating System	= SunOS
Machine model		= SUNW,UltraAX-i2
CPU Type		= sparc9
CPU Speed	 	= 500
Number of CPUs	 	= 1

Add a license key

Use the splex_add_key utility to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another.

You can use the splex_add_key utility as follows:

• You can use splex_add_key on the primary node of a cluster to install licenses for all secondary nodes in the cluster, because they all share one variable-data directory.
• You cannot use splex_add_key to add licenses for non-clustered machines from one machine. It must be run on each non-clustered replication system so that the license information is stored in the variable-data directory on each system.

To run splex_add_key

1. Log on to the system as the SharePlex Administrator.
2. Run sp_ctrl on the machine where you want to install a license key.

3. If SharePlex is running, shut it down.

   sp_ctrl> shutdown

4. Run splex_add_key from the install sub-directory of the SharePlex product directory.

   $ /proddir/install/splex_add_key

5. Choose the appropriate option for how to install the key:

   SharePlex License Utility
   1) Read license key from file
   2) Enter license key manually
   3) Add license key for alternate host
   q) Quit License Utility
   Enter option:

   Note: Use option 3 when installing on secondary nodes in a cluster. To install SharePlex in a cluster, see "Preinstallation instructions for Oracle cluster" in the SharePlex Installation and Setup Guide for Oracle.

6. If you are entering the key manually, type the license key exactly as you received it from Quest, including the SPLEXKEY= string if one prepends the key, any spaces, and any capitalization. Press Enter when finished typing the key.

7. Enter the SiteMessage text string provided by Quest with the license key.

   Note: If you selected option 3 to install in a cluster, the utility continually prompts for another machine ID to license, until you exit the license utility.

8. Enter q to exit the utility.
9. Start SharePlex when you are ready for replication to resume.

View a license key

Use the splex_get_key utility to view the SharePlex license key, license type, and expiration date on a machine. Run this utility from the install sub-directory of the SharePlex product directory.

$ /proddir/install/splex_get_key

The information is similar to the following example:

$ /splex/proddir/install/splex_get_key
Customer Name = Quest
License Key = EANLCF3P56F8M1JB1K6RBJCBB6TBEP0
Product Name = SharePlex Oracle
License type = demo key
Expired on = 01/01/2008 12:00 AM

License utility on Windows

On Windows platforms, all licensing functions are performed through the SpUtils utility, including viewing the machine ID for a system. Launch the SpUtils utility from the shortcut on the Windows desktop.

Gather information to request a license

Select the Information tab to view information about the local host that is required for Quest to generate a license key. In a cluster, run SpUtils on each node.

Add a license key

Use SpUtils to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another. In a cluster, run SpUtils on the primary node.

1. Log on to Windows as the SharePlex Administrator.

2. If SharePlex is running, do the following:

   1. Select the SharePlex Services tab.
   2. Select the port number of the SharePlex instance for which you want to add a license key.
   3. Click Stop.
   4. Wait for Current State to display a message that the service stopped.
3. Select the License Keys tab.

4. Select the SharePlex port number from the Port list.

5. Click Add License, then type or paste the information exactly as you received it from Quest, as follows:

   1. License Key: The license key, including any spaces. The key is case-sensitive.
   2. Customer Name: The text string that was included with the license. The name is case-sensitive.

6. (Windows Cluster) To add a license for another node in a cluster, select the Add Alternate Host Id check box, then select the machine ID from the CPU ID list box. Repeat this step to add a license to all secondary nodes in the cluster.

7. Click OK to close the utility.

8. To start SharePlex, do the following:

   1. Select the SharePlex Services tab.
   2. Select the port number of the SharePlex instance that you licensed.
   3. Click Start.
   4. Wait for Current State to display a message that the service started.

View a license key

Select the License Key tab, then select the port number (if running multiple SharePlex instances) for which you want to view license information.

• Under License Key, view the actual license key and SiteMessage text string.
• Under Status, view the type of SharePlex installation, the license type, and the expiration date.

In a cluster, run SpUtils on each node to view the local license.

Install the SharePlex service

SharePlex runs as a service on the Windows platform. The service name is SharePlex port_number, where port_number is the port number associated with that SharePlex instance.

SharePlex is not installed as a Windows service during the initial installation. You must add and start the service through the SpUtils utility.

To add and start SharePlex as a service

1. Run the SpUtils utility from the SharePlex entry in the Programs menu.
2. Select the Service tab.
3. Select the SharePlex port number for which you are installing the service.
4. Click Install. (A "Service Stopped" message indicates that the service is installed.)
5. (Optional) Click Start to start the service.

The service is installed in auto-startup mode (start when the system starts) so that replication begins as soon as possible. To change startup status, use the Services applet of the Administrative Tools in the Windows Control Panel.

Uninstall SharePlex

Contents

This section contains instructions for using the SharePlex uninstallation program to remove SharePlex from a system. The uninstaller permanently removes the replication environment from the system.

To preserve the replication environment, including the queues that store the data, you can install a SharePlex upgrade or reinstall the current version, rather than uninstall SharePlex. Before you upgrade or reinstall SharePlex, see the Release Notes for the version you are installing to determine if there are any special upgrade or installation requirements.

Uninstall SharePlex from UNIX/Linux

1. Log on as a user who has privileges to remove the SharePlex directories.
2. Run sp_ctrl.

3. Issue the shutdown command to shut down SharePlex.

   sp_ctrl> shutdown

4. Exit sp_ctrl.

5. Use the following command to make certain that no SharePlex processes are running.

   # ps -ef | grep sp_

6. Kill any processes that are still running.
7. Remove the SharePlex product directory, variable-data directory, and the hidden .shareplex directory from the system.
8. Drop the SharePlex database user from the database.

Note:

If desired, remove any objects that SharePlex installs in the database. These objects begin with SHAREPLEX_. You can remove any such objects using standard SQL commands.