Configure Shazzam probe

  • Release version: Xanadu
  • Updated August 1, 2024
  • 3 minutes to read

    • When you run Discovery, the Shazzam probe finds your active network devices by scanning specified ports on specified IP address ranges. If the list of IP ranges being scanned is large, you can configure the Shazzam payload for JSON encoding to reduce its size.

    Before you begin

    Role required: admin

    About this task

    You control the behavior of individual Shazzam probes using basic and advanced parameters.

    For instructions on configuring probe parameters, see Set probe parameters.

    Note:
    The Shazzam payload is controlled by the following MID Server properties. These properties do not need to be added to the MID Server. The Shazzam probe will fall back on their default values.
    • The shazzam.chunk_size property controls the maximum number of IP addresses Shazzam can scan in parallel.
    • The mid.shazzam.regulator.interval_ms property sets the interval in which Shazzam can launch packets.
    • The mid.shazzam.regulator.packets_per_interval property sets the number of packets that Shazzam can launch in that time interval.

    Procedure

    1. Navigate to All > Discovery Definition > Probes.
    2. Select Shazzam.
    3. Add or edit parameters in the Probe Parameters related list.
    4. Configure the Shazzam parameters.
      These parameters are available for fine-tuning the Shazzam probe. These values are defined in the probe record only.
      Table 1. Shazzam advanced parameters
      Parameter Description
      BannerTCP_waitForConnectMS Sets the number of milliseconds the BannerTCP scanner waits for a connection and banner.

      Default: 1500
      debug Enables debug logging if set to true.

      Default: false
      delay_wbem Delays classification of systems with a WBEM port open until the final Shazzam sensor job. For a large schedule discovering many WBEM ports, delaying classification until the last sensor job could cause the node to run out of memory. Setting this parameter to false allows classification of these systems to occur across all Shazzam sensor jobs.

      Default: true
      DNS_alternativePort Deprecated
      DNS_waitForResponseMS Sets the number of milliseconds the DNS scanner waits for a response.

      Default: 1000
      GenericTCP_waitForConnectMS Sets the number of milliseconds the GenericTCP scanner waits for a connection.

      Default: 1000
      HTTP_waitForConnectMS Sets the number of milliseconds the HTTP scanner waits for a connection.

      Default: 500
      HTTP_waitForResponseMS Sets the number of milliseconds the HTTP scanner waits for a response.

      Default: 500
      NBT_alternativePort Deprecated
      NBT_waitForResponseMS Sets the number of milliseconds the NBT scanner waits for a response.

      Default: 500
      shazzam_report_inactive When true, reports devices that are alive but inactive. For example, a device has no ports open but refuses at least one port connection request.

      Default: true
      scanner_log Enables scanner logging if set to true. This logging information appears in the Shazzam probe response.

      Default: false
      shazzam_report_dead When true, reports devices with dead IP addresses. For example, a device that has all ports closed.

      Default: false
      SNMP_alternativePort Deprecated
      SNMP_tapIntervalMS Sets the number of milliseconds the SNMP scanner waits between taps.

      Default: 1000
      SNMP_taps Sets the number of taps (requests) the SNMP scanner attempts.

      Default: 2
      SNMP_waitForResponseMS Sets the number of milliseconds the SNMP scanner waits for a response after the last tap.

      Default: 1000
      TLS_keepOriginalCertificate When true and Discovery is running, the certificate_file field in the cmdb_ci_certificate is populated with the original certificate. This can increase your payload size.

      Default: false

    Control Shazzam payload size

    A system property converts Shazzam payloads into JSON strings, which dramatically reduces their size. This setting prevents nodes from running out of memory when a single schedule discovers large numbers of IP ranges.

    Before you begin

    Role required: admin

    About this task

    The glide.discovery.shazzam_ranges_json property is set to true for new instances. This setting encodes the payload as a JSON string. The property is configurable by administrators and is available in the Discovery Definition > Properties module. The property label is Use JSON for IP ranges in Shazzam in the module.

    This property is set to false in upgraded instances and is not visible by default. Adding the property manually to your upgraded instance enables the feature, but does not add it to the Discovery Definition > Properties module. To enable JSON encoding and add it to the module, import the update set attached to KB0687626.

    Procedure

    1. In the navigation filter, type sys_properties.list and press Enter.
    2. In the list of system properties, click New.
    3. Complete the form, using these field values:
      • Name: glide.discovery.shazzam_ranges_json
      • Description: Encodes the Shazzam payload in JSON.
      • Value: true
    4. Click Submit.