SharePlex 9.2.6 - Reference Guide

About this guide Conventions used in this guide SharePlex commands

SharePlex commands at a glance Alphabetical reference for SharePlex commands

abort config abort service activate config add partition analyze config append status authlevel cancel clear history clear status compare / compare using compare status connection copy/append copy cache copy config copy status create config create encryption key deactivate config delete capture queue delete export process delete export queue delete post queue disable jobs / enable jobs drop partition drop partition scheme edit edit config exit expand flush help host hostinfo job status list config list param lstatus modify partition orainfo port purge config qstatus quit reconcile redo remove config remove log rename config repair / repair using repair status report reset encryption key reset param set encryption key set log set param show show capture show config show encryption key show export show import show log show post show read show sql show statusdb show scn show sync shutdown start startup status stop target trace capture trace post trace read truncate log typemap usage verify config version view config view log options view partitions

SharePlex parameters

Descriptions of user-configurable parameters

Configuration Parameters Oracle Capture Parameters Read Parameters Export Parameters Import Parameters Oracle Post Parameters Open Target Post Parameters Queue Parameters sp_cop Parameters Log Parameters SNMP Parameters System Parameters Compare/Repair Parameters Sync Parameters Analyze Config Command Parameters

Deprecated Parameters

General SharePlex utilities Database Setup utilities

HANA Setup (hana_setup) MySQL Setup (mysql_setup) Oracle Setup (ora_setup) PostgreSQL Setup (pg_setup) SQL Server Setup (mss_setup) Teradata Setup (td_setup)

SharePlex environment variables

copy config

SharePlex commands > Alphabetical reference for SharePlex commands > copy config

Use the copy config command to copy a configuration file and save the copy under a different file name. Copying the configuration allows you to:

Save a replica for backup purposes
Use the copy as the basis for composing a new configuration using the edit config command
Change an active configuration. You can make your changes to the copy with the edit config command while replication under the current configuration continues, and then activate the new configuration when you are ready.

This command copies the configuration to the same source system as the original configuration. To copy a configuration file to a different system, you can transfer the file via tape, CD, or FTP.

To see a list of configurations on a system, use the list config command. To view the contents of a configuration, use the view config command.

Usage

Supported sources:	Oracle
Supported targets:	All
Authorization level:	Operator (2)
Issues on:	source system
Related commands:	activate config, create config, edit config, list config, remove config, rename config, show config, verify config view config

Syntax

Basic command	Remote options
copy config filename to newname	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Remote options

copy config filename to newname

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax Description

Component	Description
filename to newname	filename is the name of the configuration that you want to copy. Configuration names are case-sensitive. to is a required part of the syntax. newname is the name you are giving to the copy. It must be unique among configurations on the system. Example: sp_ctrl(sysA)> copy config sales to sales2

Component

Description

filename to newname

filename is the name of the configuration that you want to copy. Configuration names are case-sensitive.
to is a required part of the syntax.
newname is the name you are giving to the copy. It must be unique among configurations on the system.

Example:

sp_ctrl(sysA)> copy config sales to sales2

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

copy status

SharePlex commands > Alphabetical reference for SharePlex commands > copy status

Use the copy status command to view the status of the last copy or append job run. The copy status command can be used to view detailed status on a copy or append job or a portion of a copy or append job, or to view status on all copy and append jobs for which SharePlex has history.

For details and examples about using the copy status command, see the job status command.

Usage

Supported sources:	Oracle
Supported targets:	Oracle
Authorization level:	Viewer
Issued for:	source or target
Related commands:	append status

Syntax

Basic command	Command options	Remote options
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 ]

Basic command

Command options

Remote options

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

Component	Description
job status	Without options, the command shows the status of all jobs for which SharePlex has history.
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.

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

create config

SharePlex commands > Alphabetical reference for SharePlex commands > create config

Use the create config command to create a new configuration file. This command runs the SharePlex default text editor and opens a new file. To create a configuration, follow the instructions in Chapter 5 of the SharePlex Administrator’s Guide.

If you attempt to give a new configuration the same name as an existing configuration, SharePlex returns this error message “The parameter for create config must be a new filename.”

As an alternative to creating a configuration, you can use the copy config command to duplicate an existing configuration and then use the edit config command to edit the copy.

Usage

Supported sources:	Oracle
Supported targets:	All
Authorization level:	Operator (2)
Issues on:	source system
Related commands:	activate config, copy config, edit config, list config, remove config, show config, verify config, view config

Syntax

Basic command	Remote options
create config filename	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Remote options

create config filename

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component	Description
filename	The name of the configuration that you want to create. Configuration names are case-sensitive. The name must be unique among configurations on the system. Example: sp_ctrl(sysA> create config sales

Component

Description

filename

The name of the configuration that you want to create. Configuration names are case-sensitive. The name must be unique among configurations on the system.

Example:

sp_ctrl(sysA> create config sales

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

create encryption key

SharePlex commands > Alphabetical reference for SharePlex commands > create encryption key

Use the create encryption key command to create an encryption key for SharePlex to use to encrypt data across the network. SharePlex uses Advanced Encryption Standard (AES) encryption.

The create encryption key command returns a randomly generated, 256-bit AES key. By default, SharePlex uses 128 bits of that length to encrypt the data.

To increase the key length that SharePlex uses, set the SP_XPT_AES_KEY_LENGTH parameter to 192 or 256 bits. When you increase the length, the key is harder to hack but requires more CPU power.

sp_ctrl> set param sp_xpt_aes_key_length {192 | 256}

Example: set param sp_xpt_aes_key_length 256

The following is an example key: E5F5D4CBA329D2C86B5D7ABA096C18600595490129F55A1422AAB0248B28D0E4.

Usage

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

Syntax

Basic command	Remote options
create encryption key	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Remote options

create encryption key

[ 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

Documentos relacionados

The document was helpful.

Selecione a classificação

I easily found the information I needed.

Selecione a classificação

Selecione seu produto:

Para podermos atendê-lo melhor, informe o Propósito de seu chat:

Soluções recomendadas para seu problema

SharePlex 9.2.6 - Reference Guide

copy config

Usage

Syntax

Syntax Description

Remote options

copy status

Usage

Syntax

Syntax description

Remote options

create config

Usage

Syntax

Syntax description

Remote options

create encryption key

Usage

Syntax

Remote options