Add Raw Deployment Option - BlueCat Address Manager - 8.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.0

Adds deployment options to DNS or DHCP services in a raw format that will be passed to the service when deployed.

Output / Response

Returns the object ID for the newly added Raw option.

API Call (SOAP):

long addRawDeploymentOption( long parentId, String optionType, String rawData, String properties )
Parameter Description
parentId The object ID of the entity to which the DNS or DHCP raw deployment option is assigned.
optionType The type of the raw deployment option being assigned. This value must be one of the following items:
  • DNS_RAW
  • DHCP_RAW
  • DHCPV6_RAW
rawData The raw option value. The maximum supported characters are 65,536. The raw option will be passed to the DNS or DHCP service on the managed server exactly as you enter here. Therefore, it is essential that you enter the data with the correct syntax.
properties Adds object properties, including associated server and server group, and user-defined fields.

API Call (REST):

addRawDeploymentOption( long parentId, APIDeploymentOption option )
Parameter Description
parentId The object ID of the entity to which the DNS or DHCP raw deployment option is assigned.
option Object containing information about the raw deployment option:
  • type - The type of option. The type must be one of the following values:
    • DNS_RAW
    • DHCP_RAW
    • DHCPV6_RAW
  • value - The raw option value. The maximum supported characters are 65,536. The raw option will be passed to the DNS or DHCP service on the managed server exactly as you enter here. Therefore, it is essential that you enter the data with the correct syntax.
  • properties - Adds object properties, including associated server and server group, and user-defined fields.

REST example

POST http://<bam_IP>/Services/REST/v1/addRawDeploymentOption?parentId=100894
Content-type:application/json
{
  "type":"DNS_RAW",
  "value":"abc123",
  "properties":"server=100896"
}