Chat now with support
Chat with Support

SharePlex 9.2.5 - Reference Guide

About this guide Conventions used in this guide SharePlex commands SharePlex parameters General SharePlex utilities Database Setup utilities SharePlex environment variables

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 and SQL Server
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 and SQL Server
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 and SQL Server
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

show

Use the show command to view the replication processes for an instance of sp_cop and the path the data is taking.

The following describes each column in the show command display:

Process

The Process column shows the SharePlex replication processes (services) spawned by the instance of sp_cop to which the current sp_ctrl session is connected. The command does not show the command and control process (sp_cnc) or any compare processes that are running.

  • If there are named export queues, there are multiple Export or Import processes, depending on whether it is a source or target sp_cop.
  • If there are named post queues, there are multiple Post processes, one for each queue.
  • The Post process is labeled MTPost.
  • For an instance of sp_cop running peer-to-peer replication, or for those that serve as both source and target sp_cop instances, all SharePlex replication processes are present.

Source

The Source column shows the source of the data being processed by a SharePlex process. A source can be one of the following:

  • For a Capture or Read process: the datasource (the source Oracle instance).
  • For an Export process: the name of the associated export queue. Default export queues bear the name of the source system. Named export queues bear their userassigned names, for example exptq1.
  • For an Import process: the name of the associated default export queue (for example, sysA), or the name of the associated named export queue, such as exptq1.
  • For a Post process: There can be one of several displays for the source of a Post process, depending on the replication configuration:
    • When there is a default export queue and a default post queue, the Post source is the short name of the associated post queue. The short name consists of the datasource and the source system’s name, in the format of o.ora10-elliot.
    • When there is a named export queue (which automatically creates a named post queue on the target system) the Post source consists of the datasource and the named export queue’s name, in the format of o.ora10-exptq1.
    • When there is a default export queue and a named post queue, the Post source consists of the datasource and the named post queue’s name, for example o.ora10- postq1.

Target

The Target column shows the destination, or target, of the data being processed by a SharePlex process. A target can be one of the following:

  • For a Capture or Read process: There is no target to show for these processes. The data captured by the Capture process and routed by the Read process can be routed to one or many destinations.
  • For an Export process: the name of the target system.
  • For an Import process: the name of the target system.
  • For a Post process: the target.

State

The State column shows the status of each process:

  • Running
  • Idle (waiting for data to process)
  • Stopped by a user
  • Stopped because of an error.

PID

This column lists the process ID number for each process.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: lstatus, qstatus, status

Syntax

Basic command Remote options
show

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

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