Set the SharePlex Port Number

The SharePlex processes use TCP to communicate with each other between different systems and uses UDP to communicate within a system. The default TCP and UDP port numbers for SharePlex are both set to 2100 at the time of installation. For some deployments of SharePlex you may need to change the TCP or UDP port numbers.

Before selecting a port number, review the following points:

• If your replication strategy requires multiple instances of sp_cop on a system, you must set a unique port number for each one. For more information, see Run Multiple Instances of SharePlex.
• When an non-default port is required, the same number must be used for both the TCP and UDP ports, and it must be used for the TCP and UDP ports of all other instances of sp_cop that are involved in the same replication configuration. If the ports are different, sp_cop on one system cannot connect to the sp_cop on another system to send or receive messages and data.

Supported databases

All databases supported by SharePlex on all supported platforms

Set the SharePlex port on Unix and Linux systems

To set the port number on Unix and Linux systems, a SharePlex Administrator must set both the TCP and UDP port parameters in the SharePlex environment. If there is an active configuration, you will be instructed to stop access to the source objects and shut down sp_cop.

To finish setting the port in an active configuration:

1. (If using multiple variable-data directories] Export the SP_SYS_VARDIR environment variable to point to the correct variable-data directory for the port you are setting.

   ksh shell:

   export SP_SYS_VARDIR=/full_path_of_variable-data_directory

   csh shell:

   setenv SP_SYS_VARDIR=/full_path_of_variable-data_directory

2. Export the following environment variables.

   ksh shell:

   export SP_COP_TPORT=port

   export SP_COP_UPORT=port

   csh shell:

   setenv SP_COP_TPORT port

   setenv SP_COP_UPORT port

   where: port is the new port number

3. Change directories to the SharePlex product directory.

4. Start sp_cop and sp_ctrl.

   Note:If you are using multiple variable-data directories, start sp_cop with the -uport option, where port is the port number that you have chosen for the variable-data directory that you exported.

   ./sp_cop [-uport] &

5. Run sp_ctrl.

   ./sp_ctrl

6. In sp_ctrl, set the following SharePlex parameters.

   sp_ctrl> set param SP_COP_TPORT port

   sp_ctrl> set param SP_COP_UPORT port

7. Do one of two things:

   • If there is not an active configuration, use the shutdown command in sp_ctrl to stop sp_cop. The next time you start sp_cop, the new port number takes effect.

     NOTE: If you do not have an active configuration, you are finished setting the port number.

   • If there is an active configuration, continue to the next step.
     

8. Stop access to the replicating objects on the source system, then issue the flush command in sp_ctrl on the source system to clear the queues.

   sp_ctrl> flush o.database_identifier

   where: database_identifier is o. followed by the Oracle SID, TNS alias, or PDB name that SharePlex uses to connect to the source database (depends on whether the database is a regular Oracle instance, RAC, or PDB in a container database).

9. On the source system, issue the qstatus command to verify that all of the messages reached the target system.

   sp_ctrl> qstatus

   Continue to issue the command until the export queue is empty.

10. On the target system, issue the qstatus command to verify that all of the messages were posted to the database. Continue to issue the command until the post queue is empty.

11. On the target system, issue the status command to verify that Post stopped.

    sp_ctrl> status

12. Shut down SharePlex on the source and target systems.

    sp_ctrl> shutdown

13. Start sp_cop on the source and target systems.

    Note:If you are using multiple variable-data directories, start sp_cop with the -uport option, where port is the port number that you have chosen for the variable-data directory that you exported.

    ./sp_cop [-uport] &

14. Run sp_ctrl on the target system.

15. Start the Post process.

    sp_ctrl> start post

16. Allow users to access the replicating objects.

17. Use the status command on the source and target systems to verify that all SharePlex processes are running.

    sp_ctrl> status

Set the SharePlex port on Windows systems

On Windows systems, SharePlex port numbers are stored in the Windows Registry. If it becomes necessary to change a port number, this is the SharePlex entry location:

\HKEY_LOCAL_MACHINE\Software\Wow6432node\Quest Software\SharePlex.

1. Log onto Windows as a SharePlex Administrator using your system password and user name. Your user name must be assigned to the SharePlexAdmin group.
2. Run the SpUtils utility.
3. Select the SharePlex Services tab.
4. Under Port, select the port number for the instance of SharePlex whose port you want to change.
5. Under SharePlex Service Status, click Stop.
6. Click Close.
7. From the Start menu, select Run.
8. In the Run dialog box, type regedit to open the Registry Editor.
9. In the Registry Editor, under \HKEY_LOCAL_MACHINE\Software\Wow6432node\Quest Software\SharePlex, right click the current port number, then select Rename.
10. Replace the highlighted port number with the new number.
11. Click the new port number to highlight it.
12. In the Name column of the right-hand pane, right-click the SP_SYS_VARDIR entry that is associated with the new port number, then select Modify.
13. In the Edit String dialog, change the port number (only the port number) in the path to the new port number, then click OK.
14. Exit the Registry Editor.
15. In the Windows file explorer, navigate to the variable-data directory for which you changed the port number (the one whose name still shows the old port number).
16. Right click the name, and then use the Rename command to change only the port number in the name to the new port number.
17. Run the SpUtils utility, then select the SharePlex Services tab.
18. Under Port, select the new port number.
19. Under SharePlex Service Status, click Install to establish the SharePlex service under the new port.
20. After Current State shows that the service is installed, click Start to start the service.