POST /v1/addServer - BlueCat Address Manager - 9.2.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.2.0

Description

Adds servers to Address Manager.

Parameters

Name Description
configurationId

Location: query

Type: integer (int64)

The object ID of the configuration to which you wish to add the server.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
defaultInterfaceAddress

Location: query

Type: string

The physical IP address for the server within Address Manager.
fullHostName

Location: query

Type: string

The DNS FQDN by which the server is referenced.
name

Location: query

Type: string

The name of the server within Address Manager.
profile

Location: query

Type: string

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

Location: query

Type: string

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 the 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.
Note: For DNS/DHCP Servers without multi-port support, the interface-related property options will be ignored.

Responses

Code Description
201

Type: number

Returns the object ID for the new server.