Configuring Global Settings - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

Product name
BlueCat Gateway

Configuring the Global SSH User Account

In order to use BlueCat Server Update Services (BSUS) to configure your DNS/DHCP Servers, BSUS must establish an SSH connection to the DNS/DHCP servers. It does so to install a BSUS application on the DNS/DHCP Server so that the server can communicate with BlueCat Server Update Services and perform any upgrades when requested.

If all of your DNS/DHCP Servers use the same username and password, you can configure a Global SSH User Account section to use as a default. BSUS will use the global account to fill in the username and password when adding DNS/DHCP Servers to a batch.

To set the username and password
  1. Click the Preferences tab within the BlueCat Server Update Services workflow.
  2. Under Global SSH User Account, enter the following information:
    • Username—enter the common username that will be used when adding a new DNS/DHCP Server.
    • Password—enter the common password that will be used when adding a new DNS/DHCP Server.
  3. Click Update to save the credentials.

Configuring the BAM API Timeout

In large, dynamic environments, API calls to Address Manager may take longer than expected to create or return content. You can test the Address Manager database connection to ensure that the API calls can successfully send and receive content from Address Manager, and configure the API timeout to stop any API calls that have not been successfully executed within a specified timeout.

To update the BAM API timeout
  1. Under BAM API timeout, enter the following information:
    • Click TEST BAM DB CONNECTION to verify that BlueCat Server Update Services has access to the Address Manager database.
    • API Timeout—select the API timeout period.
  2. Click Update to update the API timeout value.

Configuring the BDDS Connection Timeout

By default, the service agent will refresh the server data in BlueCat Server Update Services every minute. You can configure the timeout to a higher refresh period if needed.

To update the default timeout
  1. Under BDDS Connection Timeout, enter the following information:
    • Agent Timeout Value—select the timeout period.
  2. Click Update to update the timeout value.

Configuring SSH Private Keys

If you want BSUS to use SSH keys to sign in to the servers that it manages (instead of a root user password), you must add those keys to this list. Later, when you add DNS/DHCP servers to a Server Group, you can choose an SSH key from the list that BSUS will use when signing in to that server.

While BSUS needs root access to perform updates on the server, these SSH keys do not need to be for the server's root account. BSUS will automatically switch to the root account after it signs in. Depending on how your systems are configured, this might require an additional password.

To add a new SSH key:
  1. Under SSH Private Key, click Add Key.
  2. Im the expanded window, enter the following:
    • Name—enter a unique user-facing label for the account. BSUS will use this name when you're asked to select an SSH key to use for signing in.
    • Username—enter the username that will be used when logging in to the server.
    • Require 'root' password—some systems let users switch to the root user after they sign in with no further authorization. If your system requires an additional password to switch to the root user, select this checkbox and enter the root user's password.
      Note: If the username for this entry is "root", BSUS assumes you're entering an SSH key for the root account and will disable these fields.
    • Private key—the SSH private key data that was produced when creating the SSH key pair.
    • Passphrase—the key's passphrase, if one was used when generating the SSH key pair.
  3. Click Add Key again when you're done.
To delete a previously-added SSH key:
  1. Under SSH Private Key, within the list of SSH keys, select the key that you want to delete.

    A Delete button should appear in the Delete column.

  2. Click the key's Delete button.

Managing customization packages

Customization packages are customized sets of files that back up and restore server settings that might be lost during an upgrade. Before you assign a customization package to a Server Batch, you must import it into BSUS.

For more details on customization packages, see Working with upgrade customization packages.

To import a customization package:
  1. On the Preferences page, scroll down to the Customization section.
  2. Within the Customization section, in Name, enter a user-facing name for the customization package.
  3. Click Browse, browse to the customization package that you want to import (a *.zip file), and click Open.
  4. When you're done, click Upload.

    The package is uploaded to BSUS so that it can send it to the servers it manages.

To download an imported customization package:
  1. On the Preferences page, scroll down to the Customization section.
  2. Click the download icon () next to the customization package that you want to delete.
To remove an imported customization package:
  1. Remove the customization package from any Server Batches that it's assigned to. To do so:
    1. On the Dashboards page, click the down arrow for the Batch to which the package is assigned and choose Modify.
    2. Clear the Install only and Install and Apply checkboxes.
    3. Click Finish when you're done.
  2. On the Preferences page, scroll down to the Customization section.
  3. Click the trash icon () next to the customization package that you want to delete.
    Warning: BSUS will not ask for a confirmation for this deletion. If you want to retain a copy of the existing package, download it first.