BlueCat Horizon connection - BlueCat Integrity - 26.1.0

Address Manager Administration Guide
ft:locale
en-US
Product name
BlueCat Integrity
Version
26.1.0

Address Manager v26.1.0 introduces Administration Console commands that allow users to configure a connection to the new BlueCat Horizon platform. BlueCat Horizon is BlueCat’s SaaS-based foundation that provides a single place to orchestrate your DNS/DHCP services and networks deployed on-premises and/or on the public cloud. For more information on BlueCat Horizon, refer to the BlueCat Horizon User Guide (users must be authenticated on the docs portal to view this guide).

Note: The following console commands have been added in Address Manager v26.1.0 to support initial connection of Integrity environments to Horizon, as the Horizon platform continues to develop. The Integrity and Horizon integration is planned to be extended with additional features and functionality in upcoming releases.

Connection registration token

Before configuring the Horizon connection in the Address Manager Administration Console, you must add a connection and generate a registration token in the Horizon user interface. The connection registration token is a one-time registration key that is used to establish a secure connection between Horizon and the Address Manager server. For information on creating a new connection and generating a registration token, refer to Adding new connections in the BlueCat Horizon User Guide (users must be authenticated on the docs portal to view this topic).

Note: The tech preview BlueCat Horizon User Guide currently uses the term device instead of connection. The term connection will be used in upcoming releases.

After creating a new connection and copying the registration token, enter the token in the Address Manager Administration Console.

To add the registration token:

  1. From Main Session mode, type configure horizon-connection and press ENTER.
  2. Type set registration-token <token string> and press ENTER.

Activating the Horizon connection service

After adding the registration token, activate the Horizon connection service to connect Address Manager to Horizon.

To activate the connection service:

  1. From Main Session mode, type configure horizon-connection and press ENTER.
  2. Type activate and press ENTER.

Checking the Horizon connection status

You can check the Horizon connection status by using either a quick status check from the Administration Console, or a more detailed diagnostic status check as the root user.

Quick status check

From Main Session mode, type show horizon-connection and press ENTER. This command displays the current connection status and the registration token.

Proteus> show horizon-connection
Token: exampl****123
Service: inactive

Detailed diagnostic status check

You can retrieve detailed diagnostic information about the Horizon connection service by logging into the Address Manager server as root and running the curl command detailed below.

To run the detailed diagnostic status check:

  1. From the Administration Console login prompt, log in as root. For more information on default login credentials for Address Manager, refer to BlueCat default login credentials (you must be authenticated to view this topic).
  2. Run the following command:
curl localhost:8701/info | jq '.proxyStatus[] | select(.name == "bam") | .status'

If the connection service is operating normally, the command returns running.

Deactivating the Horizon connection service

To deactivate the connection service:

  1. From Main Session mode, type configure horizon-connection and press ENTER.
  2. Type deactivate and press ENTER.