{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":1110,"path":"api-reference/server-api-reference/c_ShazzamLaunchAPI.md","title":"ShazzamLaunch - Global","bundle":null,"doc_type":null,"release":"australia","body":"\n# ShazzamLaunch- Global\n\nThe ShazzamLaunch script include provides methods to handle the details of launching a Shazzam probe for a given discovery.\n\nUse this script include to launch a Shazzam probe during the discovery scanning phase.\n\n**Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md)\n\n## ShazzamLaunch - ShazzamLaunch\\(DiscoveryStatus status, DiscoverySchedule schedule\\)\n\nCreates an instance of the Shazzamlaunch class.\n\n|Name|Type|Description|\n|----|----|-----------|\n|status|DiscoveryStatus|The DiscoveryStatus instance for this discovery.|\n|schedule|DiscoverySchedule|The DiscoverySchedule instance for this discovery.|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n## ShazzamLaunch - addPortProbe\\(String midPPs, String portProbes, IPIncludeExcluldeCollection ipiec\\)\n\nAdds a single port probe to our MID services collection.\n\n<table id=\"table_cmr_fjp_tt\" class=\"parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nmidPPs\n\n</td><td>\n\nString\n\n</td><td>\n\nA hashmap with two properties. -   midServer: a MIDServer instance\n-   portProbes: a hashmap \\(by port probe name\\) of DiscoveryPortProbe instances.\n\n</td></tr><tr><td>\n\nportProbes\n\n</td><td>\n\nString\n\n</td><td>\n\nA hashmap \\(byMIDServer name\\) that contains these properties. -   range: An IPMetaCollection containing the ranges to be probed.\n-   midserver: A MIDServer instance for the MID server to be probed.\n-   portProbes: a hashmap \\(by port probe name\\) of DiscoveryPortProbe instances to be probed.\n\n</td></tr><tr><td>\n\nipiec\n\n</td><td>\n\nIPIncludeExcludeCollection\n\n</td><td>\n\nThe range to be probed.\n\n</td></tr></tbody>\n</table>|Type|Description|\n|----|-----------|\n|void| |\n\n## ShazzamLaunch - addRange\\(IPCollection ipc, String portProbes, Boolean samePhase\\)\n\nAdds 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.\n\n<table id=\"table_ptp_j3p_tt\" class=\"parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nipc\n\n</td><td>\n\nIPCollection\n\n</td><td>\n\nThe range to be discovered\n\n</td></tr><tr><td>\n\nportProbes\n\n</td><td>\n\nString\n\n</td><td>\n\nA hashmap \\(by MID server name\\) of hashmaps containing these properties. -   range: an IPMetaCollection containing the ranges to be probed.\n-   midServer: a Mid server instance for the MID server to be probed.\n-   portProbes: a hashmap \\(by port probe name\\) of DiscoveryPortProbe instances to be probed.\n\n</td></tr><tr><td>\n\nsamePhase\n\n</td><td>\n\nBoolean\n\n</td><td>\n\nTrue if this should use the same phase as is currently running.\n\n</td></tr></tbody>\n</table>|Type|Description|\n|----|-----------|\n|void| |\n\n## ShazzamLaunch - fireShazzamProbe\\(String portProbe, String ip, String sensor\\)\n\nFires a Shazzam probe for the MID server and services in the given hash map.\n\n<table id=\"table_fnj_jkp_tt\" class=\"parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nportProbe\n\n</td><td>\n\nString\n\n</td><td>\n\nA hashmap containing these properties.-   range: an IPMetaCollection containing the ranges to be probed.\n-   midServer: a MIDServer instance for the MID server to be probed.\n\n</td></tr><tr><td>\n\nip\n\n</td><td>\n\nString\n\n</td><td>\n\nA comma-separated list of IPs to fire probes for.\n\n</td></tr><tr><td>\n\nsensor\n\n</td><td>\n\nString\n\n</td><td>\n\nThe sys\\_id of the sensor that launched this probe \\(network discovery only\\).\n\n</td></tr></tbody>\n</table>|Type|Description|\n|----|-----------|\n|void| |\n\n## ShazzamLaunch - launch\\(String ip, Boolean samePhase, String sensor\\)\n\nLaunches Shazzam probes as necessary, depending on the current phase of each behavior used.\n\n|Name|Type|Description|\n|----|----|-----------|\n|ip|String|A comma-separated list of IPs to fire probes for.|\n|samePhase|Boolean|True if this launch should use the same phase as is currently running.|\n|sensor|String|The sys\\_id of the sensor that launched this \\(only in network discovery\\).|\n\n|Type|Description|\n|----|-----------|\n|Boolean|True if any probes are launched.|\n\n## ShazzamLaunch - makeProbeSpec\\(String portProbe\\)\n\nMakes an XML port probe spec for the given port probe hashmap.\n\n<table id=\"table_cnc_nlp_tt\" class=\"parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nportProbe\n\n</td><td>\n\nString\n\n</td><td>\n\nA hashmap containing these properties.-   range: an IPMetaCollection containing the ranges to be probed.\n-   midServer: a MIDServer instance for the MID server to be probed.\n-   portProbes: a hashmap \\(by port probe name\\) of DiscoveryPortProbe instances to be probed.\n\n</td></tr></tbody>\n</table>|Type|Description|\n|----|-----------|\n|String|An XML port probe specification|\n\n"}}