POST /bhm/api/v1/migrate_agent - Adaptive Applications - BlueCat Gateway - 22.2

BlueCat Health Monitoring Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
22.2

Description

Update the server agent on servers that require an update.

Parameters

Name Description
body Location: body

Type: application/json

Information about the servers requiring update in the following format:
{
   "servers": [
      {
         "authentication_method": string,
         "server_name": string,
         "username": string,
         "password": string,
         "password_root": string,
         "key_name": string
      }
   ]
}
Where:
  • authentication_method: The server authentication method, either password or private_key.
  • server_name: The name of the DNS/DHCP server that will be upgraded.
  • username: If password has been selected as authentication method, the SSH username that will be used for DNS/DHCP server authentication.
  • password: If password has been selected as authentication method, the SSH password that will be used for DNS/DHCP server authentication.
  • password_root: The root password, required if the SSH user is not a root user.
  • key_name: If private_key has been selected as the authentication method, the name of the SSH key that will be used for authentication. If you have not previously added an SSH key, refer to Managing SSH keys.
Example body:
{
   "servers": [
      {
         "authentication_method": "password",
         "server_name": "server1",
         "username": "user",
         "password": "pass",
         "password_root": "rootpass"
      }
   ]
}

Responses

Status Description
Successful

Code: 200

Body:
{
  "data": [
    {
      "authentication_method": string,
      "server_name": string,
      "status": string,
      "username": string
    }
  ]
}