Replace Server - BlueCat Address Manager - 8.3.0

Address Manager API Guide
prodname
BlueCat Address Manager
version_custom
8.3.0

Allows you to replace a server.

Output / Response

Replaces the server using the existing server ID.

API Call:

void replaceServer( long serverId, string name, string defaultInterface, string hostName, string password, boolean upgrade, string properties )
Parameter Description
serverId The object ID of the server that needs to be replaced.
name Name of the server to be replaced.
defaultInterface Management interface address for the server.
hostName The DNS FQDN by which the server is referenced.
password The server password. For more information on default server password, refer to BlueCat default login credentials (you must be authenticated to view this topic).
upgrade Flag indicating that server needs to be upgraded or not. True means server needs to be upgraded.
properties A string containing the following options:
  • servicesIPv4Address—IPv4 address used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. If dedicated management is enabled, this option must be specified. If dedicated management is disabled, this address must be the same as defaultInterfaceAddress which is management interface address.
  • servicesIPv4Netmask—IPv4 netmask used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. If dedicated management is enabled, this option must be specified. If dedicated management is disabled, this netmask address must be the same as the management interface netmask address.
  • servicesIPv6Address—IPv6 address used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. This is optional.
  • servicesIPv6Subnet—IPv6 subnet used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. This is optional.
  • xhaIPv4Address—IPv4 address used for XHA. This is optional.
  • xhaIPv4Netmask—IPv4 netmask used for XHA. This is optional.
  • redundancyScenario—networking redundancy scenarios. The possible values are ACTIVE_BACKUP (Failover) and IEEE_802_3AD (Load Balancing).
  • resetServices—allows you to replace the DNS/DHCP Server while maintaining existing configurations for DNS, DHCP, and TFTP services. Define this option only if you have modified the IPv4 or IPv6 addresses of the Services interface or wish to reset configurations for DNS, DHCP, and TFTP services on the DNS/DHCP Server. The value is either true or false (by default, false).
Note: For DNS/DHCP Servers without multi-port support, the interface-related property options will be ignored.
CAUTION:
Resetting DNS/DHCP Servers will result in a service outage. This service outage will last until you have deployed services to the replacement system. Only reset DNS/DHCP Server services if you are replacing the DNS/DHCP Server with a new appliance of a different type and/or reconfiguring the IPv4 or IPv6 addresses of the Services interface on the appliance. BlueCat recommends that you schedule a maintenance window before performing a reset of DNS/DHCP Server services.