Configuration parameter reference

Table 2-1 lists all of the Replication Agent configuration parameters and a brief description of each parameter. The target column indicates when the parameter is used for “All” targets or specific targets; Oracle, Microsoft SQL Server (MSSQL), or DB2 UDB (UDB).

Table 2-1: Replication Agent configuration parameters

Parameter name

Target

Description

admin_port

All

Port number that the Replication Agent will use to listen for administrative connections.

archive_read_block_count

Oracle

Determines the number of blocks or pages that are read at a time from the primary database archive log.

asm_password

Oracle

Password for Oracle Automatic Storage Management (ASM) access for the user specified in the asm_username.

asm_tns_connection

Oracle

Identifies the Oracle ASM connection name found in the tnsnames.ora file.

asm_tns_filename

Oracle

Identifies the Oracle tnsnames.ora filename where the ASM connection information is located.

asm_username

Oracle

Identifies the Oracle user name to be used when connecting to the ASM server.

auto_adjust_block_count

Oracle MSSQL

Determines whether or not the Replication Agent should automatically adjust the log_read_block_count parameter if any part of a read is discarded

column_compression

All

Use minimal column information in LTL.

compress_ltl_syntax

All

Use abbreviated LTL syntax.

connect_to_rs

All

Enable/disable connection from LTI to Replication Server.

ddl_password

Oracle MSSQL

Password for ddl_username.

ddl_username

Oracle MSSQL

The database user name included in LTL for replicating DDL commands to the replicate database.

dump_batch_timeout

All

Number of seconds to wait before sending an incomplete LTL buffer to Replication Server.

filter_maint_userid

All

Log Reader filters operations with maintenance user ID.

function_password

Oracle MSSQL

Password for user ID passed in LTL with replicated stored procedure invocations.

function_username

Oracle MSSQL

User ID passed in LTL with replicated stored procedure invocations.

log_backup_files

All

Determines the number of log backup files kept in the log directory.

log_directory

All

Directory where Replication Agent system log file is located.

log_read_block_count

Oracle MSSQL

Determines the number of blocks or pages that are read at a time from the primary database transaction log.

log_trace_verbose

All

Switch on/off verbose mode in trace log file.

log_wrap

All

Number of 1KB blocks written to log file before wrapping.

lr_ntext_byte_order

Oracle MSSQL

Specifies which byte order to use when replicating NCLOB for Oracle, and NTEXT for Microsoft SQL Server.

lr_send_trunc_partition_ddl

Oracle

Determines whether truncate partition commands are sent as DDL or DML to the replicate database.

lti_batch_mode

All

Switches on/off LTI batch mode.

lti_max_buffer_size

All

Maximum number of change sets stored in the LTI input buffer.

lti_update_trunc_point

All

Number of LTL commands sent before LTI requests new LTM Locator.

ltl_batch_size

All

Size of the LTL batch buffer.

ltl_big_endian_unitext

All

Specifies whether unicode LOB data should be converted from little endian to big endian before sending LTL to Replication Server.

ltl_character_case

All

Case of database object names sent to Replication Server.

ltl_origin_time_required

All

Specifies whether to send origin_time command tag in LTL.

ltl_send_only_primary_keys

All

Controls whether the Replication Agent sends only primary key columns data for the before image for update and delete operations.

ltm_admin_pw

All

Password for Replication Agent administrative port.

ltm_admin_user

All

User ID for Replication Agent administrative port.

max_ops_per_scan

All

Maximum number of operations Log Reader will read in a single log scan.

pdb_archive_path

Oracle UDB

Identifies the directory path where the Replication Agent expects to find archived Oracle redo log files or the archived UDB transaction log files.

pdb_archive_remove

Oracle UDB

Enables or disables the removal of archived transaction log files from the path specified by pdb_archive_path.

pdb_auto_create_repdefs

Oracle MSSQL

If set to true, when tables and procedures are marked for replication, a replication definition is automatically created at Replication Server for that table or procedure.

pdb_automark_tables

Oracle MSSQL

Determines if the Replication Agent automatically marks tables for replication during initialization or DDL replication.

pdb_auto_run_scripts

All

Automatic execution of SQL scripts used to create/remove transaction log objects and mark/unmark primary database objects.

pdb_convert_datetime

All

Converts native date/time formats to Sybase datetime format.

pdb_dflt_column_repl

All

Enables replication for LOB columns by default when table is marked.

pdb_dflt_object_repl

Oracle UDB

Enables replication by default when object is marked.

pdb_include_archives

Oracle

Enables or disables the use of Oracle archive log files.

pdb_support_large_identifier

All

To support replication of large identifiers up to 255 characters in length with Replication Server 12.6 or later.

pdb_timezone_file

Oracle

Specifies the file to read at Replication Agent initialization to obtain Oracle time zone information.

pdb_xlog_device

All

Name of the primary database device.

pdb_xlog_prefix

All

Character string prefix used to identify transaction log objects.

pdb_xlog_prefix_chars

All

Non-alphabetic characters allowed in pdb_xlog_prefix.

pds_connection_type

All

Type of connection to primary data server.

pds_dac_port_number

MSSQL

The primary database dedicated administrative connection port number used by Replication Agent during the server level initialization of the primary database.

pds_database_name

All

Name of database replicated from the primary data server.

pds_datasource_name

UDB

Data source name or database alias of the database replicated from the primary data server.

pds_host_name

All

Name of primary data server host machine.

pds_integrated_security

MSSQL

Determines if the Replication Agent should use Windows authentication when connecting to the primary SQL Server.

pds_password

All

Password for user ID that the Replication Agent uses to access the primary data server.

pds_port_number

All

Port number for the primary data server.

pds_retry_count

All

Number of times to retry connection to primary data server.

pds_retry_timeout

All

Number of seconds to wait between connection retry attempts.

pds_server_name

All

Server name of primary data server.

pds_tns_connection

Oracle

Oracle connection name found in the tnsmame.ora file which identifies the connection information for the primary database.

pds_tns_filename

Oracle

Oracle file name identifying the Oracle tnsname.ora file to be used to identify the connection information for the primary database.

pds_username

All

User ID that Replication Agent uses to access primary data server.

ra_retry_count

All

Number of times LTM attempts to get back to Replicating state after a failure.

ra_retry_timeout

All

Number of seconds to wait between LTM attempts to get back to Replicating state.

rasd_backup_dir

Oracle MSSQL

The directory path for Replication Agent System Database (RASD) backup files.

rasd_database

Oracle MSSQL

The directory path for the Replication Agent System Database (RASD) database file.

rasd_mirror_tran_log

Oracle MSSQL

Enables or disables Replication Agent System Database (RASD) transaction log mirroring.

rasd_trace_log_dir

Oracle MSSQL

The directory path for the Replication Agent System Database (RASD) trace log file.

rasd_tran_log

Oracle MSSQL

The directory path for the Replication Agent System Database (RASD) transaction log file.

rasd_tran_log_mirror

Oracle MSSQL

The directory path for the Replication Agent System Database (RASD) transaction log file mirror.

rs_charset

All

Character set used to communicate with Replication Server.

rs_host_name

All

Name of primary Replication Server host machine.

rs_packet_size

All

Network I/O packet size sent to Replication Server.

rs_password

All

Password for user ID Replication Agent uses to access Replication Server.

rs_port_number

All

Port number for primary Replication Server.

rs_replicate_owner_required

All

Indicates if the owner is always included with the replicate table clause when generating replication definitions.

rs_retry_count

All

Number of times to retry connection to primary Replication Server.

rs_retry_timeout

All

Number of seconds to wait between connection retry attempts.

rs_source_db

All

Name of primary database identified to Replication Server.

rs_source_ds

All

Name of primary data server identified to Replication Server.

rs_ticket_version

All

Determines whether Replication Agent records the primary database time or the primary database date and time into the rs_ticket marker.

rs_username

All

User ID that Replication Agent uses to access primary Replication Server.

rssd_charset

All

Character set used to communicate with RSSD.

rssd_database_name

All

Name of RSSD database.

rssd_host_name

All

Name of RSSD host machine.

rssd_password

All

Password for user ID Replication Agent uses to access RSSD.

rssd_port_number

All

Port number for RSSD.

rssd_username

All

User ID that Replication Agent uses to access RSSD.

scan_sleep_increment

All

Number of seconds to increase Log Reader wait before next scan after finding no operations to replicate.

scan_sleep_max

All

Maximum number of seconds for Log Reader to wait before next scan after finding no operations to replicate.

skip_ltl_errors

All

LTI ignores error messages returned by Replication Server.

structured_tokens

All

LTI uses structured tokens when generating LTL output.

truncation_interval

All

Number of minutes to wait between automatic log truncations.

truncation_type

All

Methods of log truncation allowed.

use_rssd

All

Switches on/off access to RSSD for replication definitions.