Accessing the BlueCat DDI portal - Adaptive Plugins - BlueCat Gateway - 2.0

ServiceNow BlueCat DDI Service Catalogue for Integrity Configuration Guide
ft:locale
en-US
Product name
BlueCat Gateway
Version
2.0

To access the BlueCat DDI portal, in the Navigator, select BlueCat DDI > Service Portal > BlueCat DDI Portal.

After opening the BlueCat DDI Service Catalogue portal, select the category and desired action. The following table lists the available actions for each category.

Category Available Actions
Alias Record
  • Add Alias Record
  • Update Alias Record
  • Delete Alias Record
Host Record
  • Add Host Record
  • Update Host Record
  • Delete Host Record
IP Address
  • Assign DHCPIPv4 Address
  • Assign Static IPv4 Address
  • Update IPv4 Address
  • Delete IPv4 Address
Device
  • Add Device
  • Update Device
  • Delete Device
DNS Zone
  • Add DNS Zone
  • Delete DNS Zone

The following image shows some of the categories and actions as displayed in the portal:



Alias Record Category

From the Alias Record category, users can add, update, and remove alias records. The corresponding request form in the DDI Service Catalogue includes several validations which are listed in the Validations for the Alias Record Category table below. Users can submit the request only if all required fields are completed and no validation errors appear.

Add Alias Record

  1. In Navigator, select BlueCat DDI > Service Portal > BlueCat DDI Portal.

  2. Select Catalogs > Alias Record.

  3. Select BlueCat DDI Add Alias Record.

  4. Set all the required parameters. Required parameters are marked with an asterisk (*) in the UI.
    Note: Validation applies to some fields; all validations are listed in the Validations for the Alias Record Category table.

  5. Once all required fields are complete and no validation errors remain, select Submit to submit your request.

  6. The Submitted Request window displays your request status and ticket ID, as shown in the following image.



Validations for the Alias Record Category
Action Validation
Add Alias Record

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Alias Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Alias Name: must contain only alphanumeric characters and underscores, be limited to 50 characters, and start with a letter; check that no entry with the same name already exists on Address Manager

  • Linked Record Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Linked Record: validate on Address Manager whether the linked Host Record exists within the configuration, view, and linked record zone.
Update Alias Record

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Alias Record: searching on Address Manager if the provided Alias Record exists

If present, the following input fields are automatically prepopulated with Address Manager values; users may update them as needed:

  • New Alias Name: must contain only alphanumeric characters and underscores, be limited to 50 characters, and start with a letter; check that no entry with the same name already exists on Address Manager

  • Linked Record Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Linked Record: validate on Address Manager whether the linked Host Record exists within the configuration, view, and linked record zone.
Delete Alias Record

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Alias Record: searching on Address Manager if the provided Alias Record exists

If present, the following input fields are automatically prepopulated with Address Manager values and appear as non-editable:

  • Name and Linked Record: display values from Address Manager

Host Record Category

From the Host Record category, users can add, update, and remove host records. The corresponding request form in the DDI Service Catalogue includes several validations which are listed in the Validations for the Host Record Category table below. Users can submit the request only if all required fields are completed and no validation errors appear.

The steps involved in adding a host record are the same as those of adding an alias record, which are detailed in the Add Alias Record section above. The following image shows the Add Host Record window as displayed in the UI:



Validations for the Host Record Category
Action Validation
Add Host Record

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • IP Address: validate the IP address format and confirm its existence in Address Manager configuration and view

  • Hostname: must contain only alphanumeric characters and underscores, be limited to 50 characters, and start with a letter
Update Host Record

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Host Record: searching on Address Manager if the provided Host Record exists

If present, the following input fields are automatically prepopulated with Address Manager values; users may update them as needed:

  • Host Record Name: must contain only alphanumeric characters and underscores, be limited to 50 characters, and start with a letter

  • IPv4 Address: validate the IP address format and confirm its existence in Address Manager configuration and view; multiple IPv4 addresses must be separated by a comma
Delete Host Record

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • Host Record: searching on Address Manager if the provided Host Record exists

If present, the following input fields are automatically prepopulated with Address Manager values and appear as non-editable:

  • Name and IPv4 Address: display values from Address Manager

IP Address Category

From the IP Address category, users can assign, update, and remove IPv4 Static and DHCP reserved addressed. The corresponding request form in the DDI Service Catalogue includes several validations which are listed in the Validations for IP Address Category table below. Users can submit the request only if all required fields are completed and no validation errors appear.

The steps involved in adding a host record are the same as those of adding an alias record, which are detailed in the Add Alias Record section above. The following image shows the Assign DHCP IPv4 Address window as displayed in the UI:



Validations for IP Address Category

Action Validation
Assign DHCPIPv4 Address & Assign Static IPv4 Address

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone: validate on Address Manager if the provided zone exists within the configuration and view

  • IP Address: validate the IP address format, confirm its existence, and ensure it is not assigned in Address Manager configuration and view

  • Hostname: must contain only alphanumeric characters and underscores, be limited to 50 characters, and start with a letter

  • MAC Address: validate the MAC address format
Update IPv4 Address

  • Configuration: drop-down list selection (if allowed)

  • Address: search Address Manager for the provided IP address

If found, the following input fields are automatically prepopulated with Address Manager values:

  • Address State: Static or DHCP Reserved; non-editable

  • MAC Address: display value from Address Manager; user may update if needed
Delete IPv4 Address

  • Configuration: drop-down list selection (if allowed)

  • Address: search Address Manager for the provided IP address

If present, the following input fields are automatically prepopulated with Address Manager values and appear as non-editable:

  • Address State and MAC Address: display values from Address Manager

Device Category

From the Device category, you can add, update, or remove devices. The corresponding form in the DDI Service Catalogue includes several validation details. You can submit the request only if all required fields are completed and no validation errors appear.

To add a device:
  1. In Navigator, select BlueCat DDI > Service Portal > BlueCat DDI Portal.
  2. Select Catalogs > Device category.
  3. Select BlueCat DDI Add Device.
  4. Enter the required fields. Validation applies to some of the required fields. The following image displays the fields with validation:

  5. Once you have entered the required fields and no validation errors appear, select Submit.
  6. The Submitted Request page displays the request status and ticket ID.

Validations for Device Category

Action Validation
Add Device

  • Configuration: drop-down list selection (if allowed)

  • Device Type: drop-down list selection

  • Device Name: validate on Address Manager that no entry already exists with the same name.

  • IPv4 Address: validate the IP address format, confirm its existence in an Address Manager configuration, and ensure it is not assigned to another device. This field is optional.
Update Device

  • Configuration: drop-down list selection (if allowed)

  • Device Name: validate on Address Manager that the device exists within the configuration on Address Manager. Enter the full device name, then click outside the input field to trigger validation on Address Manager.

If found, the following input fields are automatically prepopulated with Address Manager values:

  • New Device Name: validate on Address Manager that no entry already exists with the same name.

  • Device Type: read-only

  • IPv4 Address: validate the IP address format, confirm its existence in an Address Manager configuration, and ensure it is not assigned to another device. This field is optional.
Delete Device

  • Configuration: drop-down list selection (if allowed)

  • Device Name: validate on Address Manager that the device exists within the configuration on Address Manager. Enter the full device name, then click outside the input field to trigger validation on Address Manager.

If present, the following input fields are automatically prepopulated with Address Manager values and appear as non-editable:

  • Device Type and IPv4 Address: display values from Address Manager

DNS Zone Category

From the DNS Zone category, you can add or remove DNS Zones. The corresponding form in the DDI Service Catalogue includes several validation details. You can submit the request only if all required fields are completed and no validation errors appear.

To add a DNS Zone:
  1. In Navigator, select BlueCat DDI > Service Portal > BlueCat DDI Portal.
  2. Select Catalogs > DNS Zone category.
  3. Select BlueCat DDI Add DNS Zone.
  4. Enter the required fields. Validation applies to some of the required fields. The following image displays the fields with validation:

  5. Once you have entered the required fields and no validation errors appear, select Submit.
  6. The Submitted Request page displays the request status and ticket ID.

Validations for DNS Zone Category

Action Validation
Add DNS Zone

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Parent Zone: search and select a parent zone from the drop-down list of zones and sub-zones returned for the selected configuration and view. If left empty, the newly created DNS Zone will be considered a Top-Level Domain (TLD).

  • Zone Name: enter a unique name with a maximum length of 64 characters. The field is required, must not contain spaces, and must not already exist in the selected configuration and view.
Delete DNS Zone

  • Configuration: drop-down list selection (if allowed)

  • View: drop-down list selection (if allowed)

  • Zone Name: search and select a parent zone from the drop-down list of zones and sub-zones returned for the selected configuration and view.

If a zone with sub-zones Is selected, the following warning message is played:

"The selected zone is a parent zone and has one or more subzones. Deleting this zone will also delete all of its subzones."

You can still submit the request to delete the DNS zone.