---
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


---

# ProbeHandlerSNMP - Global

# ProbeHandlerSNMP - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

The ProbeHandlerSNMP script include is a discovery probe handler for SNMP probes, invoked when an SNMP probe is about to be created.

You can use this script include in any server-side script where you need to configure an SNMP probe.

## ProbeHandlerSNMP - addBoolean(String dbName, String paramName, String paramMap) {#ariaid-title2}

Adds a boolean value to the parameter map.
{#r_PHS-addBoolean_S_S_S__table_qbv_4br_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| dbName | String | The database name |
| paramName | String | The parameter name |
| paramMap | String | The parameter map |
[Table 1. Parameters]

{#r_PHS-addBoolean_S_S_S__table_qbv_4br_5t} {#r_PHS-addBoolean_S_S_S__table_rbv_4br_5t__entry__2}

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

{#r_PHS-addBoolean_S_S_S__table_rbv_4br_5t}

## ProbeHandlerSNMP - addDebug(String paramMap) {#ariaid-title3}

Adds debugging to the probe handler.
{#r_PHS-addDebug_S__table_zf5_x1r_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 3. Parameters]

{#r_PHS-addDebug_S__table_zf5_x1r_5t} {#r_PHS-addDebug_S__table_ag5_x1r_5t__entry__2}

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

{#r_PHS-addDebug_S__table_ag5_x1r_5t}

## ProbeHandlerSNMP - addJavascriptHandlers(String paramMap) {#ariaid-title4}

Adds a JavaScript handler.
{#r_PHS-addJavascriptHandlers_S__table_sg5_hcr_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 5. Parameters]

{#r_PHS-addJavascriptHandlers_S__table_sg5_hcr_5t} {#r_PHS-addJavascriptHandlers_S__table_tg5_hcr_5t__entry__2}

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

{#r_PHS-addJavascriptHandlers_S__table_tg5_hcr_5t}

## ProbeHandlerSNMP - addOIDAutoResolve(String paramMap) {#ariaid-title5}

Adds OID automatic resolution.
{#r_PHS-addOIDAutoResolve_S__table_ntg_gbr_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 7. Parameters]

{#r_PHS-addOIDAutoResolve_S__table_ntg_gbr_5t} {#r_PHS-addOIDAutoResolve_S__table_otg_gbr_5t__entry__2}

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

{#r_PHS-addOIDAutoResolve_S__table_otg_gbr_5t}

## ProbeHandlerSNMP - addOIDSpec(String paramMap) {#ariaid-title6}

Adds OID specifications to the parameter map.
{#r_PHS-addOIDSpec_S__table_zgg_11r_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 9. Parameters]

{#r_PHS-addOIDSpec_S__table_zgg_11r_5t} {#r_PHS-addOIDSpec_S__table_ahg_11r_5t__entry__2}

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

{#r_PHS-addOIDSpec_S__table_ahg_11r_5t}

## ProbeHandlerSNMP - addSensorHandler(String paramMap) {#ariaid-title7}

Adds a sensor handler.
{#r_PHS-addSensorHandler_S__table_qbt_zbr_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 11. Parameters]

{#r_PHS-addSensorHandler_S__table_qbt_zbr_5t} {#r_PHS-addSensorHandler_S__table_rbt_zbr_5t__entry__2}

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

{#r_PHS-addSensorHandler_S__table_rbt_zbr_5t}

## ProbeHandlerSNMP - addStage(String paramMap) {#ariaid-title8}

Adds the stage to the parameter map.
{#r_PHS-addStage_S__table_ab4_31r_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 13. Parameters]

{#r_PHS-addStage_S__table_ab4_31r_5t} {#r_PHS-addStage_S__table_bb4_31r_5t__entry__2}

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

{#r_PHS-addStage_S__table_bb4_31r_5t}

## ProbeHandlerSNMP - addTimingSpecs(String paramMap) {#ariaid-title9}

Adds timing specifications to the parameter map.
{#r_PHS-addTimingSpecs_S__table_bjm_q1r_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| paramMap | String | The parameter map |
[Table 15. Parameters]

{#r_PHS-addTimingSpecs_S__table_bjm_q1r_5t} {#r_PHS-addTimingSpecs_S__table_cjm_q1r_5t__entry__2}

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

{#r_PHS-addTimingSpecs_S__table_cjm_q1r_5t}

## ProbeHandlerSNMP - getParameters() {#ariaid-title10}

Returns the parameters added by this probe handler.
{#r_PHS-getParameters__table_bb3_2zq_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 17. Parameters]

{#r_PHS-getParameters__table_bb3_2zq_5t} {#r_PHS-getParameters__table_cb3_2zq_5t__entry__2}

| Type | Description |
|-|-|
| String | A hash map of the parameters added by this probe handler. |
[Table 18. Returns]

{#r_PHS-getParameters__table_cb3_2zq_5t}

## ProbeHandlerSNMP - run() {#ariaid-title11}

Runs the probe.
{#r_PHS-run__table_lxk_xyq_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 19. Parameters]

{#r_PHS-run__table_lxk_xyq_5t} {#r_PHS-run__table_mxk_xyq_5t__entry__2}

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

{#r_PHS-run__table_mxk_xyq_5t}

## ProbeHandlerSNMP - setProbeParameters(String params) {#ariaid-title12}

Sets the value of a given XML parameter element.
{#r_PHS-setProbeParameters_S__table_iql_nzq_5t__entry__3}

| Name | Type | Description |
|-|-|-|
| params | String | The probe's parameters |
[Table 21. Parameters]

{#r_PHS-setProbeParameters_S__table_iql_nzq_5t} {#r_PHS-setProbeParameters_S__table_jql_nzq_5t__entry__2}

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

{#r_PHS-setProbeParameters_S__table_jql_nzq_5t}