To monitor, control, or change SharePlex replication, a person must be assigned to one of the SharePlex security groups on the systems where he or she will be issuing commands. Each group corresponds to an authorization level, which determines which SharePlex commands a person can issue. To execute a command, a user must have that command’s authorization level or higher.
Use the authlevel command to determine your authorization level for issuing SharePlex commands on a system.
Refer to the following table to determine the group and authorization level that you want to grant each SharePlex user.
| Auth level | User type | User group | User roles |
|---|---|---|---|
| 1 | Administration | spadmin* |
You need at least one user with Administrator rights on each source and target system. Can issue all SharePlex commands. Commands that can only be issued by a SharePlex Administrator are:
The SharePlex Administrator user must be in the Oracle dba group. For Oracle RAC and ASM 11gR2 and above, the user must also be in the Oracle Inventory group. For example: $ useradd –g spadmin –G dba,oinstall. The membership in Oracle Inventory group must be listed explicitly in the etc/group file. On Unix and Linux, unless you install SharePlex as a root user, the SharePlex Administrator user and the SharePlex admin group must exist prior to installation. |
| 2 | Operator | spopr | Can issue all SharePlex commands except those listed above. |
| 3 | Viewer | spview | Can view lists, status screens, and logs to monitor replication only. |
Note: The default name for the SharePlex administrator group is spadmin, but you can designate any group or specify any name for that group during installation.
For information about how to create SharePlex security groups, see the SharePlex Administration Guide.
This starts the detailed reference documentation for SharePlex commands in alphabetical order.
Use the abort config command to deactivate a configuration instantly and delete all associated queues and replication processes at the same time. This command stops all replication activity for the configured datasource on the source and target systems, whether or not data in the queues has been posted. It is a forceful deactivation.
The abort config command is effective when there has been a system, configuration, or data problem and you need to prevent posting to the target system(s). Because you are deleting whatever data remains in the pipeline, the source and target instances will go out of synchronization after this command takes effect.
If any SharePlex replication process stops before or during the abort config command, the command also stops. When the process starts again, the command resumes working. This allows abort config to work even if the network is temporarily down — it remains in the queues until the connection is restored.
If there are multiple active configurations on the same source system, use the abort config command only if there are named export queues that separate the replication streams for each one. Without named export queues, SharePlex funnels all replicated data through one export queue, and an abort config command for one configuration deletes the data for all of them. To create named queues, see Chapter 5 of the SharePlex Administrator’s Guide.
| Supported targets: | All |
| Authorization level: | Administrator |
| Issues for: | source system |
| Related commands: | deactivate config, purge config |
| Basic command | Remote options |
|---|---|
| abort config filename |
[ on host | on host:portnumber | on login/password@host | on login/password@host:portnumber ] |
| Component | Description |
|---|---|
| filename |
The name of the configuration that you want to abort. Configuration names are case-sensitive. Example: sp_ctrl(sysA)> abort config sales |
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 |
Use the abort service command to terminate a SharePlex replication process (service) immediately, whether or not that process has finished reading from, or writing to, its queues. This command is effective when you cannot wait for a process to stop gracefully, or in unusual circumstances when a process will not shut down when you issue the stop command.
This command does not affect replicated data. The data remains safely in the queues, and SharePlex resumes normal processing when the process is started again.
A process aborted with the abort service command remains stopped even if SharePlex is shut down and re-started. Only the start command can start it again.
The abort service command provides options with which you can abort a process for any (or all) systems, or for a named queue, without affecting replication for other routes.
| Supported targets: | All |
| Authorization level: | Operator (2); Administrator (1) to abort Capture |
| Issues for: |
abort service for Capture, Read and Export are issued for the source system. abort service for Import and Post are issued for the target system. |
| Related commands: | start, stop |
| Basic command | Command options | Remote options |
|---|---|---|
| abort service service |
[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 ] |
| Component | Description |
|---|---|
| service |
Required. The SharePlex replication process you want to abort. Valid values are: capture read export import post |
| to host |
This option aborts Export to a designated system, while allowing Export to other systems to continue.
Example: sp_ctrl(sysA)> abort service export to sysB In this example, Export is aborted from sysA to sysB, but other Export processes from sysA to other target systems will continue. |
| from host |
This option aborts Import from a designated system, while allowing Import from other systems to continue. • host is the name of the source system. Example: sp_ctrl(sysD)> abort service import from sysC In this example, Import from sys C is aborted on sysD, but other Import processes on sysD from other source systems will continue. |
| for datasource |
This option aborts Capture or Read for a designated datasource, but other replicating datasources on the same system are unaffected.
Example: sp_ctrl(sysA)> abort service read for o.oraA In this example, Read is aborted on sysA for instance oraA, but other Read processes for other instances on sysA will continue. |
| for datasource-datadest |
This option aborts Post for a designated source SID-target SID data stream, while allowing other Post activities to continue.
Example: sp_ctrl(sysC)> abort service post for o.oraA-o.oraC In this example, Post is aborted on sysC for instance oraA replicating to oraC, but other Post processes on sysC will continue. |
| queue queuename |
This option aborts the Export, Import or Post process associated with a named queue, while allowing replication through other named queues to continue.
Example: sp_ctrl(sysA)> abort service export queue QA In this example, Export of data through named export queue QA is aborted on sysA, but Export will continue for data assigned to all other named queues. |
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 |
© 2021 Quest Software Inc. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy
