sp_cop Parameters
These parameters are used by the SharePlex sp_cop program.
SP_COP_IDLETIME
This parameter determines the time interval during which sp_cop is inactive. The purpose of idle time is to conserve a machine's resources. In general, sp_cop should not be idle for long, because it plays a central role in replication. This parameter enables you to increase the idle time if sp_cop is using too much CPU time for overhead activities. A recommended value is 600 seconds to reduce the overhead.
Default: 60 seconds
Range of valid values: any positive integer
Takes effect: immediately
SP_COP_SCAN_TIMEOUT
This parameter sets the initial time interval sp_cop uses to scan its services table to determine if a process needs to be stopped or restarted.
As SharePlex continues to run, the interval might change, depending upon the history of each process.
Default: 300 seconds
Range of valid values: any positive integer
Takes effect: immediately
SP_COP_SO_RCVBUF
This parameter tunes the TCP/IP window size on the target machine. It works in conjunction with the SP_XPT_SO_SNDBUF parameter on the source machine to establish the size of a packet sent across the network. SharePlex references both parameters when TCP/IP sockets are created at the startup of sp_cop and the Export process.
If SharePlex is replicating across a WAN and the export queue is continually backlogged, try adjusting both parameters. SP_COP_SO_RCVBUF must be set equal to or greater than the value of SP_XPT_SO_SNDBUF, in multiples of 1024 bytes. To size the parameters, determine the ping time between the source and target machines, then use the following formula for both parameters:
param_value / ping_time= bytes per second
For example, if ping time is 200 milliseconds, and the value for the two parameters is 64K, SharePlex sends five 64K-packets every second, totaling 320K per second.
Unless you observe a bandwidth problem, Quest recommends leaving both parameters set to their defaults, which use the system's setting. To change SP_COP_SO_RCVBUF, set it on the target system, then stop and start sp_cop on that system.
If transfer still is slow, try increasing the SP_IMP_WCMT_MSGCNT and SP_IMP_WCMT_TIMEOUT parameters on the target system. Set SP_IMP_WCMT_MSGCNT to at least 10,000.
Default: 0 (default is set by the operating system)
Range of valid values: positive integers, in bytes, using multiples of 1024. Maximum is set by the operating system.
Takes effect: when SharePlex is restarted
SP_COP_TPORT
This parameter sets the TCP/IP port number for TCP/IP communications among Share- Plex sp_cop processes. All sp_cop processes replicating among each other must use the same TCP/IP port number. The default setting for SP_COP_TPORT is 2100; however, you may set a different port number during installation. After installation you may set a different port number by using the set port command. Thereafter, sp_cop uses the new port number.
Default: 2100
Range of valid values: any positive integer
Takes effect: when SharePlex is restarted
SP_COP_UPORT
This parameter sets the UDP port number for communication among SharePlex sp_cop processes. All sp_cop processes replicating among each other must use the same UDP port number. The default setting for SP_COP_UPORT is 2100; however, you may set a different port number during installation. After installation you may set a different port number by using the set port command. Thereafter, sp_cop uses the new port number.
Default: 2100
Range of valid values: any positive integer
Takes effect: when SharePlex is restarted
Log Parameters
These parameters are used to control properties of the SharePlex logs.
SP_SLG_LOG_MAXSIZE
This parameter controls the size of the SharePlex Event and Trace logs.
When the file reaches its maximum size, the following happens, depending on the log:
- The Event Log is renamed to event_log_n, where n is the next number in the sequence of files, and then a new file is created as the active event log. For example, when the first event log reaches its maximum size, it is renamed to event_log_0000000001 and then a new file is opened as the active log. When that file reaches its maximum size, it is renamed to event_log_0000000002, and so forth.
- The Trace Log is truncated. Before writing to this log, SharePlex checks its size. If the size is larger than the value of this parameter, SharePlex truncates the file before writing to it.
Before increasing this parameter, make certain that you have enough disk space to accommodate the new file size.
Default: 500 MB
Range of valid values: 1 to 2048 MB in increments of 1 MB
Takes effect: when SharePlex is restarted
SNMP Parameters
These parameters are used to control properties of SharePlex SNMP support.
SP_SLG_SNMP_ACTIVE
This parameter is a flag that enables or disables SNMP support.
SharePlex provides agent support for Simple Network Management Protocol (SNMP) on all Unix and Linux platforms supported by SharePlex replication.
Note: SharePlex provides only agent support for SNMP. It only sends SNMP traps. SharePlex does not provide an SNMP signal daemon (SNMP manager) to intercept the traps. Use the SharePlex SNMP feature only if you have a Network Management Station (NMS) to manage SNMP signals. The SharePlex SNMP agent is named snmptrap and is installed with SharePlex in the bin sub-directory of the SharePlex product directory. Do not run this program.
Default: 0 (off)
Range of valid values: 0 or 1 (on)
Takes effect: when SharePlex is restarted
SNMP agent parameters
The following parameters configure the SNMP agent to communicate with the NMS. Each parameter must have a value if the SP_SLG_SNMP_ACTIVE parameter is enabled.
| SP_SLG_SNMP_HOST |
The name of the system (host) to which the traps will be sent |
| SP_SLG_SNMP_COMMUNITY |
The community security string |
| SP_SLG_SNMP_MJR_ERRNUM |
The major error number to be used by the traps |
| SP_SLG_SNMP_MNR_ERRNUM |
The minor error number to be used by the traps |
Custom MIB parameters
The following parameters specify required information for a custom MIB.
| SP_SLG_SNMP_ENTERPRISE_OID |
The enterprise object identifier to send with the trap. The default is 1.3.6.1.4.1.3.1.1 . |
| SP_SLG_SNMP_TRAP_OID |
A custom object identifier to bind to the trap. The default is 1.3.6.1.2.1.1.1.0. |
| SP_SLG_SNMP_TRAP_PROGRAM |
The name of the trap program. The default is iwsnmptrap. |
SNMP trap parameters
The following parameters configure the SNMP agent to send traps for specific replication events. The message or error text for the event is included in the trap and is the same error that appears in the Event Log.
To enable an SNMP trap for an event, set the corresponding parameter to a value of 1. By default all traps are disabled (parameter value of 0).
| SP_SLG_SNMP_INT_ERROR |
SharePlex logic errors and errors that cause processes to exit |
| SP_SLG_SNMP_SYS_ERROR |
System-related errors encountered by SharePlex |
| SP_SLG_SNMP_ERROR |
Other SharePlex errors |
| SP_SLG_SNMP_OUT_OF_SYNC |
Replication is out of synchronization |
| SP_SLG_SNMP_STARTUP |
SharePlex starts up |
| SP_SLG_SNMP_SHUTDOWN |
SharePlex shuts down |
| SP_SLG_SNMP_LAUNCH |
A SharePlex process starts |
| SP_SLG_SNMP_EXIT |
A SharePlex process stops |
System Parameters
These parameters control system-related SharePlex properties.
SP_SYS_HOST_NAME
This parameter is for use in environments where one SharePlex variable-data directory is shared among multiple nodes, such as clusters and systems with alternate network interfaces. It provides SharePlex the correct logical host name (global cluster package name) when any of its processes issues a name lookup, superseding the local system name. The name set with this parameter enables SharePlex to migrate properly during failover.
- Set SP_SYS_HOST_NAME on the primary node and all secondary (adoptive) nodes before you activate the configuration, and configure it into the package that fails over.
- Set this parameter in the .profiles file on Unix and Linux systems.
- On Unix and Linux systems, set this parameter through sp_ctrl in the shared variable-data directory. Setting SP_SYS_HOST_NAME through sp_ctrl sets it permanently in the variable-data directory, which is part of the failover, and it ensures that the package name exports before sp_cop starts when you are ready to begin replication.
- Set SP_SYS_HOST_NAME only on machines within the cluster.
When you issue sp_ctrl commands from a system affecting a clustered machine, use the name set with SP_SYS_HOST_NAME as the host in the [onhost] option, or set it as the default for sp_ctrl by using the host command.
For more information about how to set up SharePlex on clustered systems, see the SharePlex Installation and Setup Guide.
Default: none
Range of valid values: the character string of the package name
Takes effect: when SharePlex is restarted
SP_SYS_IN_SYNC
This parameter controls the way that SharePlex replicates tables that have key columns where a NULL value is allowed.
- When this parameter is set to the default of 0 (off), SharePlex uses the key to locate rows on the target system, whether or not any of those columns contain NULLs. This can cause an out-of-sync condition for UPDATEs and DELETEs if the key for a row contains NULLs. The row’s uniqueness cannot be assured, and it is possible for SharePlex to change the wrong row on the target system.
- When this parameter is set to 1 (on), it directs SharePlex to use the key, but only if there are no NULLs in the row’s key. If the key contains a NULL value, SharePlex uses all of the columns in the row as a simulated key to ensure that it locates the correct target row.
If you know that the keys in your application will never contain NULLs (although NULLs were declared), leave this parameter off, because it incurs more overhead with the added logic that it uses. Set this parameter on the source system, and set it before you activate the configuration.
Default: 0 (off)
Range of valid values: 0 or 1 (flag)
Takes effect: when Capture and Read are restarted
SP_SYS_JOB_HISTORY_RETENTION
This parameter defines how many days information about past compare, compare using, repair, copy or append jobs will be kept for the job status and/or report commands to display.
Default: 90 days
Range of valid values: 0 or any positive integer
Takes effect: immediately
SP_SYS_JOB_HISTORY_SIZE
This parameter controls the size of the jobs status database, which resides in the data sub-directory of the SharePlex variable-data directory. The value specified determines the maximum size in kilobytes (kB) allowed for the database. When the database size exceeds the value specified, entries are deleted, oldest first. The default value is 0, specifying unlimited.
Default: 0 (unlimited)
Range of valid values: 0 or any positive integer
Takes effect: immediately
SP_SYS_SUSPEND_ON_ERROR
This parameter controls whether or not the Capture or Post process stops when it encounters a system or internal SharePlex error. The default of 1 directs the process to stop when there is an error. A setting of 0 directs the process to continue but generate a message in the Event Log.
Important: If Capture is stopped for too long, it can lose pace with Oracle, and the redo logs can wrap. If that happens, Capture reads the archive logs, but if the archive logs become unavailable, you will need to resynchronize the data.
Default: 1 (stop on errors)
Range of valid values: 0 or 1 (flag)
Takes effect: immediately
SP_SYS_TARGET_COMPATIBILITY
This parameter enables you to preserve compatibility between different versions of SharePlex to allow for smoother migrations and upgrades. As SharePlex continues to evolve to satisfy new user requirements, features or functionality added in a new version are not always compatible with previous versions. This parameter enables replication from a higher version of SharePlex on the source system to a lower version on a target system.
By default, this parameter is set to the version of the installed SharePlex software.
- When replicating from a higher version on a source system to a lower version of SharePlex on a target, set this parameter to a value that most closely matches the version of SharePlex on the target. For example, if SharePlex is version 8.6.3 on the source and 8.6.2 on the target, set this parameter to 8.6.2.
- When replicating between identical versions, leave this parameter set to the default on both systems.
Default: The version of the installed SharePlex software
Range of valid values: SharePlex release versions from 6.0.0 to the current version, up to three numbers long (for example 8.6.3).
Takes effect: when Capture is restarted
SP_SYS_VAR_FULL
This parameter sets a threshold for available space on the disk where the SharePlex variable- data directory is installed. It prevents the queues from exceeding available disk space. If an operation being processed by Capture, Read or Import will cause available disk space to drop below the value set for this parameter, the process stops. Processing resumes when available disk space reaches the threshold set with the SP_SYS_VAR_OK parameter.
Default: 30 MB
Range of valid values: any positive integer greater than the value of SP_SYS_VAR_OK
Takes effect: immediately
SP_SYS_VAR_OK
This parameter sets the amount of available disk space at which Capture, Read or Import resumes processing after it stopped because the value for SP_SYS_VAR_FULL was reached.
Default: 50 MB
Range of valid values: any positive integer
Takes effect: immediately
