germandrummer92 / snmpman

The SNMPMAN is a command-line application that simulates SNMP-capable devices. It may used e.g. to test traffic monitoring applications that execute SNMP queries. Due to to the lack in flexibility of already existing alternatives, it was developed by the 1&1 Internet AG to avoid those deficits. Therefore the SNMPMAN is highly extensible and will feature and will be enhanced in time.

Current build status:

SNMPMAN

The SNMPMAN is mainly a command-line application that simulates SNMP-capable devices and can also be started and stopped within Unit-Tests. It may used e.g. to test traffic monitoring applications that execute SNMP queries. Due to to the lack in flexibility of already existing alternatives, it was developed by the 1&1 Internet AG to avoid those deficits. Therefore the SNMPMAN is highly extensible and will feature and will be enhanced in time.

Multiple SNMP agents may be started at once and will run in parallel on different parts. These agents will return the data defined in a textual walk file. This file may be created by querying a real device. In addition, several device types may be defined and mapped by the agents. This device type configuration may contain policies on how to dynamically change the query responses. E.g. the response of an ifInOctets may be incremented with each query to simulate traffic. Several variable modifiers are already existing for different data types.

Also checkout the SNMPMAN GitHub IO page here!

Usage

You can include the SNMPMAN as a Maven dependency from Maven Central.

<dependency>
    <groupId>com.oneandone</groupId>
    <artifactId>snmpman</artifactId>
    <version>1.2.56</version>
</dependency>

In order to start and stop the simulation use this code snippet as an example:

/* 
 * creates a new instance of the SNMPMAN by the specified configuration file 
 * and executes all agents 
 */
Snmpman snmpman = Snmpman.start(new File("configuration.yaml"));
/* ... do something with the agents */

/* stop the SNMPMAN and all started agents */
snmpman.stop();

Installation

Prerequisites

• Java JDK 1.8
• Gradle 2.2

Packaging

In order to package the SNMPMAN - as either a .deb or .rpm - you have to execute following gradle tasks

• buildDeb - We strongly advise not to use the debian package, due to bugs
• buildRpm

You will find the generated output in ./build/distributions and can install the build packages.

Execution

To execute an instance of the SNMPMAN you have to start the execution script and specify a value for the -c or --configuration option that lists the path to the configuration YAML file that should be loaded in the execution context.

Configuration

The SNMPMAN is configured in two main YAML files ...

• The agent configuration list all agents which should be started
• The device type configuration defines the modifiers that should be applied to a range of OIDs

You can find some YAML example configuration files within the test resources of this project in the directory

../src/test/resources/configuration

The third component of the configuration are the walk files for the agents as specified in the agent configuration.

This is a basic overview and more information will be provided on the projects Wiki pages.

Contributing

To contribute, use the GitHub way - fork, hack, and submit a pull request!