ShazzamLaunch - Global

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

    • The ShazzamLaunch script include provides methods to handle the details of launching a Shazzam probe for a given discovery.

    Use this script include to launch a Shazzam probe during the discovery scanning phase.

    ShazzamLaunch - ShazzamLaunch(DiscoveryStatus status, DiscoverySchedule schedule)

    Creates an instance of the Shazzamlaunch class.

    Table 1. Parameters
    Name Type Description
    status DiscoveryStatus The DiscoveryStatus instance for this discovery.
    schedule DiscoverySchedule The DiscoverySchedule instance for this discovery.
    Table 2. Returns
    Type Description
    void

    ShazzamLaunch - addPortProbe(String midPPs, String portProbes, IPIncludeExcluldeCollection ipiec)

    Adds a single port probe to our MID services collection.

    Table 3. Parameters
    Name Type Description
    midPPs String A hashmap with two properties.
    • midServer: a MIDServer instance
    • portProbes: a hashmap (by port probe name) of DiscoveryPortProbe instances.
    portProbes String A hashmap (byMIDServer name) that contains these properties.
    • range: An IPMetaCollection containing the ranges to be probed.
    • midserver: A MIDServer instance for the MID server to be probed.
    • portProbes: a hashmap (by port probe name) of DiscoveryPortProbe instances to be probed.
    ipiec IPIncludeExcludeCollection The range to be probed.
    Table 4. Returns
    Type Description
    void

    ShazzamLaunch - addRange(IPCollection ipc, String portProbes, Boolean samePhase)

    Adds the specified range and this discovery's port probes to scan (as defined by behavior) to the collection of MID servers and port probes that need to be probed.

    Table 5. Parameters
    Name Type Description
    ipc IPCollection The range to be discovered
    portProbes String A hashmap (by MID server name) of hashmaps containing these properties.
    • range: an IPMetaCollection containing the ranges to be probed.
    • midServer: a Mid server instance for the MID server to be probed.
    • portProbes: a hashmap (by port probe name) of DiscoveryPortProbe instances to be probed.
    samePhase Boolean True if this should use the same phase as is currently running.
    Table 6. Returns
    Type Description
    void

    ShazzamLaunch - fireShazzamProbe(String portProbe, String ip, String sensor)

    Fires a Shazzam probe for the MID server and services in the given hash map.

    Table 7. Parameters
    Name Type Description
    portProbe String A hashmap containing these properties.
    • range: an IPMetaCollection containing the ranges to be probed.
    • midServer: a MIDServer instance for the MID server to be probed.
    ip String A comma-separated list of IPs to fire probes for.
    sensor String The sys_id of the sensor that launched this probe (network discovery only).
    Table 8. Returns
    Type Description
    void

    ShazzamLaunch - launch(String ip, Boolean samePhase, String sensor)

    Launches Shazzam probes as necessary, depending on the current phase of each behavior used.

    Table 9. Parameters
    Name Type Description
    ip String A comma-separated list of IPs to fire probes for.
    samePhase Boolean True if this launch should use the same phase as is currently running.
    sensor String The sys_id of the sensor that launched this (only in network discovery).
    Table 10. Returns
    Type Description
    Boolean True if any probes are launched.

    ShazzamLaunch - makeProbeSpec(String portProbe)

    Makes an XML port probe spec for the given port probe hashmap.

    Table 11. Parameters
    Name Type Description
    portProbe String A hashmap containing these properties.
    • range: an IPMetaCollection containing the ranges to be probed.
    • midServer: a MIDServer instance for the MID server to be probed.
    • portProbes: a hashmap (by port probe name) of DiscoveryPortProbe instances to be probed.
    Table 12. Returns
    Type Description
    String An XML port probe specification