Adding a discovery probe - Adaptive Applications - BlueCat Gateway - 23.2

Network Discovery Administration Guide

Product name
BlueCat Gateway

Network Discovery uses a series of network probes to scan and explore your local immediate network. Discovery probes do the actual work of scanning and finding hosts on your network.

You can deploy probes in two general system configurations:

  • Multiple Containers: Each probe is deployed in a separate Network Discovery container, managed by a single deployment of Network Discovery in another ("Management") container.

    You can add as many probes as needed.

    You must add a probe for each Discovery Probe container that you deploy, specifying the URL for each probe container.

  • Single Container: Both the Network Discovery Management UI and Discovery Probes are run from the same container.

    The URL for this container will use a localhost address.

Note: For proper functionality and compatibility:
  • Ensure that each probe is managed by only one management container (If a probe using v2 REST API is added to multiple containers using v1 REST API, the probe will be active only in the latest container where it was added. In other containers, the status is displayed as "Fail Management Connection").

  • Ensure that remote probes have the same API version as the management container (If a remote probe using v2 REST API is added to a management container using v1 REST API, it will result in a "Fail Discovery Probe Credential, BAM SSH Connection, Management Connection" error).

After you add discovery probes, Network Discovery will use them based on the IPv4 reconciliation policies you set up.

To add a discovery probe:
  1. From the BlueCat Gateway UI, click Network Discovery on the left sidebar.

    A list of available pages is displayed on the left sidebar.

  2. From this list, select Settings.

    The Settings page, with its various sections, is displayed.

  3. In the Probe section, click Add.

    The Add Probe page is displayed.

  4. Complete the configuration as specified:

    Field Description

    BAM SSH password and BAM SSH key

    Select whether authentication details for the probe will be through a password (BAM SSH password) or an SSH key (BAM SSH key).

    • In the BAM SSH user field, enter the BAM user name that the Probe will use to connect to BAM.

      Currently, this must be root (that is the root user).

    • If you selected BAM SSH password for the authentication type, in the BAM SSH password field, enter the password that the probe should use when connecting to BAM.

      If you selected BAM SSH key, in the BAM SSH key field, paste the SSH authentication key that the probe should use when connecting to BAM.

    API user and API password

    Enter the account details for signing in to Gateway where the Management instance of Network Discovery was deployed. This account will be used for the Gateway API.

    Management URL for remote probe

    Enter the URL for the Network Discovery Management instance.

    If you're using a Single Container configuration, use https://localhost:44300 for the Management URL.

    Note: This field is hidden if you do not have a remote probe. When configuring a remote probe, this will be set to a default value of based on the probe's protocol, domain, and port. If the domain is localhost, this field is left empty to enter a new value.

    Probe type

    Select whether the probe is Remote or Local.
    Note: You can configure only one local probe.

    Probe label

    Enter a label for the probe.

    This label will be used when logging events relating to that probe.

    Note: If you enter a label for a local probe, then https://localhost:44300 will be used for both the Management URL and Probe URL.

    Probe URL

    Enter the IP address and port for the probe. In addition, from the drop down list, select whether the IP address uses the http:// or https:// prefix.

  5. When you're done, click Submit.

    Network Discovery will attempt to add the probe using your entered SSH and API credentials. If successful, the Probe table displays a green check icon in the Status column for this probe. If unsuccessful, the Status column for the probe displays the status as Fail with a red cross icon, along with the specific error.