POST /v1/configureStreamingReplication - BlueCat Address Manager - 9.4.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.4.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.
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.
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.
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
    • The Address Manager servers to be configured with database replication must have matching IP address configurations. For example, all Address Manager servers must all be configured with IPv4 addresses only, IPv6 addresses only, or in dual-stack with IPv4 and IPv6 addresses.

      If you have database replication configured with mixed IP configurations, such as an Address Manager server with IPv4 only addresses in replication with an Address Manager server with IPv4 and IPv6 addresses in dual-stack, the secondary Address Manager server will no longer be in replication upon upgrading to Address Manager v9.4.0.

      If your secondary Address Managers are no longer in replication after upgrading to Address Manager v9.4.0, you must reconfigure the secondary Address Manager so that the IP address configuration matches the configuration of the primary Address Manager (IPv4 only, IPv6 only, or dual-stack) and re-enable replication.

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
  • The Address Manager servers to be configured with database replication must have matching IP address configurations. For example, all Address Manager servers must all be configured with IPv4 addresses only, IPv6 addresses only, or in dual-stack with IPv4 and IPv6 addresses.

    If you have database replication configured with mixed IP configurations, such as an Address Manager server with IPv4 only addresses in replication with an Address Manager server with IPv4 and IPv6 addresses in dual-stack, the secondary Address Manager server will no longer be in replication upon upgrading to Address Manager v9.4.0.

    If your secondary Address Managers are no longer in replication after upgrading to Address Manager v9.4.0, you must reconfigure the secondary Address Manager so that the IP address configuration matches the configuration of the primary Address Manager (IPv4 only, IPv6 only, or dual-stack) and re-enable replication.

Responses

Code Description
201

Type: none

None.