2.1.1 BlueCat - BlueCat Infrastructure Assurance - 25.2.0

BlueCat LiveAssurance User Guide

ft:locale
en-US
Product name
BlueCat Infrastructure Assurance
Version
25.2.0

The following BlueCat devices are supported:

  • BlueCat Integrity: BlueCat Address Manager (BAM) and BlueCat DNS/DHCP Server (BDDS)

    See BlueCat Integrity for details.

  • BlueCat Edge: Edge service points

    See BlueCat Edge for details.

In order for LiveAssurance to run its full set of discovery and interrogation scripts for BlueCat Address Manager (BAM) and BlueCat DNS/DHCP Server (BDDS), the following types of access are required:
  • SSH

  • SNMP

  • (Required only when connecting to BAM) API

    Note: API access to BAM is required as LiveAssurance creates a session and interacts with BlueCat Address Manager via RESTful v2 API.

For SSH access to on-premise BAM and BDDS deployments, a root user needs to be used to connect your device. Before adding a BlueCat device, make sure the SSH credential for the root user is provided in the Credential Sets tab.

Add to your sshd_config:
PermitRootLogin prohibit-password
We also recommend that you limit to where you would allow root logins with a key. For example:
Match Address <ip_addr>
  PermitRootLogin prohibit-password

Simplified cloud deployment

In LiveAssurance v9.0.0 and greater, BlueCat recommends using the predefined bluecat user account (that you configure in the Credential Sets tab) for BAM and BDDS. The SSH key for the bluecat user account is created when the BAM/BDDS instance is created. This account has the required privileges to run the necessary commands.

The following image displays the credentials configured for a BAM deployed in AWS, where the username is bluecat (instead of root).

BlueCat Integrity

SNMP

  1. Before configuring the SNMP credential set, enable SNMP service on BlueCat Address Manager. See Configuring SNMP on Address Manager in the BlueCat Address Manager Administration Guide for details.

  2. Enable SNMP service on BlueCat DNS/DHCP Server. See Enabling SNMP service on DNS/DHCP Servers in the BlueCat Address Manager Administration Guide for details.

Then, add the community string from the LiveAssurance Server Credential Sets page.

LiveAssurance Server Configuration:

  1. Select the Devices tab in the sidebar, then select Credential Sets.

  2. In the Credential Sets tab, create a new/modify an existing credential set.

  3. From the Username + Password drop-down menu, select the SNMP version. The version must match your BDDS SNMP configuration.



  4. Enter a description and select the security level that matches the BDDS SNMP configuration.



  5. Select Save.

    Creating an API user in Address Manager
Note: We always recommend you defer to the vendor’s documentation for configuration. Please follow BlueCat Address Manager’s instructions for adding a new user, and then use the LiveAssurance WebUI to store the credential in the relevant Credential Profile.

LiveAssurance creates a session and interacts with BlueCat Address Manager via RESTful v2 API. LiveAssurance authenticates with Address Manager through bearer tokens.

We recommend that you create a unique username in Address Manager for auditing and security purposes. To add a user, go to the Address Manager Administration tab, select Users and Groups.



Step 1: Add the API user’s name (Indeni, in this example) in the USERNAME field.

Step 2: Under Authentication, enter the API user’s password in the Password and Confirm Password fields.

Step 3: Under User Access, select the Administrator check box.

Step 4: Select API from the Access Type drop-down menu.

Step 5: Click Add at the bottom of the page.



LiveAssurance Server Configuration

Step 5: Click on Devices icon on the side-panel to the left-hand side of the screen

Step 6: Select Credential Sets, and create a new credential set

Step 7: Select Username + Password

Step 8: Enter the username (Indeni in this example) and credentials you created in Address Manager

Step 9: Select the HTTPS check box.

Step 10: Click Add



Note: In 8.2.2, you have an option to push DHCP statistics information to the LiveAssurance Server.
DHCP Statistics (Optional)

The DHCP Statistics service uses a monitoring module that runs on the DNS/DHCP Server to collect statistics by sniffing DHCP packets. When enabled, DHCP statistics information is collected by the DNS/DHCP server based on the configured parameters and sent to a configured destination. You can choose to send the information to a LiveAssurance server.

Note: We always recommend you defer to the vendor’s documentation for configuration. Please follow the instructions for configuring DHCP Statistics in BlueCat Address Manager (BAM) here.
Configuring the DHCP Statistics Service in BAM
  • BAM > Servers > [Select a BDDS server]

  • Click on the BDDS Server name and select Service Configuration in the drop-down menu



  • In the Service Type drop-down menu select DHCP Statistics



Example configuration:



Output URI

The output URI is the LiveAssurance HTTP endpoint that will be consuming the DHCP statistics information. Two modes are supported.

1 – Without authorization (default)

2 – With authorization (AuthZ)

LiveAssurance Server Configuration
Note: For DHCP statistics collection, the device pushes telemetry information to the LiveAssurance HTTP endpoint, instead of LiveAssurance polling data from the device. You must ensure the device can connect to the LiveAssurance server using port 8088 (non-AuthZ mode) or 8443 (AuthZ mode).
Enabling AuthZ and obtaining a token

Authorization is a one-time configuration needed to protect the API. Follow these three steps using the curl command to enable authorization:

  1. Reset the admin role password (only needed once effectively bootstrapping AuthZ)

  2. Create the bdds-integrator role (only needed once)

  3. Obtain tokens with the bdds-integrator role’s authorization (repeat to get a new token if desired)

Step 1 – Reset the admin role’s password

We share a one-time password (OTP) with the customer to bootstrap the admin role (this is the same as bootstrapping AuthZ. After resetting the admin’s role password, authorization is mandatory to access the API and access over http at port 8088 is disabled.

curl -k -H "Authorization: Basic YWRtaW46bXlwYXNzd29yZAo=" https://<ip-address>:8443/auth/reset/admin

In this example, the OTP would be YWRtaW46bXlwYXNzd29yZAo= (note that this isn’t the actual OTP)

The response has the following form returning the new admin role’s password and authorization header. At this point, AuthZ is bootstrapped.



Step 2 – Create the bdds-integrator role

The admin role is for administrating roles and tokens generated with the admin role. The User needs to create a designated role to get the correct token for DHCP, the bdds-integrator role.

curl -k -d '{"role":"bdds-integrator"}' -H "Authorization: Basic YWRtaW46bjZjSEs3ZVpDeE9QbnNCU1RrOWc=" https://<ip-address>:8443/auth/role

Using the Authorization provided in the admin role reset step, create the bdds-integrator role as in the example above.

The response has the following form returning the bdds-integrator role’s password and authorization header.



Step 3 – Obtaining tokens with the bdds-integrator roles’ authorization

Using the bdds-integrator role’s authorization we can request Bearer tokens for pushing DHCP metrics to LiveAssurance. Note that these tokens have an expiry date. You can request any expiry for your tokens by adding a ttl query parameter to the request. For example, adding ttl=26280h will produce tokens that will expire in 3 years from the issuedAt date.

curl -k -H "Authorization: Basic YmRkcy1pbnRlZ3JhdG9yOm15U2VjdXJlUGFzc3dvcmQ=" https://<ip-address>:8443/auth/token?ttl=26280h

Response:



BlueCat Edge

LiveAssurance connects to the supported Edge Service Point devices via SSH. For SSH access, you must use an existing operations user account and the SSH key for that account. By using the predefined operations user account, there is no additional configuration required on the Edge Service Point devices.

The following image displays the credentials configured for an Edge Service Point using the operations user account.

To view the list of metrics retrieved from the Edge Service Points, select Code from the sidebar, and then navigate to the sp folder (bluecat > edge > sp).

To view the alerts assocaited with Edge Service Points, select Issues from the sidebar, and then click the Knowledge Explorer tab. You can filter to view only the alerts related to Edge Service Points.