Search documentation of snmpkit

# SnmpKit (snmpkit v1.2.0)

Unified API for SnmpKit - A comprehensive SNMP toolkit for Elixir.

This module provides a clean, organized interface to all SnmpKit functionality through context-based sub-modules:

- `SnmpKit.SNMP` - SNMP operations (get, walk, bulk, etc.)
- `SnmpKit.MIB` - MIB compilation, loading, and resolution
- `SnmpKit.Sim` - SNMP device simulation and testing

## Quick Examples

    # SNMP Operations
    {:ok, value} = SnmpKit.SNMP.get("192.168.1.1", "sysDescr.0")
    {:ok, results} = SnmpKit.SNMP.walk("192.168.1.1", "system")

    # MIB Operations
    {:ok, oid} = SnmpKit.MIB.resolve("sysDescr.0")
    {:ok, compiled} = SnmpKit.MIB.compile("MY-MIB.mib")

    # Simulation
    {:ok, device} = SnmpKit.Sim.start_device(profile, port: 1161)

For backward compatibility, many common operations are also available directly on the main SnmpKit module.

# Summary

## Functions

bulk_walk(target, root_oid)

See `SnmpKit.SnmpMgr.bulk_walk/2`.

bulk_walk(target, root_oid, opts)

See `SnmpKit.SnmpMgr.bulk_walk/3`.

get(target, oid)

See `SnmpKit.SnmpMgr.get/2`.

get(target, oid, opts)

See `SnmpKit.SnmpMgr.get/3`.

get_bulk(target, oid_or_oids)

See `SnmpKit.SnmpMgr.get_bulk/2`.

get_bulk(target, oid_or_oids, opts)

See `SnmpKit.SnmpMgr.get_bulk/3`.

get_bulk_multi(targets_and_oids)

See `SnmpKit.SnmpMgr.get_bulk_multi/1`.

get_bulk_multi(targets_and_oids, opts)

See `SnmpKit.SnmpMgr.get_bulk_multi/2`.

resolve(name)

See `SnmpKit.SnmpMgr.MIB.resolve/1`.

set(target, oid, value)

See `SnmpKit.SnmpMgr.set/3`.

set(target, oid, value, opts)

See `SnmpKit.SnmpMgr.set/4`.

walk(target, oid)

See `SnmpKit.SnmpMgr.walk/2`.

walk(target, oid, opts)

See `SnmpKit.SnmpMgr.walk/3`.

walk_multi(targets_and_oids)

See `SnmpKit.SnmpMgr.walk_multi/1`.

walk_multi(targets_and_oids, opts)

See `SnmpKit.SnmpMgr.walk_multi/2`.

walk_table(target, table_oid)

See `SnmpKit.SnmpMgr.walk_table/2`.

walk_table(target, table_oid, opts)

See `SnmpKit.SnmpMgr.walk_table/3`.

# Functions

# bulk_walk(target, root_oid)

See `SnmpKit.SnmpMgr.bulk_walk/2`.

# bulk_walk(target, root_oid, opts)

See `SnmpKit.SnmpMgr.bulk_walk/3`.

# get(target, oid)

See `SnmpKit.SnmpMgr.get/2`.

# get(target, oid, opts)

See `SnmpKit.SnmpMgr.get/3`.

# get_bulk(target, oid_or_oids)

See `SnmpKit.SnmpMgr.get_bulk/2`.

# get_bulk(target, oid_or_oids, opts)

See `SnmpKit.SnmpMgr.get_bulk/3`.

# get_bulk_multi(targets_and_oids)

See `SnmpKit.SnmpMgr.get_bulk_multi/1`.

# get_bulk_multi(targets_and_oids, opts)

See `SnmpKit.SnmpMgr.get_bulk_multi/2`.

# resolve(name)

See `SnmpKit.SnmpMgr.MIB.resolve/1`.

# set(target, oid, value)

See `SnmpKit.SnmpMgr.set/3`.

# set(target, oid, value, opts)

See `SnmpKit.SnmpMgr.set/4`.

# walk(target, oid)

See `SnmpKit.SnmpMgr.walk/2`.

# walk(target, oid, opts)

See `SnmpKit.SnmpMgr.walk/3`.

# walk_multi(targets_and_oids)

See `SnmpKit.SnmpMgr.walk_multi/1`.

# walk_multi(targets_and_oids, opts)

See `SnmpKit.SnmpMgr.walk_multi/2`.

# walk_table(target, table_oid)

See `SnmpKit.SnmpMgr.walk_table/2`.

# walk_table(target, table_oid, opts)

See `SnmpKit.SnmpMgr.walk_table/3`.