PUT /bsus/api/v1/scheduled_update - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

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

Description

Update a configured scheduled update.

Parameters

Name Description
payload

(body)

Location: body

Type: application/json

The body of the scheduled update that you would like to modify. The JSON body is as follows:
{
  "patches": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "release_date": "date string (%Y-%m-%dT%H:%M:%SZ)",
      "patch_dir": "string",
      "enabled": bool
    }
  ],
  "datetime": int(epoch),
  "type": "SCHEDULE_MODIFY",
  "batches": [
    {
      "id": "string",
      "name": "string",
      "timestamp": "date string (%Y-%m-%dT%H:%M:%SZ)",
      "servers": [
        {
          "bam_id": "string",
          "name": "string",
          "order": int,
          "management_ip": "string",
          "service_ip": "string",
          "appliance_type": "string",
          "role_enabled": [ "string" ],
          "software_version": "string",
          "patches_installed": [ "string" ],
          "services_health": int,
          "configuration": "string",
          "primary_ip": "string",
          "secondary_ip": "string",
        }
      ]
    }
  ],
  "id": "string",
  "run_postscript": true
}
Parameters
  • servers—an array of patches with the following information:
    • id—the ID of the patch.
    • name—the name of the patch.
    • type—the type of patch, such as bind_hotfix.
    • release_date—the release date of the patch.
    • patch_dir—the file path to the patch file.
    • enabled—set to true if the patch is scheduled to be applied; set to false if the patch is not scheduled to be applied.
  • datetime—the date and time that the scheduled update is to be applied.
    Note: The date and time must be greater than the time at which the API request is sent by at least 5 minutes.
  • type—the type of update to the scheduled update. Set the value to SCHEDULE_MODIFY to indicate that you are modifying the scheduled update.
  • batches—an array of Server Batches to which the scheduled update is to be applied with the following information:
    • id—the ID of the Server Batch.
    • name—the name of the Server Batch.
    • servers—an array of servers to add to the server batch with the following information:
      • bam_id—the object ID of the Address Manager server to which the server is associated.
      • name—the name of the DNS/DHCP Server.
      • order—the order in which the server appears in the Server Batch
      • management_ip—the IP address of the DNS/DHCP Server management interface.
      • service_ip—the IP address of the DNS/DHCP Server service interface.
      • appliance_type—the appliance type of the DNS/DHCP Server.
      • role_enabled—the list of roles that are enabled on the DNS/DHCP Server, such as DNS.
      • software_version—the version of DNS/DHCP Server installed on the server.
      • patches_installed—the list of DNS/DHCP Server patches installed on the server.
      • services_health—the health status of the server.
      • configuration—the configuration in Address Manager to which the server was added.
      • primary_ip—the primary IP address of the DNS/DHCP Server.
      • secondary_ip—the secondary IP address of the DNS/DHCP Server.
  • id—the ID of the scheduled event to change.
  • run_postscript—if true, the Server Batch's associated customization package is applied during that scheduled update event. Before the update, the package is called with the backup option (-b). After the update, the package is called with the restore option (-r).

    If false, the customization is not applied during that scheduled event.

Responses

Status Description
Successful

Code: 200

Body:
{
  "status": "successfully"
}
Error

Code: 400

Body:
{
  "status": "fail"
}