Changes and new features - Adaptive Applications - BlueCat Gateway - 23.1

BlueCat Server Update Services Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
23.1

The BlueCat Server Update Services (BSUS) v23.1 release introduces the following major feature enhancements:

BSUS Access Rights management

You can now manage BSUS access rights for users, restricting them to specific Server Batches. You can assign BSUS access rights to any Address Manager user group. You can also specify a BSUS Administrator user group within the installation environment file, whose members have rights to edit any Server Batch.

For more details, see Managing BSUS Access Rights.

Staged Updates

You can now explicitly plan and stage updates with no scheduled date and time. BSUS will not apply these updates automatically. Instead, you manually trigger these updates at a time of your choosing.

For more details, see Planned Updates.

Configuration Templates

Configuration Templates let you define a set of server settings that you want to assign to servers during (or outside) an upgrade. After creating your collection of Configuration Templates, you can add a subset to a Server Batch, then assign a specific template to a server from that subset.

For more details, see Configuration Templates.

Syslog server support

You can now configure a syslog server for BSUS events. Any events that would be sent to the Event List (formerly the Event Viewer) are also sent to the configured syslog server.

For more details, see Sending events to a syslog log server.

BSUS Service Account

You can now explicitly configure an Address Manager Service Account for use with BSUS features. Some features (such as Configuration Templates) require the use of an Address Manager Service Account.

For more details,see Configuring the BSUS Service Account.

UI enhancements

The UI for BSUS has been revised to align with that of Address Manager and other BlueCat products:

  • The Scheduled Updates tab is now called the Planned Updates tab. Deployment Progress for each scheduled update is now displayed in a progress bar.

  • The Preferences tab has changed to the Administration tab. The configuration experience for settings and items in this tab have also been improved.

New and updated API endpoints

Tip: You can access the latest REST API Swagger documentation by entering the following URL in your browser: http://<Gateway_hostname_or_IP>/bsus/api/v1/doc

From here, you can view a list of all supported API methods, their input parameters, and test each API method.

New API endpoints in this version:

API Endpoint Description
POST /bsus/api/v1/deployment/stage-updates

Stage update patches.

GET /bsus/api/v1/servers/{id}/service-configuration-template/differences

Get the differences in a configuration template, based on a provided ID.

POST /bsus/api/v1/servers/{id}/service-configuration-template/apply

Apply a service Configuration Template based on a provided ID.

GET /bsus/api/v1/servers/{id}/service-configuration-template/download

Download a service Configuration Template based on a provided ID.

PUT /bsus/api/v1/servers/{id} Adds a service Configuration template based on the id provided.

GET /bsus/api/v1/service_configuration_template

Get all service Configuration Templates.

.

POST /bsus/api/v1/service_configuration_template

Add a service Configuration Template based on a provided name.

DELETE /bsus/api/v1/service_configuration_template/{name}

Delete a service Configuration Template based on a provided name.

PUT /bsus/api/v1/service_configuration_template/{name}

Update a service Configuration Template based on a provided name.

GET /bsus/api/v1/service_configuration_template/{name}

Get a Configuration Template based on a provided name.

GET /bsus/api/v1/template_settings

Retrieve the set of global settings related to Configuration Templates.

PUT /bsus/api/v1/template_settings

Update the set of global settings related to Configuration Templates.

GET /bsus/api/v1/service_account

Get the account details for the service account used by the API when signing in to BlueCat Address Manager.

POST /bsus/api/v1/service_account/test

Test the service account.

PUT /bsus/api/v1/service_account

Update the API service account connection to BlueCat Address Manager.

POST /bsus/api/v1/job_restoration

When updating BlueCat Server Update Services itself, this endpoint restores the set of scheduled jobs that were saved at the beginning of the process.

POST /bsus/api/v1/scheduled_update/apply

Immediately applies a staged update to servers in its Server Batch.

PUT /bsus/api/v1/data_retention

Set the current number of days for which BSUS event data is retained.

GET /bsus/api/v1/data_retention

Gets the current setting for the number of days for which BSUS event data is retained.

GET /bsus/api/v1/access-rights

Get the current set of all BSUS access right permission settings for all BSUS non-administrator user groups..

PUT /bsus/api/v1/access-rights/{group_name}

Update the access rights to Server Batches for a specific BSUS user group.

DELETE /bsus/api/v1/access-rights/{group_name}

Deletes BSUS access rights completely for a BSUS user group, removing access to all Server Batches..

GET /bsus/api/v1/access-rights/{group_name} Retrieve the current set of all BSUS access right permission settings for a specific BSUS non-administrator user group.
GET /bsus/api/v1/portal_server Retrieve the settings for the current portal host and port that DNS/DHCP servers use to connect with BSUS for acquiring staged patch files and configuration packages.
POST /bsus/api/v1/portal_server/test Tests the portal server connection, which is used by DNS/DHCP servers to connect with BSUS for acquiring staged patch files and configuration packages.
PUT /bsus/api/v1/portal_server Update the settings for the current portal host and port that DNS/DHCP servers use to connect with BSUS for acquiring staged patch files and configuration packages.
GET /bsus/api/v1/user-groups Retrieve a list of all user groups, including user groups that do not have access to BSUS Server Batches.
PUT /bsus/api/v1/syslog Update syslog server configuration.
POST /bsus/api/v1/syslog/test Send a test message to the syslog server.
GET /bsus/api/v1/syslog Get the current syslog server configuration.
GET /bsus/api/v1/server{id}

Assign a Configuration template to a server.

Updated API endpoints in this version:

API Endpoint Description

GET /bsus/api/v1/batches

New returned values: outdated_agent, service_sync_status, profile, server_id, service_template_id, service_templates array (id)

GET /bsus/api/v1/batches/{batch_id}

New returned values: outdated_agent, server_id, service_sync_status, profile, service_template_id, service_templates array (id, name)

POST /bsus/api/v1/batches

New parameters: service_template_ids

PUT /bsus/api/v1/batches/{batch_id}

New parameters: service_template_ids

Removed parameters: id, order, software_version, patches_installed, services_health, configuration

POST /bsus/api/v1/deployment/apply

New parameters: servers array (management_ip, bam_id), patches array (id, name)

Removed parameters: datetime

POST /bsus/api/v1/deployment/schedule

New parameters: servers array (management_ip, bam_id), patches array (id, name), service_templates array (id, name)

GET /bsus/api/v1/servers/server-time Endpoint removed.

Other changes:

  • The schedule window now displays more information about scheduled updates, including how close the scheduled time is relative to now. The dashboard also now shows batch information in a table instead of tabs.

  • The BDDS Connection timeout setting is no longer available in the Administration tab, but it is still accessible through the BSUS API.

  • The Planned Updates tab now displays upcoming schedules and completed schedules separately.

  • The Patch Upload window has been improved. After you enter the upload file and MD5 string, BSUS automatically fills in the other fields.

Addressed issues

This release addresses several issues, including the following:

  • Addressed an issue that caused the data stored in Elasticsearch to accumulate, leading to a significant increase in disk space consumption after using BSUS for a long time.
  • Fixed an issue where BSUS reported a successful update event too early when applying cumulative updates, such as 9.2.1 to 9.2.2 to 9.3.1, and so on.
  • BSUS now shows a detailed error message when SSH test is failed
  • BSUS now blocks all non-TLS 1.2 connections to RabbitMQ.
  • The default SSH password will no longer be exposed on password fields and will appear as a placeholder string.
  • Fixed an issue that prevented some schedules from being run when a user modifies a scheduled update.
  • When applying an update, BSUS will now skip (not install) superceded patches.