help
Help command
Use the help command to get help for SharePlex commands while working within sp_ctrl.
- Using this command without any options produces a list of SharePlex command groups.
- Additional options enable you to drill down through each group to get help for a specific 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: |
usage |
Syntax
| help |
{group_name}
{command_name} |
Not available |
Syntax description
| group_name |
Displays the commands within each group for which specific help can be obtained. Valid values are:
config
connect
info
maint
misc
param
properties
queues
run
sync
For a list of commands within each group, see “SharePlex commands at a glance.”
Example:
sp_ctrl(sysA)> help run
Control processes
abort service - Stop one or all replication processes immediately.
shutdown - Shut down SharePlex.
start - Restart one or all stopped replication processes.
stop - Stop one or all replication processes gracefully. |
| command_name |
This option provides help for a designated command.
Example:
sp_ctrl(sysA)> help start
Restart a SharePlex process that was stopped with a "stop" or "abort service" command.
|
host
Host command
Use the host command to establish a default system for sp_ctrl. A default machine enables you to enter a series of commands without using the [on host] option for each one. The TCP/IP connection to the default system remains active until you exit sp_ctrl or issue another host command.
The default system name is displayed as part of the sp_ctrl prompt as shown below:
sp_ctrl(hostname)>.
The default system can be the machine where you are running sp_ctrl or any other system to which that machine can connect through TCP/IP.
To issue a command for a system other than the default, use the command’s [on host] option to temporarily connect to the alternate system. When the command finishes, it returns you to the default sp_ctrl connection.
The host command can only be issued from within sp_ctrl at the sp_ctrl prompt.
TIP: To set a default port number for an sp_ctrl session, use the port command.
Usage
| Supported sources: |
Oracle |
| Supported targets: |
All |
| Authorization level: |
Viewer (3) |
| Issued for: |
source or target system |
| Related commands: |
port |
Syntax
| host hostname |
[ on host |
on host:portnumber |
on login/password@host |
on login/password@host:portnumber ] |
Syntax description
| hostname |
The name of the machine that you want to establish as the default. This name must reside in your system’s /etc/hosts file (Unix and Linux) or hosts file (Windows).
Example: sp_ctrl(sysA)> host sysB |
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.
| 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 |
hostinfo
Hostinfo command
Use the hostinfo command to view information about a system’s hardware, including the operating system, machine name, OS version and revision.
Usage
| Supported sources: |
Oracle |
| Supported targets: |
All |
| Authorization level: |
Viewer (3) |
| Issued for: |
source or target system |
| Related commands: |
none |
Syntax
| hostinfo |
[ 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.
| 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 |
job status
Job status command
Use the job status command to view the status of the last compare, compare using, repair, repair using, copy or append job, and for any other jobs that are still running. The job status command can be used to view detailed status on a job or a portion of a job, or to view status on all jobs for which SharePlex has history. SharePlex retains the history for all jobs as specified by the SP_SYS_JOB_HISTORY_RETENTION parameter. See the clear history and remove log commands for information on actively removing history and/or job process logs.
sp_ctrl (sysA) > job status
| Job ID |
: 861 |
| PID |
: 20571 |
| Host |
: sysa.domm.com |
| Started |
: 06-NOV-12 11:07:05 |
| Job Type |
: Compare |
| Status |
: Processing - 4 objects completed |
| ID |
Tablename |
Status |
Time |
Total rows |
%Comp |
Total time |
| --- |
------------------------- |
-------- |
--------- |
------------------ |
------ |
----------- |
| 1 |
"SCOTT"."SRC_TEST1" |
Out Sync |
N/A |
19 |
100 |
0:05 |
| 4 |
"SCOTT"."SRC_TEST4" |
WaitMarker |
0:02 |
27392 |
|
0:04 |
| 5 |
"SCOTT"."SRC_TEST5" |
Init |
0:01 |
27498 |
|
0:01 |
To view a summary of all jobs for which SharePlex has history:
sp_ctrl (alvspxl11:8567)> job status all
| Job ID |
Type |
filename/tablename |
Status |
Started |
Completed |
| ------- |
------ |
------------------ |
-------- |
--------------- |
----------------- |
| 3441 |
Compare |
prod.conf |
Done - errors |
16-DEC-11 15:39 |
16-DEC-11 15:40 |
| 3442 |
Repair |
scott.src_test4 |
Done |
16-DEC-11 15:50 |
16-DEC-11 15:50 |
| 3443 |
Repair |
prod.conf |
Done |
19-DEC-11 10:42 |
19-DEC-11 10:42 |
| 3444 |
Copy |
"SCOTT"."SRC_TEST5" |
Done |
19-DEC-11 10:43 |
19-DEC-11 10:43 |
| 3445 |
Compare |
scott.src_test33 |
Done - errors |
20-DEC-11 12:02 |
20-DEC-11 12:03 |
To view the status of a job with detail:
sp_ctrl (alvspxl11:8567)> compare status detail
| Job ID |
: 3448 |
| PID |
: 763 |
| Host |
: sysa.domm.com |
| Started |
: 20-DEC-11 12:40:46 |
| Job Type |
: Compare |
| Status |
: Done - 6 objects completed |
| Table ID |
: 3448.3 |
| Table |
: "SCOTT"."SRC_TEST3" |
| From |
: sysa.domm.com@o.w111a64f |
| To |
: "SYSPROD"."SRC_TEST3" sysb.domm.com@o.w111a64f |
| Started |
: 20-DEC-11 12:40:55 |
| Percent complete |
: 100% |
| Total Rows |
: 234452 |
| Rows processed |
: 234452 |
| Rows out-of-sync |
: 2 |
| Status |
: Out Sync |
| Status Elapsed |
: N/A |
| Total Elapsed |
: 0:07 |
| Inserts |
: 2 |
| Updates |
: 0 |
| Deletes |
: 0 |
Usage
| Supported sources: |
Oracle |
| Supported targets: |
Oracle |
| Authorization level: |
Operator (2) |
| Issued for: |
source system |
| Related commands: |
copy status, append status, compare status, repair status |
Syntax
| job status |
[job_id]
[job_id.table_id]
[all]
[full]
[detail]
[status] |
[ on host |
on host:portnumber |
on login/password@host |
on login/password@host:portnumber ] |
Syntax description
| job_id |
Displays status history for the job with the specified SharePlex-assigned job ID.
Example: sp_ctrl(sysA)> job status 2828.2 |
| job_id.table_id |
Displays status history for the job with the specified SharePlex-assigned job ID and table.
Example: sp_ctrl(sysA)> job status 2828.HR.SRC_TEST3 |
| all |
Displays a summary line for every job with history in the database.
Example:
sp_ctrl(sysA)> job status all |
| full |
Displays the status of every object in the job. By default, the job status command displays the status of those objects not completed, or completed with an exceptional status.
Example: sp_ctrl(sysA)> job status2828 full |
| detail |
Displays detail information for every object reported upon. By default, the job status command displays a summary line for every object reported upon. Note that the detail information is the same as is displayed for the job_id.table_id option.
Example: sp_ctrl(sysA)> job status detail |
| status |
Displays status history for previous jobs with the specified status.
sp_ctrl(SysA)> job status “Error” |
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.
| 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 |
