POST /v1/configureStreamingReplication - BlueCat Address Manager - 9.2.0

Address Manager API Guide
prodname
BlueCat Address Manager
version_custom
9.2.0

Description

Enables database replication on a remote system in order to automate the setup of replication between two or three Address Manager systems. This API method must be run against the Address Manager system that will be primary.

Parameters

Name Description
compressReplication

Location: query

Type: boolean

The boolean value. Set to true to compress the database replication files.
Note: Compressing database replication files is a resource-intensive process that might affect system performance. Use caution when performing this action. By default, the compressReplication parameter is disabled.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
latencyCriticalThreshold

Location: query

Type: integer (int64)

A value to specify the threshold size of the replication break in seconds (sec). Valid values for this parameter range from 0 to any positive value. By default, the latencyCriticalThreshold parameter is set to 86400 seconds.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
latencyWarningThreshold

Location: query

Type: integer (int64)

A value to specify the threshold size of the replication directory in seconds (sec). Valid values for this parameter range from 0 to any positive value. By default, the latencyWarningThreshold parameter is set to 3600 seconds.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
properties

Location: query

Type: string

A string including the following option:
  • secondStandbyServer —Used to add an additional standby server. The server's IP address is required.
    Note: When adding a standby server, the server cannot be part of an existing database replication environment or a removed standby server. You can only add a standby server if it is operating as a Standalone server. If you attempt to add a standby server that is not operating as a Standalone server, the following message is returned: 
    An error was encountered while configuring replication, Server
<server_IP> is not a standalone server
standbyServer

Location: query

Type: string

The IP address of the standby server.
Note:
  • To configure replication in Address Manager, you must have a standby server. An additional standby server can be added by using the secondStandbyServer property.
  • When adding a standby server, the server cannot be part of an existing database replication environment or a removed standby server. You can only add a standby server if it is operating as a standalone server. If you attempt to add a standby server that is not operating as a standalone server, the following message is returned: 
    An error was encountered while configuring replication, Server
<server_IP> is not a standalone server

Responses

Code Description
201

Type: file

None.