---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ShazzamLaunch - Global

# ShazzamLaunch - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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) {#ariaid-title2}

Creates an instance of the Shazzamlaunch class.
{#r_SL-ShazzamLaunch_DYS_DS__table_typ_tgp_tt__entry__3}

| Name | Type | Description |
|-|-|-|
| status | DiscoveryStatus | The DiscoveryStatus instance for this discovery. |
| schedule | DiscoverySchedule | The DiscoverySchedule instance for this discovery. |
[Table 1. Parameters]

{#r_SL-ShazzamLaunch_DYS_DS__table_typ_tgp_tt} {#r_SL-ShazzamLaunch_DYS_DS__table_uyp_tgp_tt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 2. Returns]

{#r_SL-ShazzamLaunch_DYS_DS__table_uyp_tgp_tt}

## ShazzamLaunch - addPortProbe(String midPPs, String portProbes, IPIncludeExcluldeCollection
ipiec) {#ariaid-title3}

Adds a single port probe to our MID services collection.
{#r_SL-addPortProbe_S_S_IPIEC__table_cmr_fjp_tt__entry__3}

| Name | Type | Description |
|-|-|-|
| midPPs | String | A hashmap with two properties. * midServer: a MIDServer instance * portProbes: a hashmap (by port probe name) of DiscoveryPortProbe instances. {#r_SL-addPortProbe_S_S_IPIEC__ul_dxt_mjp_tt} |
| 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. {#r_SL-addPortProbe_S_S_IPIEC__ul_p4r_tjp_tt} |
| ipiec | IPIncludeExcludeCollection | The range to be probed. |
[Table 3. Parameters]

{#r_SL-addPortProbe_S_S_IPIEC__table_cmr_fjp_tt} {#r_SL-addPortProbe_S_S_IPIEC__table_dmr_fjp_tt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 4. Returns]

{#r_SL-addPortProbe_S_S_IPIEC__table_dmr_fjp_tt}

## ShazzamLaunch - addRange(IPCollection ipc, String portProbes, Boolean samePhase) {#ariaid-title4}

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.
{#r_SL-addRange_IPC_S_B__table_ptp_j3p_tt__entry__3}

| 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. {#r_SL-addRange_IPC_S_B__ul_nlk_t3p_tt} |
| samePhase | Boolean | True if this should use the same phase as is currently running. |
[Table 5. Parameters]

{#r_SL-addRange_IPC_S_B__table_ptp_j3p_tt} {#r_SL-addRange_IPC_S_B__table_qtp_j3p_tt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 6. Returns]

{#r_SL-addRange_IPC_S_B__table_qtp_j3p_tt}

## ShazzamLaunch - fireShazzamProbe(String portProbe, String ip, String sensor) {#ariaid-title5}

Fires a Shazzam probe for the MID server and services in the given hash
map.
{#r_SL-fireShazzamProbe_S_S_S__table_fnj_jkp_tt__entry__3}

| 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. {#r_SL-fireShazzamProbe_S_S_S__ul_i5b_pkp_tt} |
| 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 7. Parameters]

{#r_SL-fireShazzamProbe_S_S_S__table_fnj_jkp_tt} {#r_SL-fireShazzamProbe_S_S_S__table_gnj_jkp_tt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 8. Returns]

{#r_SL-fireShazzamProbe_S_S_S__table_gnj_jkp_tt}

## ShazzamLaunch - launch(String ip, Boolean samePhase, String sensor) {#ariaid-title6}

Launches Shazzam probes as necessary, depending on the current phase of each behavior
used.
{#r_SL-launch_S_B_S__table_npn_4hp_tt__entry__3}

| 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 9. Parameters]

{#r_SL-launch_S_B_S__table_npn_4hp_tt} {#r_SL-launch_S_B_S__table_opn_4hp_tt__entry__2}

| Type | Description |
|-|-|
| Boolean | True if any probes are launched. |
[Table 10. Returns]

{#r_SL-launch_S_B_S__table_opn_4hp_tt}

## ShazzamLaunch - makeProbeSpec(String portProbe) {#ariaid-title7}

Makes an XML port probe spec for the given port probe hashmap.
{#r_SL-makeProbeSpec_S__table_cnc_nlp_tt__entry__3}

| 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. {#r_SL-makeProbeSpec_S__ul_cmc_xlp_tt} |
[Table 11. Parameters]

{#r_SL-makeProbeSpec_S__table_cnc_nlp_tt} {#r_SL-makeProbeSpec_S__table_dnc_nlp_tt__entry__2}

| Type | Description |
|-|-|
| String | An XML port probe specification |
[Table 12. Returns]

{#r_SL-makeProbeSpec_S__table_dnc_nlp_tt}