Chat now with support
Chat with Support

SharePlex 11.2 - Reference Guide

About this guide Conventions used in this guide Revision History SharePlex Commands for Oracle SharePlex Commands for PostgreSQL SharePlex parameters General SharePlex utilities Oracle Cloud Infrastructure SharePlex environment variables

reset param

Use the reset param command to restore a parameter to its default value.

The change takes effect based on the parameter’s set-at point:

  • For a set-at point of Live, the change takes effect immediately.
  • For a set-at point of Restart Process, the change takes effect the next time the affected SharePlex process is started.
  • For a set-at point of Restart Cop, the change takes effect the next time sp_cop is started (do not reboot the system).

Using command options

The following are guidelines for resetting SharePlex parameters:

  • To reset a parameter that was set with the set param command on a global basis (without process-specific options), use the reset param command without options.
  • To reset a parameter that has a process-specific value (set with one of the set param process-specific options), use one of the reset param process-specific options. Process- specific options can be used for parameters in the following modules:
Module Naming convention Function controlled
export SP_XPT Export process
import SP_IMP Import process
capture SP_OCT Capture process
post SP_OPO Post process
read SP_ORD Read process
     

Viewing current parameter settings

To view the names of SharePlex parameters, their values and set-at points, and whether or not process-specific values are in effect, use the list param command, as shown in the following example which shows both a global value for the Export process and a process-specific value for Export to sysB.

 

 

Parameter name Actual value Unit Set at
---------------------- --------------------- ------------ ------------
SP_XPT_SO_SNDBUF 0 bytes Restart Process

SP_XPT_SO_SNDBUF

1024 bytes Restart Process

To sysB.ABC.com

Default Value: 0

     

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Administrator (1)
Issued for: source or target system
Related commands: list param, set param

Syntax

Basic command Process-specific options Remote options
reset param {paramname

[to host]

[from host]

[for datasource]

[for datasource-datadest]

[queue queuename]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Important: Before you begin using this command, please review all of this documentation. Improper use could result in lost target data and out-of-sync conditions.

Syntax description
Component Description
paramname

The name of the parameter that you want to restore to its default value. This argument is not case-sensitive.

Example:

sp_ctrl(sysA)> reset param SP_XPT_SO_SNDBUF

This resets the parameter for all Export processes on the system.

Process-specific command options
Option Description
to host

This option resets an Export parameter (SP_XPT_) for the Export processes to a designated target system. To restrict the command’s effect to the Export process associated with a named export queue, follow this option with the [queue queuename] option.

Example:

sp_ctrl(sysA)> reset param sp_xpt_so_sndbuf to sysB

In this example, the parameter is reset for Export to sysB, but other Export processes are not affected.

from host

This option resets an Import parameter (SP_IMP_) for the Import processes from a designated source system. To restrict the command’s effect to the Import process associated with a named export queue, follow this option with the [queue queuename] option.

Example:

sp_ctrl(sysD)> reset param sp_imp_wcmt_msgcnt from sysC

In this example, the parameter is reset for Import from sys C, but other Import processes are not affected.

fordatasource

This option resets a Capture or Read parameter (SP_OCT_ or SP_ORD_) for a designated source Oracle instance.

  • datasource is expressed as o.SID, where SID is the ORACLE_SID of the source instance.

Example:

sp_ctrl(sysA)> reset param sp_oct_replicate_dload for o.oraA

In this example, the parameter is reset for the Capture process for instance oraA, but other Capture processes are not affected.

for datasource-datadest

This option resets a Post parameter (SP_OPO_) for all Post processes posting data from one database to another. To restrict the command’s effect to the Post process associated with a named post queue, follow this option with the [queue queuename] option.

  • datasource is expressed as o.SID, where SID is the ORACLE_SID of the source instance.
  • datadest is expressed as o.SID, where SID is the ORACLE_SID of the target instance.

Example:

sp_ctrl(sysC)> reset param sp_opo_cont_on_err for o.oraA-o.oraC

In this example, the parameter is reset for the Post process for instance oraA replicating to oraC, but other Post processes are not affected.

queue queuename

This option resets a parameter for an Export, Import or Post process associated with a designated named queue.

Example:

sp_ctrl(sysA)> reset param sp_opo_poster_delay queue QA

In this example, the parameter is reset for the Post process associated with named post queue QA, but other Post processes are not affected.

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example:sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

set encryption key

Use the set encryption key command to configure the Export and Import processes to use the AES encryption key that is generated with the create encryption key command.

The encryption key must be set with this command on the source and target systems.

For more information about configuring AES encryption, see the SharePlex Administration Guide.

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Operator (2)
Issues on: source system
Related commands: create encryption key, show encryption key, reset encryption key

Syntax

Basic command Remote options
set encryption key key_value

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description
Component Description
key

The encryption key that was generated by the create encryption key command.

Example:

sp_ctrl> set encryption key E5F5D4CBA329D2C86B5D7ABA096C18600595490129F55A1422AAB0248B28D0E4

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example:sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

set log

Use the set log command to set the default parameters for the show log command. This command sets defaults for:

  • The maximum number of lines to extract from the log.
  • The maximum number of lines to display at once on the screen.
  • The direction in which you want to view the entries (newest to oldest, or oldest to newest).

You can set any, or all, of those parameters at once with this command. There are no [on host] options for this command.

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: show log, view log options

Syntax

Basic command Remote options
set log {maxlines=number | lpp=number | reverse | forward} Not available
Syntax description
Component Description
filespec

This argument specifies the wildcarded Oracle object (including schema owner) that the command will execute against. Without the for datasource option it assumes that the schema and objects are in replication and are contained within the active configuration.

Example:

sp_ctrl(sysA)> expand scott.%

In this example, the result will display all objects in the scott schema.

maxlines=number

Use this option to set the default for the maximum number of lines of a log that the show log command displays. This option can be used alone or in combination with any other set log command options.

Examples:

sp_ctrl(sysA)> set log maxlines=50

sp_ctrl(sysA)> set log maxlines=50 lpp=34 reverse

lpp=number

Use this option to set the default for the number of lines per screen for the show log command. This option can be used alone or in combination with any other set log command options.

Examples:

sp_ctrl(sysA)> set log lpp=34

sp_ctrl(sysA)> set log maxlines=50 lpp=34 reverse

reverse

Use this option to start the show log output with the most recent entries. This option can be used alone or in combination with any other set log command options.

Examples:

sp_ctrl(sysA)> set log reverse

sp_ctrl(sysA)> set log maxlines=50 lpp=34 reverse

forward

Use this option to start the show log output with the oldest entries. This option can be used alone or in combination with any other set log command options.

Examples:

sp_ctrl(sysA)> set log forward

sp_ctrl(sysA)> set log maxlines=50 lpp=34 forward

   

set param

Use the set param command to change the value of a SharePlex parameter.

The new setting takes effect based on the parameter’s set-at point:

  • For a set-at point of Live, the change takes effect immediately.
  • For a set-at point of Restart Process, the change takes effect the next time the affected SharePlex process is started.
  • For a set-at point of Restart Cop, the change takes effect the next time that sp_cop is started. Do not reboot the system.
Changing a parameter from its default value

When you change a parameter from its default value, SharePlex records the change in the variable-data directory, where all user-defined parameter values are stored. Default values are stored in the param-defaults file in the product directory.

The default settings of most SharePlex parameters are adequate for most replication operations, but some can be changed by an authorized SharePlex user when necessary. Those parameters are viewed with the list param basic command.

The rest of the parameters are considered non-user-changeable. They are viewed with the list param all command. Do not change those parameters without the supervision of Quest Development or Technical Support team, or unless you are following a documented procedure in a SharePlex guide. Unless you are familiar with those parameters, changing them could adversely affect replication.

Using command options

The following explains how to use the set param command options:

  • The basic set param command (without options) sets a parameter on a global basis for an instance of sp_cop. For example, the following command sets the parameter for all of the Export processes spawned by one instance of sp_cop.

    sp_ctrl(sysA)> set param SP_XPT_SO_SNDBUF 1024

  • Parameters for the following replication processes can be process-specific, which enables you to set different values for the same parameter to accommodate multiple instances of a process running from one instance of sp_cop.
Module Naming convention Function controlled
export SP_XPT Export process
import SP_IMP Import process
capture SP_OCT Capture process
post SP_OPO Post process
read SP_ORD Read process
     

You can use a process-specific value in conjunction with a global value for the same parameter. For example, you could set SP_XPT_SO_SNDBUF globally for all Export processes except the one transmitting to SysC; for that one you could set a different value by using the [to host value] process-specific option.

Viewing current parameter settings

To view the names of SharePlex parameters, their values and set-at points, and whether or not process-specific values are in effect, use the list param command, as shown in the following example which shows both a global value for the Export process and a process-specific value for Export to sysB.

 

Parameter name Actual value Unit Set at
---------------------- --------------------- ------------ ------------
SP_XPT_SO_SNDBUF 0 bytes Restart Process

SP_XPT_SO_SNDBUF

1024 bytes Restart Process

To sysB.ABC.com

Default Value: 0

     
Changing a parameter back to its default value

To change the value of a parameter back to its default value, use the reset param command.

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Administrator (1)
Issued for: source or target system
Related commands: list param, reset param

Syntax for global settings

Basic command Remote options
set param paramname value

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax for process-specific settings

Basic command Command options Remote options

set param {

paramname to host value |

paramname from host value |

paramname for datasource value |

paramname for datasource-datadest value

}

[queue queuename]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description for global settings
Component Description
paramname value
  • paramname is the name of the parameter that you want to set. This argument is not case-sensitive.
  • value is the new value for the parameter.

Example:

sp_ctrl(sysA)> set param SP_XPT_SO_SNDBUF 1024

In this example, the parameter is set globally for all Export processes

on the system.

Syntax description for process-specific settings
Component Description
to host value

This option sets an Export parameter (SP_XPT_) for all Export processes to a designated target system. To constrain the change to an Export process associated with a named export queue, use this option with the [queue queuename] option.

  • host is the target system’s name.
  • value is the new value for the parameter.

Example:

sp_ctrl(sysA)> set param sp_xpt_so_sndbuf to sysB 1024

In this example, the parameter is set for Export to sysB, but Export processes to other target systems are not affected.

from host value

This option sets an Import parameter (SP_IMP_) for all Import processes from a designated source system. To constrain the change to an Import process associated with a named export queue, use this option with the [queue queuename] option.

  • host is the source system’s name.
  • value is the new value for the parameter.

Example:

sp_ctrl(sysD)> set param sp_imp_wcmt_msgcnt from sysC 10000

In this example, the parameter is set for Import from sys C, but Import processes from other source systems are not affected.

for datasource value

This option sets a Capture or Read parameter (SP_OCT_ or SP_ORD_) for a designated datasource.

  • datasource is expressed as o.SID, where SID is the ORACLE_SID of the source Oracle instance.
  • value is the new parameter value.

Example:

sp_ctrl(sysA)> set param sp_oct_replicate_dload for o.oraA 1

In this example, the parameter is set for Capture for instance oraA, but other Capture processes for the same instance of sp_cop are not affected.

for datasource-datadest value

This option sets a Post parameter (SP_OPO_) for all Post processes posting data from one database to another. To constrain the change to a Post process associated with a named post queue, use this option with the [queue queuename] option.

  • datasource is expressed as o.SID, where SID is the ORACLE_SID of the source Oracle instance.
  • datadest is expressed as o.SID, where SID is the ORACLE_SID of the target Oracle instance.
  • value is the new parameter value.

Example:

sp_ctrl(sysC)> set param sp_opo_cont_on_err for o.oraA-o.oraC 1

In this example, the parameter is set for the Post process for instance oraA replicating to oraC, but other Post processes are not affected.

queue queuename

This option restricts the command’s effect to an Export, Import or Post process associated with a named queue.

  • queuename is the named queue’s name.

When used, the queue queuename option must appear after the required and optional syntax, but before the new value, as shown below:

Example 1: Export process

sp_ctrl(sysA)> set param sp_xpt_so_sndbuf queue QA to sysB 1024

In this example, the parameter is set for the Export process associated with named export queue QA, but other Export processes are not affected.

Example 2: Import process

sp_ctrl(sysD)> set param sp_imp_wcmt_msgcnt from sysC queue QA 10000

In this example, the parameter is set for the Import process associated with named export queue QA, but other Import processes are not affected.

Example 3: Post process

sp_ctrl(sysC)> set param sp_opo_cont_on_err queue QA for o.oraA-o.oraC 1

In this example, the parameter is set for the Post process associated with named post queue QA for replication between oraA and oraC, but other Post processes are not affected.

Example 4: Post process

sp_ctrl(sysC)> set param sp_opo_cont_on_err queue QA 1

In this example, the parameter is set for the Post process associated with named post queue QA, but other Post processes are not affected.

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example:sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating