POST /bsus/api/v1/batches - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.1

Description

Adds servers to a Server Batch

Parameters

Name Description
payload

(body)

Location: body

Type: application/json

The body of the servers to be added to the Server Batch. The JSON body is as follows:
{
  "name": "string",
  "servers": [
    {
      "bam_id": "string",
      "name": "string",
      "management_ip": "string",
      "service_ip": "string",
      "role_enabled": "string",
      "appliance_type": "string",
      "authentication_method": "credentials/keys",
      "key_id": "string",
      "username": "string",
      "password": "string"
    }
  ],
    "postscript_options": {
    "install": true,
    "apply_and_run": true,
    "postscript_id": "string"
  }
}
Parameters
  • name—the name of the Server Batch.
  • servers—an array of servers to add to the server batch, with the following information for each server:
    • bam_id—the object ID of the Address Manager server to which the server is associated.
    • name—the name of the DNS/DHCP Server.
    • management_ip—the IP address of the DNS/DHCP Server management interface.
    • service_ip—the IP address of the DNS/DHCP Server service interface.
    • role_enabled—the role that has been enabled on the DNS/DHCP Server, such as DNS.
    • appliance_type—the appliance type of the DNS/DHCP Server.
    • username—the username used to authenticate with the DNS/DHCP Server.
    • password—the password used to authenticate with the DNS/DHCP Server.
  • postscript_options—Options to set for customization packages:
    • install—set to true if the customization package should be sent to the DNS/DHCP Server during an update.
    • apply_and_run—set to true if the customization package's post-update script should be called after an update to restore customized server settings (customize.sh -r).
    • postscript_id—The name of the package to associate with this Server Batch.

Responses

Status Description
Successful

Code: 202

Body:
{
  "id": 0
}

The ID of the Server Batch.

Error

Code: 401

Unauthorized user.

Code: 409

Body:
{
  "error": "string"
}

Code: 500

Internal server error.

This can be caused when an unknown application error is encountered on the Server side. The API attempts to return additional details within the error parameter.