Chat now with support
Chat with Support

SharePlex 11.3 - 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

authlevel

Use the authlevel command to determine your authorization level for issuing SharePlex commands on a system.

The following is an example of the display:

User is a viewer (level=3)

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: none

Syntax

Basic command Remote options
authlevel

[ 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

cancel

Use the cancel command to cancel a running compare, repair, copy or append command job.

To cancel a job, you must supply its job ID. The job ID is reported back from the compare, repair, copy or append job when you issue the command that starts it:

sp_ctrl> repair using 1elliot

repairing 7 of 7 objects

repair started; job id 408

Alternatively, you can get the job ID of the most recently streamed job by issuing the job status command:

sp_ctrl> job status

Job ID: 408

PID: 11527

Host: prodsys

Started: 22-FEB-15 18:08:09

Job Type: Repair

Status: Processing - 0 objects completed

Usage

Supported sources: Oracle
Supported targets: Oracle
Authorization level: Operator (2)
Issues on: source system
Related commands: compare, repair, copy, append

Syntax

Basic command Remote options
cancel job_id

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description
Component Description
jobID

The ID of the job to be canceled.

Example:

sp_ctrl>cancel 407

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

clear history

Use the clean history command to remove the information and logs from old compare, repair, copy, and append command jobs.

These jobs generate log files on the source and target systems. By default, the job information and log files are cleaned when the job is older than the value set with the SP_SYS_JOB_HISTORY_RETENTION parameter. The clear history command can be used to clear the job information and logs on demand for a specific job or table, or for all jobs that are of a specific age.

Usage

Supported sources: Oracle
Supported targets: Oracle
Authorization level: Operator (2)
Issues on: source system
Related commands: compare, repair, copy, append

Syntax

Basic command Command options Remote options

clear history

{ all |

source_owner.source_table |

age days |

jobID }

[for o.source_sid]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description
Component Description
all

Causes all job to be removed.

Example:

sp_ctrl(sysA)> clear history all

source_owner.source_table

Causes history for a particular table to be removed.

Example:

sp_ctrl(sysA)> clear history clear history user2.employee

age days

Causes the job history older than the specified number of days to be removed.

Example:

sp_ctrl(sysA)> clear history age 10

jobID Causes the history for the specified job id (obtained using the job status command) to be removed.
for o.source_sid

Optional. Can be used to employ the clear history command when there is no active configuration, or if there are more than one active configurations. In either case, the source SID must be specified using the for option.

Example:

sp_ctrl(sysA)>clear history all for o.source_sid1

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

clear status

Use the clear status command to remove old warning messages from the Status Database.

To use this command:

  1. Issue the show statusdb detail command to find out which messages can be cleared. Clearable messages have a Yes in the Clear column.
  2. If you don’t want to clear all messages, make a note of the status ID of each one that you want to clear.
  3. Issue the clear status command for each status ID, or use the all argument to remove all clearable messages at once.

SharePlex puts a message in the Event Log identifying the messages that were cleared.

This command clears messages from the Status Database for the default system. To clear messages from a Status Database on a different system, use the [on host] option.

Note: Some messages cannot be cleared.

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Operator (2)
Issued for: source or target system
Related commands: show statusdb

Syntax

Basic command Remote options
clear status {statusID| all}

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description
Component Description
statusID

The SharePlex-assigned ID of an individual message (obtained using the show statusdb command) that you want to remove.

Example:

sp_ctrl(sysA)>clear status 20

all

This argument removes all clearable messages.

Example:

sp_ctrl(sysA)>clear status all

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