aaAddReplicationServer
- Last UpdatedMar 10, 2025
- 2 minute read
Add or modify replication servers.
Syntax
aaAddReplicationServer ReplicationServerName, Description, SFPath, SFFreeSpace, AuthenticateWithAAUser, UserName, Password, TCPPort, SummaryReplicationNamingScheme, SimpleReplicationNamingScheme, BufferCount, Bandwidth, MinSFDuration, ReplicationServerKey, CompressionEnabled, ConnectionDetails
where:
|
Argument |
Description |
|---|---|
|
ReplicationServerName |
Name or IP address of the tier 2 server. This value is of data type nvarchar(255), with a default of an empty string. |
|
Description |
Description of the replication server. This value is of data type nvarchar(512), with a default of an empty string. |
|
SFPath |
Store forward path for the replication server. The default is an empty string. This value is of data type nvarchar(260), with a default of an empty string. |
|
SFFreeSpace |
Free space for the store forward path in MB. This value is of data type int, with a default of 125. |
|
AuthenticateWithAAUser |
Set to 1 to authenticate with the Network Account (previously called the ArchestrA User). This value is of data type bit, with a default of 1. |
|
UserName |
User name for authenticating with the tier 2 server. This value is nvarchar(255), with a default of NULL. |
|
Password |
Password for authenticating with the tier 2 server. This value is of data type nvarchar(512), with a default of NULL. |
|
TCPPort |
TCP Port for communicating with the tier 2 server. This value is of data type int, with a default of 32565. |
|
SummaryReplicationNamingScheme |
Naming rule for summary replication tags. If this is NULL, the naming rule specified in system parameters will be used. This value is of data type nvarchar(512), with a default of <ReplicationDefaultPrefix>.<SourceTagName>.<TypeAbbreviation><GroupAbbreviation>. |
|
SimpleReplicationNamingScheme |
Naming rule for simple replication tags. If this is NULL, the naming rule specified in System parameters will be used. This value is of data type nvarchar(512), with a default of <ReplicationDefaultPrefix>.<SourceTagName>. |
|
BufferCount |
The number of 64 KB buffers pre-allocated for buffering data. This number may need to be increased to accommodate high data rates. This value is of data type int, with a default of 128. |
|
Bandwidth |
The bandwidth in kbps used between tier-1 and tier-2. -1 = unlimited. This value is of data type int. |
|
MinSFDuration |
The minimum duration, in seconds, for the replication service server node to function in store-and-forward mode. The replication service server node functions in store-and-forward mode for this length of time even if the condition that caused replication service server node to function in store-and-forward mode no longer exists. The maximum duration is 3600 seconds, and the minimum is 0 seconds. This value is of data type int, with a default of 180. |
|
ReplicationServerKey |
Unique identifier for the replication server. If specified, this will overwrite the properties of the server identified by the key. This value is of data type int, with a default of NULL. |
|
CompressionEnabled |
0 = Compression off. 1 = Enable compression for the packets sent to the replication server. |
|
ConnectionDetails |
Internal use only. |
Permission
Execute permission defaults to the aaPowerUsers and aaAdministrators groups.