Scanning Engine v2 - Module - SNMP

Overview

Targeting

Configuration

Only the publicly-available configuration keys that can be set in a job's module invocations will be described below. Additional configuration keys may exist, but not be shown here because they are restricted to specific users or because they are permanently set as a static value. If no keys have (required) after their names then invocations of this module need not contain a config key.

Named Keys

connect-timeout

Timeout for each connection.

• Type: string
• Default: 5s

debug

Run module with a debugging configuration.

• Type: boolean

target-timeout

Timeout for scan of each target.

• Type: string
• Default: 60s

Schemas

The schema for the body object of all results generated with .task.module_name equal to snmp can be found here. The schema for results is available both in standalone and bundled form.

Examples

These are examples of the .body object for results with .task.module_name equal to snmp.

Live Host

This example was generated with a live host on the internet.

{
  "mibs": [
    {
      "version": "1",
      "community": "public",
      "objects": [
        {
          "oid": ".1.3.6.1.2.1.1.1.0",
          "type": "OctetString",
          "value": "DEFAULT"
        },
        {
          "oid": ".1.3.6.1.2.1.1.2.0",
          "type": "ObjectIdentifier",
          "value": ".1.3.6.1.4.1.56117"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.1",
          "type": "OctetString",
          "value": "wlan1-va2"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.2",
          "type": "OctetString",
          "value": "peth0"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.3",
          "type": "OctetString",
          "value": "wlan0-va1"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.4",
          "type": "OctetString",
          "value": "lo"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.5",
          "type": "OctetString",
          "value": "br0"
        },
        {
          "oid": ".1.3.6.1.2.1.1.4.0",
          "type": "OctetString",
          "value": "Router"
        },
        {
          "oid": ".1.3.6.1.2.1.1.5.0",
          "type": "OctetString",
          "value": "Maxio"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.6",
          "type": "OctetString",
          "value": "wlan0-vxd"
        },
        {
          "oid": ".1.3.6.1.2.1.1.6.0",
          "type": "OctetString",
          "value": "AP"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.7",
          "type": "OctetString",
          "value": "wlan1-va1"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.8",
          "type": "OctetString",
          "value": "wlan1"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.9",
          "type": "OctetString",
          "value": "wlan0-va0"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.10",
          "type": "OctetString",
          "value": "pwlan0"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.11",
          "type": "OctetString",
          "value": "wlan1-vxd"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.12",
          "type": "OctetString",
          "value": "eth1"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.13",
          "type": "OctetString",
          "value": "wlan1-va0"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.14",
          "type": "OctetString",
          "value": "wlan0"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.15",
          "type": "OctetString",
          "value": "eth0"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.16",
          "type": "OctetString",
          "value": "wlan0-va3"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.17",
          "type": "OctetString",
          "value": "wlan1-va3"
        },
        {
          "oid": ".1.3.6.1.2.1.2.2.1.2.18",
          "type": "OctetString",
          "value": "wlan0-va2"
        }
      ]
    }
  ]
}

Changelog

v1.0.0 (2025-07-08)

• Initial release of versioning for each module. All modules are being tagged with version number 1.0.0. Going forward:
• Major version should be changed when there are changes that impact consumers or clients of the modules.
• Minor version should be changed when there are additions which enrich or enhance the module but shouldn't affect consumers or clients.
• Patch version should be changed when there are bugfixes.