configure replication server

Sets characteristics of the Replication Server, including network-based security. Configures ERSSD.

Syntax

configure replication server {
	set repserver_param to 'value' |
	set route_param to 'value' |
	set database_param to 'value' |
	set logical_database_param to 'value' |
	set security_param to 'value' |
	set id_security_param to 'value' |
	set security_services [to] 'default'}

Parameters

repserver_param – The name of a parameter that affects the Replication Server. Refer to Replication Server configuration parameters and ERSSD configuration parameters for a description of parameters and values.

value – A setting for a configuration parameter.

Replication Server Configuration Parameters
repserver_param	Value
block_size to '`value`' with shutdown	Specifies the queue block size which is the number of bytes in a contiguous block of memory used by stable queue structures. Range of values allowed: 16KB, 32KB, 64KB, 128KB, or 256KB Default: 16KB Note: When you execute the command to change the block size, Replication Server shuts down. You must include the “with shutdown” clause after specifying the block size in versions prior to Replication Server 15.6. In version 15.6 and later the “with shutdown” clause is optional; you need not restart Replication Server for the change in queue block size to take effect. You should change this parameter only with the configure replication server command. Doing otherwise corrupts the queues. License: Separately licensed under the Advanced Services Option. See Replication Server Administration Guide Volume 2 > Performance Tuning > Replication Server – Advanced Services Option for instructions.
cm_fadeout_time	The number of seconds of idle time before Replication Server closes a connection with the RSSD. A value of –1 specifies that a connection will never be closed. Default: 300 seconds Minimum: 1 second Maximum: 2,147,483,648 seconds
cm_max_connections	The maximum number of outgoing connections available to the connection manager. The value must be greater than 0. Default: 64
current_rssd_version	The Replication Server version supported by this RSSD. The Replication Server checks this value at startup. Note: Do not change the value for this parameter. This value should only be modified by the rs_init program when you upgrade or downgrade. Default: N/A
deferred_queue_size	The maximum size of an Open Server deferred queue. If Open Server limits are exceeded, increase the maximum size. The value of deferred_queue_size must be greater than 0. Note: You must restart the Replication Server for any changes to this parameter to take effect. Default: 2048 on Linux and HPIA32; 1024 on other platforms
dist_direct_cache_read	Enables the distributor (DIST) thread to read SQL statements directly from the Stable Queue Thread (SQT) cache. This reduces the workload from SQT and the dependency between the two, and improves the efficiency of both SQT and DIST Default: off License: Separately licensed under the Advanced Services Option. See Replication Server Administration Guide Volume 2 > Performance Tuning > Advanced Services Option.
ha_failover	Enables or disables Sybase Failover support for new database connections from the Replication Server to Adaptive Servers. Values are: on - Failover is enabled off - Failover is disabled Default: off
id_server	The name of the ID Server for this Replication Server. Note: Do not change the value of this parameter. id_server is set when you run rs_init and should only be modified by the rs_init program when you upgrade or downgrade Replication Server. Default: N/A
init_sqm_write_delay	Write delay for the Stable Queue Manager if queue is being read. Default: 100 milliseconds
init_sqm_write_max_delay	The maximum write delay for the Stable Queue Manager if the queue is not being read. Default: 1000 milliseconds
mem_reduce_malloc	Enable to allocate memory in larger chunks, which reduces the number of memory allocations and leads to improved Replication Server performance. Default: off License: Separately licensed under the Advanced Services Option. See Replication Server Administration Guide Volume 2 > Performance Tuning > Replication Server – Advanced Services Option.
mem_thr_dsi	Specifies the percentage of the total memory used to force the DSI thread to stop populating the SQT cache. Default: 80% of memory_limit value. Range: 1 – 100
mem_thr_exec	Specifies the percentage of the total memory used to force the EXEC thread to stop receiving commands from RepAgent. Default: 90% of memory_limit value. Range: 1 – 100
mem_thr_sqt	Specifies the percentage of the total memory used to force the SQT thread to flush the largest transaction from its cache if possible. Default: 85% of memory_limit value. Range: 1 – 100
mem_warning_thr1	Specifies the threshold percentage of the total memory used before the first warning message is generated. See memory_limit. Default: 80% of memory_limit value. Range: 1 – 100
mem_warning_thr2	Specifies the threshold percentage of the total memory used before the second warning message is generated. See memory_limit. Default: 90% of memory_limit value. Range: 1 – 100
memory_control	Manages the memory control behavior of threads that require significant amount of memory. See memory_limit. Values are: on – enables memory control off – disables memory control Default: on
memory_limit	The maximum total memory the Replication Server can use, in megabytes. Values for several other configuration parameters are directly related to the amount of memory available from the memory pool indicated by memory_limit. These include md_sqm_write_request_limit, queue_dump_buffer_size, sqt_max_cache_size, sre_reserve, and sts_cachesize. Default: 2,047MB For 32-bit Replication Server: Minimum – 0 Maximum – 2,047MB For 64-bit Replication Server: Minimum – 0 Maximum – 2,147,483,647 When memory_control is: on – Replication Server does not shut down when memory consumption exceeds memory_limit off – Replication Server automatically shuts down when memory consumption exceeds memory_limit Monitor memory usage and increase memory_limit if required. Replication Server shuts down when it exceeds the defined value of available memory in memory_limit. Monitor memory usage and increase memory_limit if required. In Replication Server, the threads that require significant amount of memory are: EXEC SQT DST These threads execute memory control by performing a memory usage check before receiving or processing new data. During memory control, if the memory usage is found to be high, thread functioning is adjusted by: Stopping the thread from grouping new data, and cleaning and processing existing data; or, Making the thread go into a sleep mode such that it does not receive new data until memory is available. If the value you set is larger than 2,047MB, downgrading resets the value to 2,047MB to protect against overflow.
minimum_rssd_version	The minimum version of the Replication Server that can use this RSSD. When the current_rssd_version is greater than the version of the Replication Server, this value is checked when the Replication Server is started. Note: Do not change the value for this parameter. This value should only be modified by the rs_init program when you upgrade or downgrade. Default: N/A
nrm_thread	Enables the NRM thread which Replication Server can use to normalize and pack Log Transfer Language (LTL) commands in parallel with parsing by the RepAgent Executor thread. Parallel processing by the NRM thread reduces the response time of the RepAgent executor thread. The NRM thread is a thread split from RepAgent executor thread. Use the configure replication server command to set nrm_thread to on before you use exec_nrm_request_limit. Default: off License: Separately licensed under the Advanced Services Option. See eplication Server Administration Guide Volume 2 > Performance Tuning > Replication Server – Advanced Services Option.
num_client_connections	The maximum number of incoming client connections allowed. If Open Server limits are exceeded, increase the maximum number. The value must be greater than or equal to 30. Default: 30
num_concurrent_subs	The maximum number of concurrent subscription materialization/dematerialization requests allowed. (Limit applies to atomic and non-atomic materialization only; does not apply to bulk materialization.) Requests over the maximum are fulfilled after other requests have been fulfilled. The minimum value is 1. Default: 10
num_msg_queues	The maximum number of Open Server message queues allowed. If Open Server limits are exceeded, increase the maximum number. The value must be greater than the num_threads setting. Default: 300
num_msgs	The maximum number of Open Server message queue messages allowed. If Open Server limits are exceeded, increase the maximum number. Default: 91,136
num_mutexes	The maximum number of Open Server mutexes allowed. If Open Server limits are exceeded, increase the maximum number. The value must be greater than the num_threads setting. Default: 128
num_stable_queues	The maximum number of stable queues allowed (HP9000 only). Each stable queue uses 32,768 bytes of shared memory. The minimum number of stable queues allowed is 32. Each standby database connection uses an additional 16,384 bytes of shared memory. Every two standby database connections count as one additional stable queue. Default: 32
num_threads	The maximum number of Open Server threads allowed. If Open Server limits are exceeded, increase the maximum number. The value must be greater than or equal to 20. Default: 150
oserver	The name of the current Replication Server. Note: Do not change the value for this parameter. You specified the current Replication Server name when you installed it using rs_init. Default: N/A
password_encryption	Indicates if password encryption is enabled/disabled: 1 – encryption enabled 0 – encryption disabled Default: 0
prev_min_rssd_version	Following an rs_init installation upgrade, this value contains the previous value of minimum_rssd_version. Note: Do not change the value for this parameter. This value should be modified only by rs_init when you upgrade or downgrade. Default: N/A
prev_rssd_version	Following an rs_init installation upgrade, this value contains the previous value of current_rssd_version. Note: Do not change the value for this parameter. This value should be modified only by rs_init when you upgrade or downgrade. Default: N/A
queue_dump_buffer_size	The maximum command length, in bytes, used by the sysadmin dump_queue command. Commands larger than the specified length are truncated. The range is 1000 to 32,768. Default: 32,768 bytes
rec_daemon_sleep_time	Specifies the sleep time for the recovery daemon, which handles “strict” save interval messages in warm standby applications and certain other operations. Default: 2 minutes
rssd_error_class	Error class for the RSSD. Default: rs_sqlserver_error_class
send_enc_password	Ensures that all Replication Server client connections are made with encrypted passwords—except for the first connection to the RSSD. Values are “on” and “off.” See the Replication Server Administration Guide Volume 1 for more information. Default: off
send_timestamp_to_standby	Specifies whether to send `timestamp` columns to the replicate database when there is no replication definition. Values are on and off. See the Replication Server Administration Guide Volume 1 for more information. Default: off
smp_enable	Enables symmetric multiprocessing (SMP). Specifies whether Replication Server threads should be scheduled internally by Replication Server or externally by the operating system. When Replication Server threads are scheduled internally, Replication Server is restricted to one machine processor, regardless of how many may be available. Values are “on” and “off.” Default: on
sqm_async_seg_delete	Set sqm_async_seg_delete to on to enable a dedicated daemon for deleting segments and improve performance for inbound and outbound queue processing. Default: on You must restart Replication Server for any change to the parameter setting to take effect. If sqm_async_seg_delete is on, Replication Server may require a larger partition. Use alter partition to expand a partition. See: Replication Server Configuration Guide > Preparation for Installing and Configuring Replication Server > Plan the Replication System > Initial Disk Partition for Each Replication Server. Replication Server Administration Guide Volume 1 > Replication Server Technical Overview > Transaction Handling with Replication Server > Stable Queues > Partitions for Stable Queues.
sqm_cache_enable	Sets server-wide stable queue caching. Values are on and off. Default: on
sqm_cache_size	Sets server-wide stable queue cache size. Enclose the number of pages in single quotes or double quotes. Range is 1 to 4096. Default: 16
sqm_page_size	Sets server-wide stable queue page size in blocks per page. Enclose page sizes in single quotes or double quotes. For example, setting page size to 4 instructs Replication Server to write to the stable queue in 64K chunks. Configuring the page size also sets the I/O size of Replication Server. The range is 1 to 64. Default: 4
sqm_recover_segs	Specifies the number of stable queue segments Replication Server allocates before updating the RSSD with recovery QID information. See Replication Server Administration Guide Volume 2 > Performance Tuning > Specifying the Number of Stable Queue Segments Allocated.. Sybase recommends that you increase the value of sqm_recover_segs to improve performance. Default: 1 Minimum: 1 Maximum: 2,147,483,648
sqm_warning_thr1	Percent of partition segments (stable queue space) to generate a first warning. The range is 1 to 100. Default: 75
sqm_warning_thr2	Percent of partition segments used to generate a second warning. The range is 1 to 100. Default: 90
sqm_warning_thr_ind	Percent of total partition space that a single stable queue uses to generate a warning. The range is 51 to 100. Default: 70
sqm_write_flush	Specifies whether data written to memory buffers is flushed to the disk before the write operation completes. Values are: on – data written to the memory buffer is flushed to the disk. off – data written to the memory buffer is not flushed to the disk. dio – enables direct I/O and allows Replication Server to read and write to the disk without file system buffering. Available only in Solaris (SPARC) and Linux. Default: on
sqt_init_read_delay	The length of time an SQT thread sleeps while waiting for an SQM read before checking to see if it has been given new instructions in its command queue. With each expiration, if the command queue is empty, SQT doubles its sleep time up to the value set for sqt_max_read_delay. Default: 1 ms Minimum: 0 ms Maximum: 86,400,000 ms (24 hours)
sqt_max_cache_size	Maximum SQT (Stable Queue Transaction) interface cache memory, in bytes. For 32-bit Replication Server: Default – 1,048,576 Minimum – 0 Maximum – 2,147,483,647 For 64-bit Replication Server: Default – 20,971,520 Minimum – 0 Maximum – 2,251,799,813,685,247 If the value you set is larger than 2,147,483,647 bytes, downgrading resets the value to 2,147,483,647 bytes to protect against overflow.
sqt_max_read_delay	The maximum length of time an SQT thread sleeps while waiting for an SQM read before checking to see if it has been given new instructions in its command queue. Default: 1 ms Minimum: 0 ms Maximum: 86,400,000 ms (24 hours)
sre_reserve	The amount of additional space to allocate for new subscriptions. For example, 100 (100%) means double the current space. The range is 0 to 500. To update the sre_reserve parameter for a replication definition, insert into or update the `rs_config` system table directly. Default: 0
stats_reset_rssd	Indicates whether RSSD truncates previous sampling data or overwrites it with new information. Values: on – overwrite old sampling data with new information. off – keep previous sampling data. Default: on
stats_sampling	Enables sampling counters. Default: off
stats_show_zero_counters	Specifies whether the admin stats command reports counters with zero observations for a specified sample period. The values are: on – counters with zero observations are reported. off – counters with zero observations are not reported. Default: off
sts_cachesize	The total number of rows cached for each cached RSSD system table. Increasing this number to the number of active replication definitions prevents Replication Server from executing expensive table lookups. Default: 1000
sts_full_cache_`RSSD_system_table_name`	Specifies an RSSD system table that is to be fully cached. Fully cached tables do not require access to the RSSD for simple select statements. Enter sts_full_cache_, leave no space, and follow with the table name. Tables with sts_full_cache set to on by default and that Replication Server fully caches: rs_asyncfuncs rs_clsfunctions rs_columns rs_objects rs_objfunctions rs_repobjs rs_users See Replication Server Administration Guide Volume 2 > Performance Tuning > Suggestions for Using Tuning Parameters > Cache System Tables > System Tables that Can Be Cached for a list of all RSSD tables that can be fully cached.
sub_daemon_sleep_time	Number of seconds the subscription daemon sleeps before waking up to recover subscriptions. The range is 1 to 31,536,000. Default: 120 seconds
unicode_format	Supports sending unicode data in `U&”` format. Set unicode_format to one of these values: `string` – unicode characters are converted to character string format. For example, the `string` “hello” is sent out as “hello”. `ase` – unicode characters are sent out in `U&’’` format. For example, the `string` “hello” is sent out as “U&'\0068\0065\006c\006c\006f’ ”. The two-byte unicode value is sent in network order as required by Adaptive Server Enterprise. Default: `string`
varbinary_strip_trailing_zeros	Set varbinary_strip_trailing_zeros to on to strip trailing zeros from `varbinary` values. If you set to off, Replication Server replicates the trailing zeros in `varbinary` values. You need not restart Replication Server, or suspend and resume connections for any change in the parameter to take effect. Default: on
varchar_truncation	Enables truncation of `varchar` columns at the primary or replicate Replication Server. Set varchar_truncation at the replicate Replication Server when a character set conversion takes place at both Replication Servers. Default: off

route_param – Affects routes. See Configuration parameters affecting routes for a list and description of route parameters. configure replication server sets parameter values for all routes that originate at the source Replication Server.
database_param – Affects connections. See Parameters affecting database connections for a list and description of connection parameters. configure replication server sets parameter values for all connections that originate at the source Replication Server.
logical_database_param – Affects logical connections. See Configuration parameters affecting routes for a list and description of parameters. configure replication server sets parameter values for all logical connections that originate at the source Replication Server

security_param – Affects network-based security. See Parameters affecting network-based security table for a list and description of parameters.

Parameters Affecting Network-Based Security
`security_param`	`Value`
msg_confidentiality	Indicates whether Replication Server sends and receives encrypted data. If set to “required,” outgoing data is encrypted. If set to “not required,” Replication Server accepts incoming data that is encrypted or not encrypted. Default: not_required
msg_integrity	Indicates whether data is checked for tampering. Default: not_required
msg_origin_check	Indicates whether the source of data should be verified. Default: not_required
msg_replay_detection	Indicates whether data should be checked to make sure it has not been intercepted and resent. Default: not_required
msg_sequence_check	Indicates whether data should be checked to make sure it was received in the order sent. Default: not_required
mutual_auth	Indicates whether the remote server must provide proof of identify before a connection is established. Default: not_required
security_mechanism	The name of the third-party security mechanism enabled for the pathway. Default: first mechanism listed in the SECURITY section of libtcl.cfg
send_enc_password	Ensures that all Replication Server client connections are made with encrypted passwords—except for the first connection to the RSSD. Values are “on” and “off.” Default: off
unified_login	Indicates how Replication Server seeks to log in to remote data servers and accepts incoming logins. The values are: “required” – always seeks to log in to remote server with a credential. “not_required” – always seeks to log in to remote server with a password. Default: not_required
use_security_services	Tells Replication Server whether to use security services. If use_security_services is “off,” no security features take effect. Note: This parameter can only be set by configure replication server.
use_ssl	Indicates whether Replication Server is enabled for session-based SSL security. The values are: “on” – Replication Server is enabled for SSL. “off” – Replication Server is not enabled for SSL. Default: off

id_security_param – Affects network-based security for the ID Server. See Security parameters for connecting to the ID Server for a list and description of these parameters.

Security Parameters for Connecting to the ID Server
`security_param`	`Value`
id_msg_confidentiality	Indicates whether Replication Server sends and receives encrypted data packets. If set to “required,” outgoing data is encrypted. If set to “not required,” Replication Server accepts incoming data that is encrypted or not encrypted. Default: not required
id_msg_integrity	Indicates whether data packets are checked for tampering. Default: not required
id_msg_origin_check	Indicates whether the source of data packets should be verified. Default: not required
id_msg_replay_detection	Indicates whether data packets should be checked to make sure they have not been intercepted and resent. Default: not required
id_ msg_sequence_check	Indicates whether data packets should be checked to make sure they are received in the order sent. Default: not required
id_mutual_auth	Requires the ID Server to provide proof of identify before Replication Server establishes a connection. Default: not required
id_security_mech	Specifies the name of the supported security mechanism. Supported security mechanisms are listed under SECURITY in the libtcl.cfg file. If no name is specified, Replication Server uses the default mechanism. Default: the first mechanism in the list
id_unified_login	Indicates how Replication Server seeks to connect to ID Server. The values are: required – always seeks to log in to ID Server with a credential. not required – always seeks to log in to ID Server with a password. Note: Only the “sa” user can log in to Replication Server without a credential if unified_login is “required.” If the security mechanism should fail, the “sa” user can log in and disable unified_login. Default: not required

set security_services [to] 'default' – Resets all network-based security features for the connection to match the global settings of your Replication Server. It does not reset the use_security_services feature.
If Replication Server supports more than one security mechanism, set security_services [to] 'default' also sets the security mechanism to the default, the first mechanism listed in the SECURITY section of the libtcl.cfg file.

Examples

Example 1 – Sets Replication Server to send data in encrypted format:

configure replication server 
 set id_msg_confidentiality to 'required'

Example 2 – Sets all security features to match the global settings:
```
configure replication server 
 set security_services to 'default'
```

Example 3 – Changes the rsi_save_interval parameter to two minutes for all routes originating at the current Replication Server:

suspend route to each_dest_replication_server

 configure replication server
 set rsi_save_interval to '2'
 
 resume route to each_dest_replication_server

Example 4 – Sets the queue block size to 64.
```
configure replication server 
set block_size to ‘64’
```
(Optional) Uses the with shutdown clause to set the block size and shut down the primary Replication Server
```
configure replication server 
set block_size to ‘64’ with shutdown
```

Usage

Each parameter has two values: the configured value and the run value. Replication Server uses the configured value when it restarts. The run value is the value the Replication Server is using currently. When you start Replication Server the values are equal.
Configured values are stored in the rs_config system table in the RSSD.
Replication Server shuts down automatically when you set the queue block size with the “set block_size to ‘block_size’ with shutdown” Replication Server parameter. The new block size takes effect after you restart Replication Server. See Replication Server Administration Guide Volume 2 > Performance Tuning > Increasing Queue Block Size .

varchar_truncation enables truncation of varchar columns at the primary or replicate Replication Server. When incoming varchar data exceeds the column length specified in the replication definition, the following occurs:

varchar_truncation
	varchar_truncation set at primary Replication Server	varchar_truncation set at replicate Replication Server
varchar_trunction set to “on”	Replication Server truncates incoming data to the length specified in the replication definition.	Replication Server truncates incoming data to the length specified in the replication definition.
varchar_truncation set to “off”	RepAgent prints a message in the Replication Server log, and Replication Server ignores rows that exceed the column length specified in the replication definition.	Replication Server prints a message in the Replication Server log, and the DSI shuts down.

Use ha_failover to enable Sybase failover support. In the event of an ASE server failover, all connections from Replication Server to ASE will fail. Replication Server will retry connections. Setting ha_failover to on will allow the new connections to failover to the new ASE server.

Use ERSSD configuration parameters to configure backup time, directory location and RepAgent name.

ERSSD Configuration Parameters
ERSSD Configuration Parameter	Value	Default
erssd_backup_start_time	Time the backup starts. Specified as: “hh:mm AM” or “hh:mm PM”, using a 12-hour clock, or “hh:mm” using a 24-hour clock.	Default: 01:00 AM
erssd_backup_start_date	Date the backup begins. Specified as “MM/DD/YYYY”.	Default: current date
erssd_backup_interval	Interval between backups of database and log. Specified as “nn hours” or “nn minutes” or “nn seconds”.	Default: 24 hours
erssd_backup_dir	Location of stored backup files. Should be a full directory path. Configuring this path causes immediate backup.	Default: Same directory as the transaction log mirror; initial value specified in rs_init.
erssd_ra	Configures Replication Agent name, in order to create a route from the current site to another Replication Server. This server name must exist in the interfaces name.	`erssd_name`_ra

Replication Server Parameters

Replication Server parameters specify default values that affect the local Replication Server.
Replication Server parameters are static. You must restart Replication Server for them to take effect.

Route Parameters

Route parameters specify default values for all routes that originate at the source Replication Server.
You can override default values specified using configure replication server by using alter route to set values for individual routes.
You must suspend all routes originating at the current Replication Server before executing the configure replication server command. After you have changed the parameter, you must resume all routes for the change to take effect.

Database Parameters

Database parameters specify default values for all connections that originate at the source Replication Server.
You can override default values specified using configure replication server by using alter connection to set values for an individual connection.
You must suspend all connections originating at the current Replication Server before executing configure replication server. After you change the parameter, resume all connections for the change to take effect.

Logical Database Parameters

Logical database parameters specify default values for logical connections that originate at the source Replication Server.
You can override default values specified using configure replication server by using configure logical connection to set values for a specific logical connection.
Logical database parameters are dynamic. They take effect immediately.

Network-Based Security Parameters

With the exception of use_security_services and use_ssl, security parameters configured with configure replication server are dynamic; they take effect immediately.
use_security_services and use_ssl are static. If you change their values, you must restart Replication Server for the change to take effect.
Default network-based security parameters set with configure replication server specify values for all incoming and outgoing pathways related to the current Replication Server.
You can override default security settings specified using configure replication server by using alter route or alter connection to reset security values for individual outgoing pathways.
If unified_login is set to “required,” only the “sa” user can log in to the Replication Server without a credential. If the security mechanism should go down, the “sa” user can log in to Replication Server with a password and disable unified_login.
A Replication Server can support more than one security mechanism. Each supported mechanism is listed in the libtcl.cfg file under SECURITY.
Both ends of a route must use compatible Security Control Layer (SCL) drivers with the same security mechanisms and security settings. It is the replication system administrator’s responsibility to choose and set security features for each server. Replication Server does not query the security features of remote servers before it attempts to establish a connection. Network connections fail if security features at both ends of the pathway are not compatible.
Message encryption is a costly process with severe performance penalties. In most instances, it is wise to set msg_confidentiality to “required” only for certain pathways. Alternatively, choose a less costly feature, such as msg_integrity, to ensure security.

Permissions

configure replication server requires “sa” permission.