POST /overlay/api/v1/settings - Adaptive Applications - BlueCat Gateway - 22.7

BlueCat Overlay for Microsoft

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.7

Configure BlueCat Overlay for Microsoft settings.

Request
POST http://<Gateway_url>/overlay/api/v1/settings
Authorization: <token>
Content-Type: application/json

{
    "settings":
        {
	     "overlaySyncLeases": true,
	     "overlaySyncRR": true,
	     "overlayDiscoverNetworks": true,
	     "overlayDiscoverZones": true,
	     "overlaySyncDHCPOpts": true,
	     "overlaySyncDNSOpts": true,
	     "overlaySecZoneNotif": false,
	     "overlayPreserveMissingNet": true,
	     "overlayPreserveMissingZone": true,
	     "overlayCreateGenericHost": true,
	     "overlayLinkedExternalRecords": true
        },
        "services":"all"
}
Parameters
  • overlaySyncLeases—synchronizes DHCP lease information from Windows DHCP Servers into Address Manager.
  • overlaySyncRR—synchronizes DNS records from Windows DNS Servers into Address Manager.
  • overlayDiscoverNetworks—enable this option to always add new DHCP Networks to Address Manager when they are created on Windows DHCP Servers.
  • overlayDiscoverZones—enable this option to always add new DNS Zones to Address Manager when they are created on Windows DNS Servers.
  • overlaySyncDHCPOpts—synchronizes DHCP options from Windows DHCP Servers into Address Manager.
  • overlaySyncDNSOpts—synchronizes DNS options from Windows DNS Servers into Address Manager.
  • overlaySecZoneNotif—enable this option to enable Secondary Zone Notifications. BlueCat Address Manager allows for BlueCat DNS/DHCP Servers to notify Address Manager of any changes to DNS records and IP addresses in near real-time when DNS/DHCP Servers are configured as Secondary DNS Servers. Any DNS changes occurring on Windows DNS Servers are propagated to DNS/DHCP Servers which are kept up-to-date in Address Manager. Select this option if your Address Manager is configured to accept DNS notifications from a Secondary DNS Zone.
    Note: This option is not compatible with synchronizing DNS Records and DHCP Leases.
  • overlayPreserveMissingNet—enable this option to preserve a DHCP network in Address Manager when it is removed from Windows DHCP Servers. By default, when a DHCP network is removed from a Windows DHCP Server, the associated DHPC network is also removed from Address Manager.
  • overlayPreserveMissingZone—enable this option to preserve a DNS zones in Address Manager when it is removed from Windows DNS Servers. By default, when a DNS Zone is removed from a Windows DNS Server, the associated DNS zone is also removed from Address Manager.
  • overlayCreateGenericHost—enable this option to create Host Records with missing networks as Generic Records in Address Manager. By default, Host DNS Records (A/AAAA) in Address Manager require a corresponding IPv4 or IPv6 network to exist. When the network containing the IP address of the Host Record is not found, the Host Record is not imported into Address Manager.
  • overlayLinkedExternalRecords—enable this option to link records to External Host Records in Address Manager. By default, when creating DNS records that depend on other records, such as CNAME, MX, or SRV records, the Host record must exist in Address Manager. If the related DNS record is not found, the record is not imported into Address Manager.
  • services—enter the services that you would like to synchronize. Enter dns to retrieve and synchronize DNS data; enter dhcp to retrieve and synchronize DHCP data; or enter all to retrieve and synchronize DNS and DHCP data.
Successful response
200 OK
Content-Type: application/json
[
    {
        "setting": "overlaySyncLeases",
        "updated": true
    },
    {
        "setting": "overlaySyncRR",
        "updated": true
    },
    {
        "setting": "overlayDiscoverNetworks",
        "updated": true
    },
    {
        "setting": "overlayDiscoverZones",
        "updated": true
    },
    {
        "setting": "overlaySyncDHCPOpts",
        "updated": true
    },
    {
        "setting": "overlaySyncDNSOpts",
        "updated": true
    },
    {
        "setting": "overlaySecZoneNotif",
        "updated": true
    },
    {
        "setting": "overlayPreserveMissingNet",
        "updated": true
    },
    {
        "setting": "overlayPreserveMissingZone",
        "updated": true
    },
    {
        "setting": "overlayCreateGenericHost",
        "updated": true
    },
    {
        "setting": "overlayLinkedExternalRecords",
        "updated": true
    }
]