Add Server - BlueCat Address Manager - 8.3.2

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.2

Adds servers to Address Manager.

Note: Existing customers who have upgraded their Address Manager API to v8.0.0 or greater may need to update their API calls to add a server with dedicated management enabled. For more information, refer to KB-939.
Output / Response

Returns the object ID for the new server.

API Call:

long addServer ( long configurationId, string name, string defaultInterfaceAddress, string fullHostName, string profile, string properties )
Parameter Description
configurationId The object ID of the configuration to which the server is being added.
name The name of the server within Address Manager.
defaultInterfaceAddress The physical IP address for the server within Address Manager.
fullHostName The DNS FQDN by which the server is referenced.
profile The server capability profile. The profile describes the type of server or appliance being added and determines the services that can be deployed to this server. This must be one of the constants found in Server Capability Profiles.
properties A string containing the following options:
  • connected—either true or false; indicates whether or not to connect to a server. In order to add and configure multi-port DNS/DHCP Servers, this option must be set to true. If false, other interface property options will be ignored.
  • upgrade—indicates whether or not to apply the latest version of DNS/DHCP Server software once the appliance is under Address Manager control. The value is either true or false (by default, true).
  • 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).
  • 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.
  • 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.
  • 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).
The following properties only apply to the Windows server:
  • ProteusDDW—enter the object ID of the DDW server.
  • readOnly—indicates if the Windows server is added in read-only mode. The value is either true or false (by default, true). If set to false, the server will be added in read-write mode.
  • enableDNS—indicates if DNS is enabled. The value is either true or false (by default, true).
  • enableDHCP—indicates if DHCP is enabled. The value is either true or false (by default, true).
  • importViewName—enter a View name for the Windows server. When you manage Windows DNS from Address Manager, you must specify a DNS View. Only DNS records contained in this View are deployed. This is mandatory if enableDNS is set to true.
  • authenticationCredentialDomain—enter the domain name of the Windows Active Directory domain to which this server belongs. If the server is not a member of a domain, enter the server’s NETBIOS computer name.
  • authenticationCredentialUsername—enter the username for the Windows server.
  • authenticationCredentialPassword—enter the user password for the Windows server.
Note: For DNS/DHCP Servers without multi-port support, the interface-related property options will be ignored.