What's New in BlueCat Gateway v20.6.1 - Platform - BlueCat Gateway - 20.6.1

Gateway Administration Guide

BlueCat Gateway

The following features and functionalities are new in BlueCat Gateway v20.6.1:

DNS Edge Python API Library (Phase I)

BlueCat Gateway v20.6.1 introduces the first phase of a DNS Edge Python library in Gateway. The initial offering delivers wrapped endpoints for key Edge use-cases, including Service Point status and better filtering of top queried external domains. This is an important first step towards BlueCat Gateway establishing itself as the connective tissue between the BlueCat Integrity and DNS Edge product families, opening up a world of possibilities for innovative and creative automation solutions for DNS Edge, Integrity, and third-party integrations.

BlueCat introduces the following Python methods for DNS Edge API:

  • API keys - Manages API access key sets for DNS Edge API access.
    • get_v1_api_apikeys

      Return the API access key sets for the current user.

    • post_v1_api_apikeys

      Create an API access key set for the current user.

    • delete_v1_api_apikey

      Delete all the API access key sets for the specified email address.

    • delete_v1_api_apikey_by_id

      Delete the API access key set with the specified client ID for the current user.

  • DNS query logs - Allow management of DNS query log entries.
    • get_v1_api_customer_dnsquerystats_count

      Return the total count of logged DNS queries per policy action type in a Customer Instance for any time interval within the last 24 hours.

    • get_v1_api_customer_dnsquerystats_topdomain

      Return the specified number of domains most frequently queried per Customer Instance for any time interval within the last 24 hours.

    • get_v1_api_customer_dnsquerystats_uniqueip

      Return the total number of unique client IPs that issued DNS queries in a Customer Instance for any time interval within the last 24 hours.

  • DNS domain lists - Controls the configuration settings, which will be handed out to any service points that connect to this customer instance.
    • get_v1_api_list_dns_by_id

      Return a list of domain lists.

    • get_v2_domainlists

      Return a list of domain lists that match the specified search string.

    • get_v2_domainlists_by_id

      Return a specific domain list that matches the given ID.

    • post_v2_domainlists

      Create a domain list.

    • put_v2_domainlists

      Replace all domains within a domain list by supplying a list of domain names.

    • delete_v2_domainlists

      Delete the domain list specified by the domain list ID.

    • patch_v2_domainlists

      Update the content of an existing domain list by adding or deleting domain names.

  • Service Points Diagnostics and Health - Troubleshoots a service point and obtains the overall health status of the service point, the service point ID, each service's status and service version, and the configured forwarder IPs.
    • get_v1_status_spdiagnostics

      Return the overall health status of the service point, the service point ID, each service’s status and service version, configured forwarder IPs, the current local time and time zone, and policy details.

    • get_v1_status_health

      Configure the DNS Edge service point behind load balancers.

    • get_v1_api_spversions

      Return a list of available service point versions, listed from the most recently released version to the oldest supported version.

    • get_v1_api_servicepoints

      Return information about all currently registered service points.

  • Sites - Management of a collection of sites or physical locations (for example, stores or regional offices) where service points are housed.
    • get_v3_api_sites

      Return information about all the sites.

    • get_v3_api_sites_by_id

      Return information of the site that matches the specified site ID.

    • post_v3_api_sites

      Create a new site.

    • post_v3_api_sites_clearcache

      Clear the cache of a site.

    • put_v3_api_sites

      Update an existing site.

    • delete_v3_api_sites

      Delete the site specified by the site ID.

  • Site Groups - Management of group of sites.
    • get_v1_api_customer_sitegroups

      Get a list of the site groups.

    • get_v1_api_customer_sitesandsitegroups_search

      Return a list of the sites that match the specified search string.

  • Logging - Management of audit logs
    • get_v1_api_audit_logs

      Return audit log records of API requests and responses.

OpenShift Deployment

BlueCat Gateway v20.6.1 introduces support for RedHat OpenShift Container Platform v4.3. Customers using OpenShift for container deployment and orchestration can now deploy Gateway containers from OpenShift to leverage the benefits of the orchestration platform.

Gateway Scheduling Enhancements

BlueCat Gateway now includes the APScheduler and Persist-Queue libraries to allow you to improve your automation workflows with scheduling and queuing capabilities natively in Gateway.

Load Workflows on Gateway Startup

This significant automation improvement provides faster availability of workflows, adaptive plugins, and apps. Previously, all workflows were loaded upon request. Now, workflows can load on startup of the Gateway container, allowing code to be executed when the container is started and before any interaction with Apache is triggered.

Gateway User Auditing

Gain visibility into who is accessing Gateway with this important security enhancement. Gateway now logs user and IP address data of logged-in users.

Workflow Exception Handling

Improve the reliability of your automation by setting custom error handlers to mitigate errors and exceptions for API calls on each endpoint.

Bulk APIs

Gateway’s capabilities for secure bulk data extraction from Address Manager extends further with the following new APIs:

  • DHCP Lease History by ID and MAC address
    • get_ip4_leases

      Get the IP4 lease information.

    • get_ip6_leases

      Get the IP6 lease information.

Additional BAM Python API Wrapper

BlueCat Gateway v20.6.1 introduces the following Python API wrapper:
  • add_user_defined_field

    Adds a user-defined field (UDF) to the given BlueCat Address Manager (BAM) object.

For complete information refer to the BlueCat Gateway Help & Documentation or the BlueCat Gateway Administration Guide.