GET /bsus/api/v1/servergroups/{bam_id} - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

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

Description

Retrieves information about a specific Server Group in Address Manager based on the ID provided.

Parameters

Name Description
bam_id Location: query

Type: string

The ID of the Server Group in Address Manager from which you would like to retrieve information.

Responses

Status Description
Successful

Code: 200

Body:
{
  "data": {
    "bam_id": "string",
    "name": "string",
    "servers": [
      {
        "bam_id": int,
        "name": "string",
        "management_ip": "string",
        "service_ip": "string",
        "appliance_type": "string",
        "role_enabled": "string",
        "configuration": "string",
        "status": "string",
        "message": "string"
      }
    ]
  }
}
Returned data has the following fields.
  • bam_id—the ID of the Server Group in Address Manager.
  • name—the name of the Server Group in Address Manager.
  • servers—an array of server items as follows:
    • 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.
    • appliance_type—the appliance type of the DNS/DHCP Server.
    • role_enabled—the role that has been enabled on the DNS/DHCP Server, such as DNS.
    • configuration—the name of the configuration in Address Manager in which the server has been added.
    • status—the current status of the DNS/DHCP Server.
    • message—the message associated with the DNS/DHCP Server (if any).
Error

Code: 400

Body:
{
  "error": "Cannot import the servergroup existing in the BSUS"
}

Code: 404

Invalid Server Group ID.

Body:
{
  "error": "No server group found with provided id"
}

Code: 500

Internal server error.