PUT /bsus/api/v1/batches/move-servers - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

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

Description

Moves a DNS/DHCP server to a different Server Batch.

Parameters

Name Description
payload

(body)

Location: body

Type: application/json

The destnation Server Batch and how to handle the new Server Batch's customization scripts:
{
    "new_batch_id": "string",
    "server_management_ips": [
      "string"
    ],
    "postscript_options": {
    "install": true,
    "apply_and_run": true
  }
}
Parameters
  • new_batch_id—the name/ID of the destination Server Batch.
  • server_management_ips—an array of server IDs for the servers you want to move to the destination Server Batch.
  • postscript_options—Options to set for the destination Server Batch's customization package:
    • install—set to true if the package should be copied to the servers after moving them to the Server Batch.
    • apply_and_run—set to true if the package's post-update actions should be run on the servers after moving them to the Server Batch. (That is, the package's script is called with customize.sh -r.)

Responses

Status Description
Successful

Code: 202

The destination Server Batch ID, returned to verify its status

Body:
{
  "id": 0
}

The ID of the Server Batch.

Error

Code: 401

Unauthorized user.

Code: 409

Duplicate batch name.

Body:
{
  "error": "The batch with name <batch_name> is already in use"
}
 {
  "error": "The server <batch_name> already exists in batch <batch_id>"
}

Code: 500

Internal server error.

Body:
{
  "error": "string"
}

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.