GoSNMP

https://pkg.go.dev/github.com/gosnmp/gosnmp
Admin
GoSNMP is a comprehensive SNMP client library written in Go that provides Get, GetNext, GetBulk,...
Tokens:22,267
Snippets:100
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Logger usage example

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Example of initializing a logger for verbose output to stdout.

```go
gosnmp_logger = NewLogger(log.New(os.Stdout, "", 0))
```

--------------------------------

### Install GoSNMP Package

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Installs the GoSNMP library using the go get command. This is the standard way to add the package to your Go project.

```bash
go get github.com/gosnmp/gosnmp
```

--------------------------------

### Example Commands

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

This section lists various example commands demonstrating different functionalities of the GoSNMP library.

```APIDOC
## Example Commands

### List of Examples
- examples
- Hex-String command
- example command
- example2 command
- example3 command
- example4 command
- linux_vrf command
- tcp_trapserver command
- trapsend_v1 command
- trapsend_v2plus command
- trapsend_v3 command
- trapserver command
- trapserver_v3 command
- walkexample command: This program demonstrates BulkWalk.
- walktcpexample command: This program demonstrates BulkWalk.
```

--------------------------------

### Example Output

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Sample output from running the basic GoSNMP usage example, showing retrieved OID values and their types.

```text
% go run example.go
0: oid: 1.3.6.1.2.1.1.4.0 string: Administrator
1: oid: 1.3.6.1.2.1.1.7.0 number: 104

```

--------------------------------

### Perform SNMP Get Request

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Example command to retrieve SNMP data from a target host.

```bash
% snmpget -On -v2c -c public 203.50.251.17 1.3.6.1.2.1.1.7.0 \
  1.3.6.1.2.1.2.2.1.2.6 1.3.6.1.2.1.2.2.1.5.3
.1.3.6.1.2.1.1.7.0 = INTEGER: 78
.1.3.6.1.2.1.2.2.1.2.6 = STRING: GigabitEthernet0
.1.3.6.1.2.1.2.2.1.5.3 = Gauge32: 4294967295
```

--------------------------------

### Basic GoSNMP Usage Example

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Demonstrates connecting to an SNMP device using default settings, retrieving multiple OIDs, and processing the results. Handles different variable types and uses ToBigInt for numeric values.

```go
// Default is a pointer to a GoSNMP struct that contains sensible defaults
// eg port 161, community public, etc
g.Default.Target = "192.168.1.10"
err := g.Default.Connect()
if err != nil {
    log.Fatalf("Connect() err: %v", err)
}
deffer g.Default.Conn.Close()

oids := []string{"1.3.6.1.2.1.1.4.0", "1.3.6.1.2.1.1.7.0"}
result, err2 := g.Default.Get(oids) // Get() accepts up to g.MAX_OIDS
if err2 != nil {
    log.Fatalf("Get() err: %v", err2)
}

for i, variable := range result.Variables {
    fmt.Printf("%d: oid: %s ", i, variable.Name)

    // the Value of each variable returned by Get() implements
    // interface{}. You could do a type switch...
    switch variable.Type {
    case g.OctetString:
        bytes := variable.Value.([]byte)
        fmt.Printf("string: %s\n", string(bytes))
    default:
        // ... or often you're just interested in numeric values.
        // ToBigInt() will return the Value as a BigInt, for plugging
        // into your calculations.
        fmt.Printf("number: %d\n", g.ToBigInt(variable.Value))
    }
}
```

--------------------------------

### Generate Test Coverage Report

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Install coverage tools and generate an HTML report for test coverage analysis.

```bash
go get github.com/axw/gocov/gocov
go get github.com/matm/gocov-html
gocov test github.com/gosnmp/gosnmp | gocov-html > gosnmp.html && firefox gosnmp.html &
```

--------------------------------

### SNMP Walk Operations

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Methods for walking the MIB tree starting from a root OID.

```APIDOC
## GoSNMP Walk

### Description
Traverses the MIB tree starting from a specific root OID.

### Methods
- **Walk(rootOid string, walkFn WalkFunc)**: Walks the tree and executes a callback function for each result.
- **WalkAll(rootOid string)**: Walks the entire tree and returns all results as a slice of SnmpPDU.
- **BulkWalk(rootOid string, walkFn WalkFunc)**: Performs a bulk walk operation.
- **BulkWalkAll(rootOid string)**: Performs a bulk walk and returns all results.

### Parameters
#### Path Parameters
- **rootOid** (string) - Required - The starting OID for the walk operation.
```

--------------------------------

### SNMP Operation Mock Methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

Methods for mocking SNMP protocol operations like Get, GetBulk, GetNext, and Set.

```APIDOC
## Get
### Description
Indicates an expected call of the Get operation.
### Parameters
- **oids** (interface{}) - Required - The OIDs to retrieve.

## GetBulk
### Description
Indicates an expected call of the GetBulk operation.
### Parameters
- **oids** (interface{}) - Required - The OIDs to retrieve.
- **nonRepeaters** (interface{}) - Required - Number of non-repeating variables.
- **maxRepetitions** (interface{}) - Required - Max repetitions for repeating variables.

## GetNext
### Description
Indicates an expected call of the GetNext operation.
### Parameters
- **oids** (interface{}) - Required - The OIDs to retrieve.

## Set
### Description
Indicates an expected call of the Set operation.
### Parameters
- **pdus** (interface{}) - Required - The PDUs to set.
```

--------------------------------

### Build and Run Tests in Docker

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Commands to containerize the project and execute tests within the environment.

```bash
docker build -t gosnmp/gosnmp:latest .
docker run -it gosnmp/gosnmp:latest
```

--------------------------------

### GoSNMP BulkWalkAll Function

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Retrieves an entire subtree of SNMP values using GETBULK and returns them as a slice of SnmpPDU. Use with caution if AppOpts is set to 'c' as it may lead to infinite loops and memory issues; BulkWalk is recommended in such cases.

```go
func (x *GoSNMP) BulkWalkAll(rootOid string) (results []SnmpPDU, err error)
```

--------------------------------

### SNMP Operations

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Functions for performing standard SNMP operations like GET, GETNEXT, GETBULK, SET, and TRAP.

```APIDOC
## Get

### Description
Get sends an SNMP GET request.

### Method
POST

### Endpoint
/get

### Parameters
#### Request Body
- **oids** (array of strings) - Required - A list of Object Identifiers (OIDs) to retrieve.

### Request Example
```json
{
  "oids": ["1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1.5.0"]
}
```

### Response
#### Success Response (200)
- **result** (*SnmpPacket) - The SNMP response packet containing the requested values.
- **err** (error) - An error object if the operation failed.

#### Response Example
```json
{
  "result": {
    "version": "2",
    "community": "public",
    "request_id": 12345,
    "error": null,
    "error_status": 0,
    "error_index": 0,
    "varbinds": [
      {
        "oid": "1.3.6.1.2.1.1.1.0",
        "type": 4,
        "value": "Linux hostname 123"
      },
      {
        "oid": "1.3.6.1.2.1.1.5.0",
        "type": 4,
        "value": "myhost"
      }
    ]
  },
  "err": null
}
```
```

```APIDOC
## GetNext

### Description
GetNext sends an SNMP GETNEXT request.

### Method
POST

### Endpoint
/getnext

### Parameters
#### Request Body
- **oids** (array of strings) - Required - A list of Object Identifiers (OIDs) for which to find the next lexicographical OID.

### Request Example
```json
{
  "oids": ["1.3.6.1.2.1.1.1.0"]
}
```

### Response
#### Success Response (200)
- **result** (*SnmpPacket) - The SNMP response packet containing the next OID and its value.
- **err** (error) - An error object if the operation failed.

#### Response Example
```json
{
  "result": {
    "version": "2",
    "community": "public",
    "request_id": 12346,
    "error": null,
    "error_status": 0,
    "error_index": 0,
    "varbinds": [
      {
        "oid": "1.3.6.1.2.1.1.2.0",
        "type": 6,
        "value": "1.3.6.1.4.1.77.1.1.1.0"
      }
    ]
  },
  "err": null
}
```
```

```APIDOC
## GetBulk

### Description
GetBulk sends an SNMP GETBULK request. For maxRepetitions greater than 255, use BulkWalk() or BulkWalkAll().

### Method
POST

### Endpoint
/getbulk

### Parameters
#### Request Body
- **oids** (array of strings) - Required - A list of Object Identifiers (OIDs) to retrieve.
- **nonRepeaters** (uint8) - Required - The number of OIDs that are not repeated.
- **maxRepetitions** (uint32) - Required - The maximum number of repetitions for each repeating OID.

### Request Example
```json
{
  "oids": ["1.3.6.1.2.1.1.5.0"],
  "nonRepeaters": 0,
  "maxRepetitions": 10
}
```

### Response
#### Success Response (200)
- **result** (*SnmpPacket) - The SNMP response packet containing the bulk data.
- **err** (error) - An error object if the operation failed.

#### Response Example
```json
{
  "result": {
    "version": "2",
    "community": "public",
    "request_id": 12347,
    "error": null,
    "error_status": 0,
    "error_index": 0,
    "varbinds": [
      {
        "oid": "1.3.6.1.2.1.1.5.0",
        "type": 4,
        "value": "myhost"
      },
      {
        "oid": "1.3.6.1.2.1.1.6.0",
        "type": 4,
        "value": "UTC"
      }
    ]
  },
  "err": null
}
```
```

```APIDOC
## Set

### Description
Set sends an SNMP SET request.

### Method
PUT

### Endpoint
/set

### Parameters
#### Request Body
- **pdus** (array of SnmpPDU) - Required - A list of PDU (Protocol Data Unit) objects containing the OIDs and their new values.

### Request Example
```json
{
  "pdus": [
    {
      "oid": "1.3.6.1.2.1.1.5.0",
      "type": 4,
      "value": "newhostname"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (*SnmpPacket) - The SNMP response packet confirming the set operation.
- **err** (error) - An error object if the operation failed.

#### Response Example
```json
{
  "result": {
    "version": "2",
    "community": "public",
    "request_id": 12348,
    "error": null,
    "error_status": 0,
    "error_index": 0,
    "varbinds": [
      {
        "oid": "1.3.6.1.2.1.1.5.0",
        "type": 4,
        "value": "newhostname"
      }
    ]
  },
  "err": null
}
```
```

```APIDOC
## SendTrap

### Description
SendTrap sends a SNMP Trap. It does not wait for a return packet from the NMS (Network Management Station). The trap code is currently unreliable when working with snmpv3.

### Method
POST

### Endpoint
/trap

### Parameters
#### Request Body
- **trap** (SnmpTrap) - Required - The SNMP Trap object to send.

### Request Example
```json
{
  "trap": {
    "version": "2",
    "community": "public",
    "enterprise": "1.3.6.1.4.1.12345",
    "agent_addr": "192.168.1.1",
    "generic": 6,
    "specific": 1,
    "time_ticks": 123456,
    "varbinds": [
      {
        "oid": "1.3.6.1.2.1.1.1.0",
        "type": 4,
        "value": "Trap message"
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **result** (*SnmpPacket) - The SNMP response packet (often empty for traps).
- **err** (error) - An error object if the operation failed.

#### Response Example
```json
{
  "result": null,
  "err": null
}
```
```

--------------------------------

### SNMP Operations

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Core methods for performing SNMP operations like Get, GetNext, GetBulk, and Set on a target device.

```APIDOC
## GoSNMP Operations

### Description
Methods for retrieving and modifying data on SNMP-enabled devices.

### Methods
- **Get(oids []string)**: Retrieves values for the specified OIDs.
- **GetNext(oids []string)**: Retrieves the next OIDs in the MIB tree.
- **GetBulk(oids []string, nonRepeaters uint8, maxRepetitions uint32)**: Performs a bulk retrieval of OIDs.
- **Set(pdus []SnmpPDU)**: Sets values for the specified PDUs.

### Parameters
#### Request Body
- **oids** ([]string) - Required - List of OID strings to query.
- **pdus** ([]SnmpPDU) - Required - List of PDU objects to set.
- **nonRepeaters** (uint8) - Required - Number of non-repeating variables in GetBulk.
- **maxRepetitions** (uint32) - Required - Maximum number of repetitions in GetBulk.
```

--------------------------------

### MockHandlerMockRecorder Methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

This section details the methods available on the MockHandlerMockRecorder for setting up expected calls.

```APIDOC
## MockHandlerMockRecorder Methods

### BulkWalk

Indicates an expected call of BulkWalk.

### Method
POST

### Endpoint
/mockhandler/recorder/bulkwalk

### Request Body
- **rootOid** (interface{}) - The root OID.
- **walkFn** (interface{}) - The walk function.

### BulkWalkAll

Indicates an expected call of BulkWalkAll.

### Method
POST

### Endpoint
/mockhandler/recorder/bulkwalkall

### Request Body
- **rootOid** (interface{}) - The root OID.

### Check

Indicates an expected call of Check.

### Method
POST

### Endpoint
/mockhandler/recorder/check

### Request Body
- **err** (interface{}) - The error to check.

### Close

Indicates an expected call of Close.

### Method
POST

### Endpoint
/mockhandler/recorder/close

### Community

Indicates an expected call of Community.

### Method
POST

### Endpoint
/mockhandler/recorder/community

### Connect

Indicates an expected call of Connect.

### Method
POST

### Endpoint
/mockhandler/recorder/connect

```

--------------------------------

### Create a new Handler

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Initializes a new Handler using gosnmp.

```go
func NewHandler() Handler
```

--------------------------------

### Run Local Tests with Environment Variables

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Configure target host details via environment variables before running Go tests.

```bash
export GOSNMP_TARGET=1.2.3.4
export GOSNMP_PORT=161
export GOSNMP_TARGET_IPV4=1.2.3.4
export GOSNMP_PORT_IPV4=161
export GOSNMP_TARGET_IPV6='0:0:0:0:0:ffff:102:304'
export GOSNMP_PORT_IPV6=161
go test -v -tags all        # for example
go test -v -tags helper     # for example
```

--------------------------------

### Create a new Logger

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Creates a new Logger instance using a provided LoggerInterface.

```go
func NewLogger(logger LoggerInterface) Logger
```

--------------------------------

### Logger Print methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Methods for logging messages.

```go
func (l *Logger) Print(v ...any)
```

```go
func (l *Logger) Printf(format string, v ...any)
```

--------------------------------

### Configure Custom GoSNMP Logger

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Sets up a custom GoSNMP client with logging enabled. Pass a pointer to your logger implementation to the Logger field.

```go
g := &gosnmp.GoSNMP{
    ...
    Logger:    gosnmp.NewLogger(log.New(os.Stdout, "", 0)),
}
```

--------------------------------

### PDUType String method

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Returns the string representation of a PDUType.

```go
func (i PDUType) String() string
```

--------------------------------

### Benchmark Password Hash Caching

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Run benchmarks with specific build tags to toggle password hash caching behavior.

```bash
go build -tags gosnmp_nopwdcache -bench=Benchmark.*Hash
```

--------------------------------

### Profile CPU Usage

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Commands to generate and analyze CPU profiles for the test suite.

```bash
go test -cpuprofile cpu.out
go test -c
go tool pprof gosnmp.test cpu.out
```

--------------------------------

### Configure Default Connection Settings

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

The default GoSNMP struct configuration used for new connections.

```go
var Default = &GoSNMP{
	Port:               161,
	Transport:          udp,
	Community:          "public",
	Version:            Version2c,
	Timeout:            time.Duration(2) * time.Second,
	Retries:            3,
	ExponentialTimeout: true,
	MaxOids:            MaxOids,
}
```

--------------------------------

### Configure Default Logger

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Enables logging for the default GoSNMP client by creating a logger using the standard Go log package and assigning it to gosnmp.Default.Logger.

```go
gosnmp.Default.Logger = gosnmp.NewLogger(log.New(os.Stdout, "", 0))
```

--------------------------------

### MockHandler Methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

Documentation for the various methods available on the MockHandler, primarily used for mocking and testing SNMP operations.

```APIDOC
## Method: BulkWalk

### Description
Mocks the BulkWalk method of the Handler interface.

### Parameters
- **rootOid** (string) - Required - The root OID for the walk.
- **walkFn** (gosnmp.WalkFunc) - Required - The function to call for each PDU.

### Returns
- **error** - An error if the operation fails.

## Method: BulkWalkAll

### Description
Mocks the BulkWalkAll method of the Handler interface.

### Parameters
- **rootOid** (string) - Required - The root OID for the walk.

### Returns
- **([]gosnmp.SnmpPDU, error)** - A slice of SnmpPDU and an error if the operation fails.

## Method: Check

### Description
Mocks the Check method of the Handler interface.

### Parameters
- **err** (error) - Required - The error to check.

## Method: Close

### Description
Mocks the Close method of the Handler interface.

### Returns
- **error** - An error if the operation fails.

## Method: Community

### Description
Mocks the Community method of the Handler interface.

### Returns
- **string** - The SNMP community string.

## Method: Connect

### Description
Mocks the Connect method of the Handler interface.

### Returns
- **error** - An error if the connection fails.

## Method: ConnectIPv4

### Description
Mocks the ConnectIPv4 method of the Handler interface.

### Returns
- **error** - An error if the IPv4 connection fails.

## Method: ConnectIPv6

### Description
Mocks the ConnectIPv6 method of the Handler interface.

### Returns
- **error** - An error if the IPv6 connection fails.

## Method: ContextEngineID

### Description
Mocks the ContextEngineID method of the Handler interface.

### Returns
- **string** - The context engine ID.

## Method: ContextName

### Description
Mocks the ContextName method of the Handler interface.

### Returns
- **string** - The context name.

## Method: EXPECT

### Description
Returns an object that allows the caller to indicate expected use of the mock.

### Returns
- **(*MockHandlerMockRecorder)** - The mock recorder object.

## Method: Get

### Description
Mocks the Get method of the Handler interface.

### Parameters
- **oids** ([]string) - Required - A slice of OIDs to retrieve.

### Returns
- **(*gosnmp.SnmpPacket, error)** - The SNMP packet and an error if the operation fails.

## Method: GetBulk

### Description
Mocks the GetBulk method of the Handler interface.

### Parameters
- **oids** ([]string) - Required - A slice of OIDs to retrieve.
- **nonRepeaters** (uint8) - Required - The number of non-repeaters.
- **maxRepetitions** (uint32) - Required - The maximum number of repetitions.

### Returns
- **(*gosnmp.SnmpPacket, error)** - The SNMP packet and an error if the operation fails.

## Method: GetExponentialTimeout

### Description
Mocks the GetExponentialTimeout method of the Handler interface.

### Returns
- **bool** - True if exponential timeout is enabled, false otherwise.

## Method: GetNext

### Description
Mocks the GetNext method of the Handler interface.

### Parameters
- **oids** ([]string) - Required - A slice of OIDs to retrieve.

### Returns
- **(*gosnmp.SnmpPacket, error)** - The SNMP packet and an error if the operation fails.

## Method: Logger

### Description
Mocks the Logger method of the Handler interface.

### Returns
- **gosnmp.Logger** - The logger instance.

## Method: MaxOids

### Description
Mocks the MaxOids method of the Handler interface.

### Returns
- **int** - The maximum number of OIDs allowed.

## Method: MaxRepetitions

### Description
Mocks the MaxRepetitions method of the Handler interface.

### Returns
- **uint32** - The maximum number of repetitions.

## Method: MsgFlags

### Description
Mocks the MsgFlags method of the Handler interface.

### Returns
- **gosnmp.SnmpV3MsgFlags** - The SNMPv3 message flags.

## Method: Port

### Description
Mocks the Port method of the Handler interface.

### Returns
- **uint16** - The SNMP port number.

## Method: Retries

### Description
Mocks the Retries method of the Handler interface.

### Returns
- **int** - The number of retries.

## Method: SecurityModel

### Description
Mocks the SecurityModel method of the Handler interface.

### Returns
- **gosnmp.SecurityModel** - The security model.

## Method: SecurityParameters

### Description
Mocks the SecurityParameters method of the Handler interface.

### Returns
- **interface{}** - The security parameters.

## Method: SetContextEngineID

### Description
Mocks the SetContextEngineID method of the Handler interface.

### Parameters
- **contextEngineID** (interface{}) - Required - The context engine ID to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetContextName

### Description
Mocks the SetContextName method of the Handler interface.

### Parameters
- **contextName** (interface{}) - Required - The context name to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetExponentialTimeout

### Description
Mocks the SetExponentialTimeout method of the Handler interface.

### Parameters
- **value** (interface{}) - Required - The value to set for exponential timeout.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetLogger

### Description
Mocks the SetLogger method of the Handler interface.

### Parameters
- **logger** (interface{}) - Required - The logger to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetMaxOids

### Description
Mocks the SetMaxOids method of the Handler interface.

### Parameters
- **maxOids** (interface{}) - Required - The maximum number of OIDs to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetMaxRepetitions

### Description
Mocks the SetMaxRepetitions method of the Handler interface.

### Parameters
- **maxRepetitions** (interface{}) - Required - The maximum repetitions to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetMsgFlags

### Description
Mocks the SetMsgFlags method of the Handler interface.

### Parameters
- **msgFlags** (interface{}) - Required - The message flags to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetPort

### Description
Mocks the SetPort method of the Handler interface.

### Parameters
- **port** (interface{}) - Required - The port number to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetRetries

### Description
Mocks the SetRetries method of the Handler interface.

### Parameters
- **retries** (interface{}) - Required - The number of retries to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetSecurityModel

### Description
Mocks the SetSecurityModel method of the Handler interface.

### Parameters
- **securityModel** (interface{}) - Required - The security model to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetSecurityParameters

### Description
Mocks the SetSecurityParameters method of the Handler interface.

### Parameters
- **securityParameters** (interface{}) - Required - The security parameters to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetTarget

### Description
Mocks the SetTarget method of the Handler interface.

### Parameters
- **target** (interface{}) - Required - The target to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetTimeout

### Description
Mocks the SetTimeout method of the Handler interface.

### Parameters
- **timeout** (interface{}) - Required - The timeout value to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: SetVersion

### Description
Mocks the SetVersion method of the Handler interface.

### Parameters
- **version** (interface{}) - Required - The SNMP version to set.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: Target

### Description
Mocks the Target method of the Handler interface.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: Timeout

### Description
Mocks the Timeout method of the Handler interface.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: UnmarshalTrap

### Description
Mocks the UnmarshalTrap method of the Handler interface.

### Parameters
- **trap** (interface{}) - Required - The trap data to unmarshal.
- **useResponseSecurityParameters** (interface{}) - Required - Whether to use response security parameters.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: Version

### Description
Mocks the Version method of the Handler interface.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: Walk

### Description
Mocks the Walk method of the Handler interface.

### Parameters
- **rootOid** (interface{}) - Required - The root OID for the walk.
- **walkFn** (interface{}) - Required - The function to call for each PDU.

### Returns
- ***gomock.Call** - The gomock call object.

## Method: WalkAll

### Description
Mocks the WalkAll method of the Handler interface.

### Parameters
- **rootOid** (interface{}) - Required - The root OID for the walk.

### Returns
- ***gomock.Call** - The gomock call object.
```

--------------------------------

### SNMP Configuration Mock Methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

Methods for mocking the configuration and retrieval of SNMP session parameters.

```APIDOC
## SetCommunity
### Description
Indicates an expected call of SetCommunity.
### Parameters
- **community** (interface{}) - Required - The community string to set.

## SetLogger
### Description
Indicates an expected call of SetLogger.
### Parameters
- **logger** (interface{}) - Required - The logger instance to set.

## SetMaxOids
### Description
Indicates an expected call of SetMaxOids.
### Parameters
- **maxOids** (interface{}) - Required - The maximum number of OIDs to set.
```

--------------------------------

### BulkWalkAll

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Retrieves all values in a subtree using GETBULK and returns them as a slice.

```APIDOC
## BulkWalkAll

### Description
The `BulkWalkAll` method is similar to `BulkWalk` but instead of using a callback function, it collects all discovered SNMP values within a subtree into a slice of `SnmpPDU` and returns it. Use with caution if `x.AppOpts` is set to 'c', as it may lead to infinite loops and memory issues; `BulkWalk` is recommended in such cases.

### Method
`func (x *GoSNMP) BulkWalkAll(rootOid string) (results []SnmpPDU, err error)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```go
// Example usage of BulkWalkAll
results, err := gosnmp.BulkWalkAll("1.3.6.1.2.1.1")
if err != nil {
    log.Fatalf("BulkWalkAll failed: %v", err)
}

for _, pdu := range results {
    fmt.Printf("OID: %s, Value: %v\n", pdu.Name, pdu.Value)
}
```

### Response
#### Success Response (200)
- **results** ([]SnmpPDU) - A slice containing all retrieved SNMP PDUs.
- **err** (error) - `nil` if the operation was successful.

#### Response Example
```json
{
  "results": [
    {
      "Name": "1.3.6.1.2.1.1.1.0",
      "Type": 4,
      "Value": "Linux myhost 5.4.0-100-generic #112-Ubuntu SMP Thu Feb 3 18:43:39 UTC 2022 x86_64"
    },
    {
      "Name": "1.3.6.1.2.1.1.2.0",
      "Type": 6,
      "Value": "1.3.6.1.4.1.8072.3.2.10"
    }
    // ... more PDUs
  ],
  "err": null
}
```

#### Error Response
Returns an `error` if the SNMP operation fails.
```

--------------------------------

### Configure Password Caching

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Enables or disables password caching for performance optimization.

```go
func PasswordCaching(enable bool)
```

--------------------------------

### MockHandlerRecorder Methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

These methods allow you to set expectations for various configurations and operations on a mocked GoSNMP handler. They are typically used in conjunction with Go's testing framework and mocking libraries like `gomock`.

```APIDOC
## MockHandlerRecorder Methods

### Description
This section documents the methods available on the `MockHandlerMockRecorder` type, used for setting expectations on mocked `Handler` interface methods.

### Methods

#### SetPort

- **Description**: Indicates an expected call to `SetPort`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `port` (interface{})

#### SetRetries

- **Description**: Indicates an expected call to `SetRetries`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `retries` (interface{})

#### SetSecurityModel

- **Description**: Indicates an expected call to `SetSecurityModel`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `securityModel` (interface{})

#### SetSecurityParameters

- **Description**: Indicates an expected call to `SetSecurityParameters`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `securityParameters` (interface{})

#### SetTarget

- **Description**: Indicates an expected call to `SetTarget`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `target` (interface{})

#### SetTimeout

- **Description**: Indicates an expected call to `SetTimeout`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `timeout` (interface{})

#### SetVersion

- **Description**: Indicates an expected call to `SetVersion`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `version` (interface{})

#### Target

- **Description**: Indicates an expected call to `Target`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.

#### Timeout

- **Description**: Indicates an expected call to `Timeout`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.

#### UnmarshalTrap

- **Description**: Indicates an expected call to `UnmarshalTrap`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `trap` (interface{}), `useResponseSecurityParameters` (interface{})

#### Version

- **Description**: Indicates an expected call to `Version`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.

#### Walk

- **Description**: Indicates an expected call to `Walk`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `rootOid` (interface{}), `walkFn` (interface{})

#### WalkAll

- **Description**: Indicates an expected call to `WalkAll`.
- **Method**: Not applicable (mocking method).
- **Endpoint**: Not applicable.
- **Parameters**: `rootOid` (interface{})

```

--------------------------------

### Define AsnExtensionTag Constant in GoSNMP

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Combines ASN.1 context and extension ID to form the extension tag.

```go
const AsnExtensionTag = (AsnContext | AsnExtensionID) // 0x9F
```

--------------------------------

### BulkWalk

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Retrieves a subtree of values using GETBULK with a callback function for each value.

```APIDOC
## BulkWalk

### Description
The `BulkWalk` method retrieves a subtree of SNMP values starting from a specified root OID using the GETBULK operation. For each value discovered during the walk, a provided `walkFn` callback function is executed. The method returns an error immediately if there's an underlying SNMP error or if the `walkFn` returns an error.

### Method
`func (x *GoSNMP) BulkWalk(rootOid string, walkFn WalkFunc) error`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```go
// Example usage of BulkWalk
err := gosnmp.BulkWalk("1.3.6.1.2.1.1", func(pdu gosnmp.SnmpPDU) error {
    // Process each PDU
    fmt.Printf("OID: %s, Value: %v\n", pdu.Name, pdu.Value)
    return nil // Return an error to stop the walk
})
if err != nil {
    log.Fatalf("BulkWalk failed: %v", err)
}
```

### Response
#### Success Response
Returns `nil` on successful completion of the walk.

#### Error Response
Returns an `error` if the SNMP operation fails or if the `walkFn` returns an error.

#### Response Example
None (operation is in-place via callback)
```

--------------------------------

### Stringify Asn1BER

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Returns the string representation of an Asn1BER type.

```go
func (i Asn1BER) String() string
```

--------------------------------

### MockHandler Methods

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

This section details the various methods available on the MockHandler for mocking SNMP functionalities.

```APIDOC
## MockHandler Methods

### SecurityModel

Retrieves the SNMPv3 security model.

### Method
GET

### Endpoint
/mockhandler/securitymodel

### SecurityParameters

Retrieves the SNMPv3 security parameters.

### Method
GET

### Endpoint
/mockhandler/securityparameters

### SendTrap

Mocks the sending of an SNMP trap.

### Method
POST

### Endpoint
/mockhandler/sendtrap

### Request Body
- **trap** (gosnmp.SnmpTrap) - The trap to send.

### Response
#### Success Response (200)
- **packet** (gosnmp.SnmpPacket) - The SNMP packet response.
- **error** (error) - An error if the trap sending failed.

### Set

Mocks the setting of SNMP PDUs.

### Method
POST

### Endpoint
/mockhandler/set

### Request Body
- **pdus** ([]gosnmp.SnmpPDU) - The list of PDUs to set.

### Response
#### Success Response (200)
- **packet** (gosnmp.SnmpPacket) - The SNMP packet response.
- **error** (error) - An error if the set operation failed.

### SetCommunity

Mocks setting the SNMP community string.

### Method
POST

### Endpoint
/mockhandler/setcommunity

### Request Body
- **community** (string) - The community string to set.

### SetContextEngineID

Mocks setting the SNMPv3 context engine ID.

### Method
POST

### Endpoint
/mockhandler/setcontextengineid

### Request Body
- **contextEngineID** (string) - The context engine ID to set.

### SetContextName

Mocks setting the SNMPv3 context name.

### Method
POST

### Endpoint
/mockhandler/setcontextname

### Request Body
- **contextName** (string) - The context name to set.

### SetExponentialTimeout

Mocks setting the exponential timeout behavior.

### Method
POST

### Endpoint
/mockhandler/setexponentialtimeout

### Request Body
- **value** (bool) - Whether to enable exponential timeout.

### SetLogger

Mocks setting the logger for SNMP operations.

### Method
POST

### Endpoint
/mockhandler/setlogger

### Request Body
- **logger** (gosnmp.Logger) - The logger to set.

### SetMaxOids

Mocks setting the maximum number of OIDs for a request.

### Method
POST

### Endpoint
/mockhandler/setmaxoids

### Request Body
- **maxOids** (int) - The maximum number of OIDs.

### SetMaxRepetitions

Mocks setting the maximum repetitions for SNMP requests.

### Method
POST

### Endpoint
/mockhandler/setmaxrepetitions

### Request Body
- **maxRepetitions** (uint32) - The maximum repetitions.

### SetMsgFlags

Mocks setting the SNMPv3 message flags.

### Method
POST

### Endpoint
/mockhandler/setmsgflags

### Request Body
- **msgFlags** (gosnmp.SnmpV3MsgFlags) - The message flags to set.

### SetPort

Mocks setting the SNMP agent port.

### Method
POST

### Endpoint
/mockhandler/setport

### Request Body
- **port** (uint16) - The port number.

### SetRetries

Mocks setting the number of retries for SNMP requests.

### Method
POST

### Endpoint
/mockhandler/setretries

### Request Body
- **retries** (int) - The number of retries.

### SetSecurityModel

Mocks setting the SNMPv3 security model.

### Method
POST

### Endpoint
/mockhandler/setsecuritymodel

### Request Body
- **securityModel** (gosnmp.SnmpV3SecurityModel) - The security model to set.

### SetSecurityParameters

Mocks setting the SNMPv3 security parameters.

### Method
POST

### Endpoint
/mockhandler/setsecurityparameters

### Request Body
- **securityParameters** (gosnmp.SnmpV3SecurityParameters) - The security parameters to set.

### SetTarget

Mocks setting the SNMP target host.

### Method
POST

### Endpoint
/mockhandler/settarget

### Request Body
- **target** (string) - The target host address.

### SetTimeout

Mocks setting the timeout for SNMP requests.

### Method
POST

### Endpoint
/mockhandler/settimeout

### Request Body
- **timeout** (time.Duration) - The timeout duration.

### SetVersion

Mocks setting the SNMP version.

### Method
POST

### Endpoint
/mockhandler/setversion

### Request Body
- **version** (gosnmp.SnmpVersion) - The SNMP version to set.

### Target

Retrieves the SNMP target host.

### Method
GET

### Endpoint
/mockhandler/target

### Timeout

Retrieves the timeout duration for SNMP requests.

### Method
GET

### Endpoint
/mockhandler/timeout

### UnmarshalTrap

Mocks unmarshalling an SNMP trap.

### Method
POST

### Endpoint
/mockhandler/unmarshaltrap

### Request Body
- **trap** ([]byte) - The trap data to unmarshal.
- **useResponseSecurityParameters** (bool) - Whether to use response security parameters.

### Response
#### Success Response (200)
- **packet** (gosnmp.SnmpPacket) - The unmarshalled SNMP packet.
- **error** (error) - An error if unmarshalling failed.

### Version

Retrieves the SNMP version.

### Method
GET

### Endpoint
/mockhandler/version

### Walk

Mocks performing an SNMP walk operation.

### Method
POST

### Endpoint
/mockhandler/walk

### Request Body
- **rootOid** (string) - The root OID to start walking from.
- **walkFn** (gosnmp.WalkFunc) - The function to call for each OID.

### Response
#### Success Response (200)
- **error** (error) - An error if the walk operation failed.

### WalkAll

Mocks performing an SNMP walk operation to retrieve all OIDs.

### Method
POST

### Endpoint
/mockhandler/walkall

### Request Body
- **rootOid** (string) - The root OID to start walking from.

### Response
#### Success Response (200)
- **pdus** ([]gosnmp.SnmpPDU) - A list of SNMP PDUs.
- **error** (error) - An error if the walk operation failed.

```

--------------------------------

### Define LoggerInterface

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Interface for custom logging implementations.

```go
type LoggerInterface interface {
	Print(v ...any)
	Printf(format string, v ...any)
}
```

--------------------------------

### Configuration and Types

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp

Default connection settings and ASN.1 BER type definitions used in SNMP packets.

```APIDOC
## Default Configuration

### Description
The default GoSNMP configuration object.

### Fields
- **Port** (int) - Default: 161
- **Transport** (string) - Default: udp
- **Community** (string) - Default: public
- **Version** (int) - Default: Version2c
- **Timeout** (time.Duration) - Default: 2 seconds
- **Retries** (int) - Default: 3

---

## type Asn1BER

### Description
Represents the type of the SNMP PDU based on RFC 1442.

### Constants
- **Integer** (0x02)
- **OctetString** (0x04)
- **ObjectIdentifier** (0x06)
- **Counter32** (0x41)
- **Gauge32** (0x42)
- **Counter64** (0x46)
```

--------------------------------

### MockHandler Type and Constructor

Source: https://pkg.go.dev/github.com/gosnmp/gosnmp/mocks

Details the MockHandler struct, its purpose as a mock implementation, and the constructor function to create new instances.

```APIDOC
## Type: MockHandler

### Description
MockHandler is a mock of the Handler interface, used for testing purposes.

### Fields
```go
type MockHandler struct {
	// contains filtered or unexported fields
}
```

## Function: NewMockHandler

### Description
Creates a new mock instance of MockHandler.

### Parameters
- **ctrl** (*gomock.Controller) - Required - The gomock controller to manage mock behavior.

### Returns
- **(*MockHandler)** - A pointer to the newly created MockHandler instance.
```
Tokens:
Raw