Search documentation of snmpkit

# SnmpKit.SNMP (snmpkit v1.2.0)

SNMP client operations for querying and managing SNMP devices.

This module provides all SNMP protocol operations including:

- Basic operations: get, set, get_next
- Bulk operations: get_bulk, walk, table operations
- Advanced features: streaming, async operations, multi-target
- Pretty formatting and analysis tools

# Summary

## Functions

adaptive_walk(target, root_oid)

See `SnmpKit.SnmpMgr.adaptive_walk/2`.

adaptive_walk(target, root_oid, opts)

See `SnmpKit.SnmpMgr.adaptive_walk/3`.

analyze_table(table_data)

See `SnmpKit.SnmpMgr.analyze_table/1`.

analyze_table(table_data, opts)

See `SnmpKit.SnmpMgr.analyze_table/2`.

benchmark_device(target, test_oid)

See `SnmpKit.SnmpMgr.benchmark_device/2`.

benchmark_device(target, test_oid, opts)

See `SnmpKit.SnmpMgr.benchmark_device/3`.

bulk_pretty(target, oid)

See `SnmpKit.SnmpMgr.bulk_pretty/2`.

bulk_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.bulk_pretty/3`.

bulk_walk(target, oid)

See `SnmpKit.SnmpMgr.bulk_walk/2`.

bulk_walk(target, oid, opts)

See `SnmpKit.SnmpMgr.bulk_walk/3`.

bulk_walk!(target, root_oid, opts \\ [])

Like bulk_walk/3 but raises on error.

bulk_walk_pretty(target, oid)

See `SnmpKit.SnmpMgr.bulk_walk_pretty/2`.

bulk_walk_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.bulk_walk_pretty/3`.

bulk_walk_stream(target, root_oid, opts \\ [])

Streaming variant of bulk_walk/3 that enforces bulk semantics (v2c) and lazily retrieves data in chunks.

engine_batch(requests)

See `SnmpKit.SnmpMgr.engine_batch/1`.

engine_batch(requests, opts)

See `SnmpKit.SnmpMgr.engine_batch/2`.

engine_request(request)

See `SnmpKit.SnmpMgr.engine_request/1`.

engine_request(request, opts)

See `SnmpKit.SnmpMgr.engine_request/2`.

get(target, oid)

See `SnmpKit.SnmpMgr.get/2`.

get(target, oid, opts)

See `SnmpKit.SnmpMgr.get/3`.

get_async(target, oid)

See `SnmpKit.SnmpMgr.get_async/2`.

get_async(target, oid, opts)

See `SnmpKit.SnmpMgr.get_async/3`.

get_bulk(target, oid)

See `SnmpKit.SnmpMgr.get_bulk/2`.

get_bulk(target, oid, opts)

See `SnmpKit.SnmpMgr.get_bulk/3`.

get_bulk!(target, oid, opts \\ [])

Like get_bulk/3 but raises on error.

get_bulk_async(target, oid)

See `SnmpKit.SnmpMgr.get_bulk_async/2`.

get_bulk_async(target, oid, opts)

See `SnmpKit.SnmpMgr.get_bulk_async/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`.

get_column(target, table_oid, column)

See `SnmpKit.SnmpMgr.get_column/3`.

get_column(target, table_oid, column, opts)

See `SnmpKit.SnmpMgr.get_column/4`.

get_engine_stats()

See `SnmpKit.SnmpMgr.get_engine_stats/0`.

get_engine_stats(opts)

See `SnmpKit.SnmpMgr.get_engine_stats/1`.

get_multi(targets_and_oids)

See `SnmpKit.SnmpMgr.get_multi/1`.

get_multi(targets_and_oids, opts)

See `SnmpKit.SnmpMgr.get_multi/2`.

get_next(target, oid)

See `SnmpKit.SnmpMgr.get_next/2`.

get_next(target, oid, opts)

See `SnmpKit.SnmpMgr.get_next/3`.

get_pretty(target, oid)

See `SnmpKit.SnmpMgr.get_pretty/2`.

get_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.get_pretty/3`.

get_table(target, table_oid)

See `SnmpKit.SnmpMgr.get_table/2`.

get_table(target, table_oid, opts)

See `SnmpKit.SnmpMgr.get_table/3`.

record_metric(metric_type, metric_name, value)

See `SnmpKit.SnmpMgr.record_metric/3`.

record_metric(metric_type, metric_name, value, tags)

See `SnmpKit.SnmpMgr.record_metric/4`.

set(target, oid, value)

See `SnmpKit.SnmpMgr.set/3`.

set(target, oid, value, opts)

See `SnmpKit.SnmpMgr.set/4`.

start_engine()

See `SnmpKit.SnmpMgr.start_engine/0`.

start_engine(opts)

See `SnmpKit.SnmpMgr.start_engine/1`.

table_bulk_stream(target, table_oid, opts \\ [])

Streaming variant of table walk that enforces bulk semantics (v2c).

table_stream(target, table_oid)

See `SnmpKit.SnmpMgr.table_stream/2`.

table_stream(target, table_oid, opts)

See `SnmpKit.SnmpMgr.table_stream/3`.

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_pretty(target, oid)

See `SnmpKit.SnmpMgr.walk_pretty/2`.

walk_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.walk_pretty/3`.

walk_stream(target, root_oid)

See `SnmpKit.SnmpMgr.walk_stream/2`.

walk_stream(target, root_oid, opts)

See `SnmpKit.SnmpMgr.walk_stream/3`.

walk_table(target, table_oid)

See `SnmpKit.SnmpMgr.walk_table/2`.

walk_table(target, table_oid, opts)

See `SnmpKit.SnmpMgr.walk_table/3`.

with_circuit_breaker(target, fun)

See `SnmpKit.SnmpMgr.with_circuit_breaker/2`.

with_circuit_breaker(target, fun, opts)

See `SnmpKit.SnmpMgr.with_circuit_breaker/3`.

# Functions

# adaptive_walk(target, root_oid)

See `SnmpKit.SnmpMgr.adaptive_walk/2`.

# adaptive_walk(target, root_oid, opts)

See `SnmpKit.SnmpMgr.adaptive_walk/3`.

# analyze_table(table_data)

See `SnmpKit.SnmpMgr.analyze_table/1`.

# analyze_table(table_data, opts)

See `SnmpKit.SnmpMgr.analyze_table/2`.

# benchmark_device(target, test_oid)

See `SnmpKit.SnmpMgr.benchmark_device/2`.

# benchmark_device(target, test_oid, opts)

See `SnmpKit.SnmpMgr.benchmark_device/3`.

# bulk_pretty(target, oid)

See `SnmpKit.SnmpMgr.bulk_pretty/2`.

# bulk_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.bulk_pretty/3`.

# bulk_walk(target, oid)

See `SnmpKit.SnmpMgr.bulk_walk/2`.

# bulk_walk(target, oid, opts)

See `SnmpKit.SnmpMgr.bulk_walk/3`.

# bulk_walk!(target, root_oid, opts \\ [])

    @spec bulk_walk!(term(), term(), keyword()) :: term()

Like bulk_walk/3 but raises on error.

# bulk_walk_pretty(target, oid)

See `SnmpKit.SnmpMgr.bulk_walk_pretty/2`.

# bulk_walk_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.bulk_walk_pretty/3`.

# bulk_walk_stream(target, root_oid, opts \\ [])

    @spec bulk_walk_stream(term(), term(), keyword()) :: Enumerable.t()

Streaming variant of bulk_walk/3 that enforces bulk semantics (v2c) and lazily retrieves data in chunks.

# engine_batch(requests)

See `SnmpKit.SnmpMgr.engine_batch/1`.

# engine_batch(requests, opts)

See `SnmpKit.SnmpMgr.engine_batch/2`.

# engine_request(request)

See `SnmpKit.SnmpMgr.engine_request/1`.

# engine_request(request, opts)

See `SnmpKit.SnmpMgr.engine_request/2`.

# get(target, oid)

See `SnmpKit.SnmpMgr.get/2`.

# get(target, oid, opts)

See `SnmpKit.SnmpMgr.get/3`.

# get_async(target, oid)

See `SnmpKit.SnmpMgr.get_async/2`.

# get_async(target, oid, opts)

See `SnmpKit.SnmpMgr.get_async/3`.

# get_bulk(target, oid)

See `SnmpKit.SnmpMgr.get_bulk/2`.

# get_bulk(target, oid, opts)

See `SnmpKit.SnmpMgr.get_bulk/3`.

# get_bulk!(target, oid, opts \\ [])

    @spec get_bulk!(term(), term(), keyword()) :: term()

Like get_bulk/3 but raises on error.

# get_bulk_async(target, oid)

See `SnmpKit.SnmpMgr.get_bulk_async/2`.

# get_bulk_async(target, oid, opts)

See `SnmpKit.SnmpMgr.get_bulk_async/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`.

# get_column(target, table_oid, column)

See `SnmpKit.SnmpMgr.get_column/3`.

# get_column(target, table_oid, column, opts)

See `SnmpKit.SnmpMgr.get_column/4`.

# get_engine_stats()

See `SnmpKit.SnmpMgr.get_engine_stats/0`.

# get_engine_stats(opts)

See `SnmpKit.SnmpMgr.get_engine_stats/1`.

# get_multi(targets_and_oids)

See `SnmpKit.SnmpMgr.get_multi/1`.

# get_multi(targets_and_oids, opts)

See `SnmpKit.SnmpMgr.get_multi/2`.

# get_next(target, oid)

See `SnmpKit.SnmpMgr.get_next/2`.

# get_next(target, oid, opts)

See `SnmpKit.SnmpMgr.get_next/3`.

# get_pretty(target, oid)

See `SnmpKit.SnmpMgr.get_pretty/2`.

# get_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.get_pretty/3`.

# get_table(target, table_oid)

See `SnmpKit.SnmpMgr.get_table/2`.

# get_table(target, table_oid, opts)

See `SnmpKit.SnmpMgr.get_table/3`.

# record_metric(metric_type, metric_name, value)

See `SnmpKit.SnmpMgr.record_metric/3`.

# record_metric(metric_type, metric_name, value, tags)

See `SnmpKit.SnmpMgr.record_metric/4`.

# set(target, oid, value)

See `SnmpKit.SnmpMgr.set/3`.

# set(target, oid, value, opts)

See `SnmpKit.SnmpMgr.set/4`.

# start_engine()

See `SnmpKit.SnmpMgr.start_engine/0`.

# start_engine(opts)

See `SnmpKit.SnmpMgr.start_engine/1`.

# table_bulk_stream(target, table_oid, opts \\ [])

    @spec table_bulk_stream(term(), term(), keyword()) :: Enumerable.t()

Streaming variant of table walk that enforces bulk semantics (v2c).

# table_stream(target, table_oid)

See `SnmpKit.SnmpMgr.table_stream/2`.

# table_stream(target, table_oid, opts)

See `SnmpKit.SnmpMgr.table_stream/3`.

# 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_pretty(target, oid)

See `SnmpKit.SnmpMgr.walk_pretty/2`.

# walk_pretty(target, oid, opts)

See `SnmpKit.SnmpMgr.walk_pretty/3`.

# walk_stream(target, root_oid)

See `SnmpKit.SnmpMgr.walk_stream/2`.

# walk_stream(target, root_oid, opts)

See `SnmpKit.SnmpMgr.walk_stream/3`.

# walk_table(target, table_oid)

See `SnmpKit.SnmpMgr.walk_table/2`.

# walk_table(target, table_oid, opts)

See `SnmpKit.SnmpMgr.walk_table/3`.

# with_circuit_breaker(target, fun)

See `SnmpKit.SnmpMgr.with_circuit_breaker/2`.

# with_circuit_breaker(target, fun, opts)

See `SnmpKit.SnmpMgr.with_circuit_breaker/3`.