Create SNMP Client in JAVA Using SNMP4j

Author posted by Jitendra on Posted on under category Categories SNMP and tagged as Tags , with 59 Comments on Create SNMP Client in JAVA Using SNMP4j

Create SNMP Client in JAVA Using SNMP4j

There are lots of open source library for SNMP is available, even java have library for the same,  But in this article I will explain a simple example of using SNMP4j in JAVA to create a simple client which will display the hardware information.

Note : To run this program, SNMP service must be installed. Check this article to know that how to install SNMP in Windows XP.

Download libraries from http://www.snmp4j.org/html/download.html

Create Simple NMS (Network management station / Client) in JAVA using SNMP4j:


package com.G2.SNMP.client;

import java.io.IOException;

import org.snmp4j.CommunityTarget;
import org.snmp4j.PDU;
import org.snmp4j.Snmp;
import org.snmp4j.Target;
import org.snmp4j.TransportMapping;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.smi.Address;
import org.snmp4j.smi.GenericAddress;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.transport.DefaultUdpTransportMapping;

public class SNMPManager {

Snmp snmp = null;
String address = null;

/**
* Constructor
* @param add
*/
public SNMPManager(String add)
{
address = add;
}

public static void main(String[] args) throws IOException {
/**
* Port 161 is used for Read and Other operations
* Port 162 is used for the trap generation
*/
SNMPManager client = new SNMPManager("udp:127.0.0.1/161");
client.start();
/**
* OID - .1.3.6.1.2.1.1.1.0 => SysDec
* OID - .1.3.6.1.2.1.1.5.0 => SysName
* => MIB explorer will be usefull here, as discussed in previous article
*/
String sysDescr = client.getAsString(new OID(".1.3.6.1.2.1.1.1.0"));
System.out.println(sysDescr);
}

/**
* Start the Snmp session. If you forget the listen() method you will not
* get any answers because the communication is asynchronous
* and the listen() method listens for answers.
* @throws IOException
*/
private void start() throws IOException {
TransportMapping transport = new DefaultUdpTransportMapping();
snmp = new Snmp(transport);
// Do not forget this line!
transport.listen();
}

/**
* Method which takes a single OID and returns the response from the agent as a String.
* @param oid
* @return
* @throws IOException
*/
public String getAsString(OID oid) throws IOException {
ResponseEvent event = get(new OID[] { oid });
return event.getResponse().get(0).getVariable().toString();
}

/**
* This method is capable of handling multiple OIDs
* @param oids
* @return
* @throws IOException
*/
public ResponseEvent get(OID oids[]) throws IOException {
PDU pdu = new PDU();
for (OID oid : oids) {
pdu.add(new VariableBinding(oid));
}
pdu.setType(PDU.GET);
ResponseEvent event = snmp.send(pdu, getTarget(), null);
if(event != null) {
return event;
}
throw new RuntimeException("GET timed out");
}

/**
* This method returns a Target, which contains information about
* where the data should be fetched and how.
* @return
*/
private Target getTarget() {
Address targetAddress = GenericAddress.parse(address);
CommunityTarget target = new CommunityTarget();
target.setCommunity(new OctetString("public"));
target.setAddress(targetAddress);
target.setRetries(2);
target.setTimeout(1500);
target.setVersion(SnmpConstants.version2c);
return target;
}

}

Output:

Hardware: x86 Family 6 Model 23 Stepping 10 AT/AT COMPATIBLE – Software: Windows 2000 Version 5.1 (Build 2600 Multiprocessor Free)

Explanation of every method is documented in above program. In Next article, we will write a Java Program to create SNMP Agent.

Related posts

59 thoughts on “Create SNMP Client in JAVA Using SNMP4j”

    1. @ aslary, select your current project, from the menu choose “Project” and opt for properties in the drop down menu. This opens a Project properties window, select the Libraries tab and click “Add external JARs” button.

      1. hi,

        Above code i have to run in my machine (ubuntuOS).following exception is comming any one help me plz iam new from this.

        java.net.BindException: Permission denied
        at java.net.PlainDatagramSocketImpl.bind0(Native Method)
        at java.net.AbstractPlainDatagramSocketImpl.bind(AbstractPlainDatagramSocketImpl.java:85)
        at java.net.DatagramSocket.bind(DatagramSocket.java:373)
        at java.net.DatagramSocket.(DatagramSocket.java:229)
        at java.net.DatagramSocket.(DatagramSocket.java:282)
        at org.snmp4j.transport.DefaultUdpTransportMapping.(DefaultUdpTransportMapping.java:100)
        at com.aurus.SnmpClient.start(SnmpClient.java:40)
        at com.aurus.SnmpClient.(SnmpClient.java:30)
        at com.aurus.SnmpClient.main(SnmpClient.java:60)

        1. sorry ,above is another example code below code is this code pls help me any one..

          Exception in thread “main” org.snmp4j.MessageException: Operation not permitted
          at org.snmp4j.MessageDispatcherImpl.sendPdu(MessageDispatcherImpl.java:526)
          at org.snmp4j.Snmp.sendMessage(Snmp.java:1004)
          at org.snmp4j.Snmp.send(Snmp.java:898)
          at org.snmp4j.Snmp.send(Snmp.java:878)
          at SNMPManager.get(SNMPManager.java:84)
          at SNMPManager.getAsString(SNMPManager.java:68)
          at SNMPManager.main(SNMPManager.java:44)
          Caused by: java.io.IOException: Operation not permitted
          at java.net.PlainDatagramSocketImpl.send(Native Method)
          at java.net.DatagramSocket.send(DatagramSocket.java:629)
          at org.snmp4j.transport.DefaultUdpTransportMapping.sendMessage(DefaultUdpTransportMapping.java:117)
          at org.snmp4j.transport.DefaultUdpTransportMapping.sendMessage(DefaultUdpTransportMapping.java:42)
          at org.snmp4j.MessageDispatcherImpl.sendMessage(MessageDispatcherImpl.java:202)
          at org.snmp4j.MessageDispatcherImpl.sendPdu(MessageDispatcherImpl.java:503)
          … 6 more

  1. hi,
    i know now how to get add an external jar file
    but i get an error ->

    Exception in thread “main” java.lang.NullPointerException
    at SNMPManager.getAsString(SNMPManager.java:69)
    at SNMPManager.main(SNMPManager.java:44)

    69: return event.getResponse().get(0).getVariable().toString();

    help:)

    1. Hi,this is kavya i have the snmp4j jars imported already still i get the error.

      Exception in thread “main” java.lang.NullPointerException
      at SNMPManager.getAsString(SNMPManager.java:41)
      at SNMPManager.main(SNMPManager.java:28)

  2. I am trying to iterate through a variable list of items but am not sure how to implement this, like a get next. I can iterate through my ManagedObjects that I have created with a specific OID but I want to query a group of items (slot numbers) where the base OID is the same and I want to have the query return baseOID.1, baseOID.2,…,baseOID.n

    How can I implement this in SNMP4j – any suggestions?
    Thanks

    1. Hi Cliff,
      You can write your own logic. Create a string which have fixed OID and then every time concatenate number and use line no 45,46 and 47 in loop. Its totally depend on your environment. Please elaborate your need if it does not fulfill answer to your query.

      Thanks,
      Jitendra Zaa

  3. Thanks for the wonderful article. Could you please let us know the things that are required for running this program successfully…like setting params,installing variables,mibs etc.

  4. hi aslary,

    i too had a similar error , i solved it like this:

    in the line:

    target.setCommunity(newOctetString(“public”));

    actually while setting community i had given the community name as demopublic. but here it was public. so i modified the line as follows:

    target.setCommunity(new OctetString(“demopublic”));

  5. Hi RajShekhar,
    Currently i dont have the program for “snmpwalk”, if i will work or get time then definetly post here. If you will be able to resolve then please share with eceryone so that they can also get benefit.

    Regareds,
    Jitendra Zaa

  6. great !! This api is hard to learn, do you have any idea to how change this example for snmp v3 ?

     I’m trying to make a simple GET example using test agent but it always return the same OID ( maybe its a default mib at original test package example )

    What is more strange is that no matter which ones parameters for usm i choose on client… the agent always return the same OID with an incrementing value.

  7. Hi. I have a question for you. If I would like to make a java program that will bind every 1 second a variable to a MIB oid that I’ve created (ex: form interfaces i’ve created ifATR and ifOWD) how can I do it. I would like this program just to bind the variable and every time i send a snmp request(using NETSNMP) to respond with that variable.

  8. Thanks!!

    When I tried run this code, I had the same problem that had “aslary”, but when I change the IP address from 127.0.0.1 to a different one (a server IP address) it works.

    Thank you for the example.

  9. I want to run this code on a remote client I changed 127.0.0.1 to xxx.xxx.xxx.xxx when I run the program it gives me :

    Exception in thread “main” java.lang.NullPointerException
        at SNMPManager.getAsString(SNMPManager.java:74)
        at SNMPManager.main(SNMPManager.java:46)

    1. Hi folks, I had the same issue, and I have solved it checking that smtp service is enabled (seems that the error message cause is related with an exception that is not evaluated when the service is not enabled). Then just check that your service is enabled and well configured.

  10. After sending Get/GetNext request to devices, I closed snmp connection using “snmp.close();”. But when i used TCPView tool to check connections, I found that snmp connection still exist. How to really close snmp connection.?
    Thanks and sorry for my English!

  11. When i run this code it shows an error message:

    Exception in thread “main” java.lang.NullPointerException

    at SNMPManager.getAsString(SNMPManager.java:71)

    at SNMPManager.main(SNMPManager.java:46)

    can you help me please

  12. hello, I hope you can give me your opinion….
    This example could be used for a Network Monitoring System, i hope your answer, and thank you very much…

  13. Hello, i m working on a project of NMS using SNMP protocol. I will develop a android(java based) application, by which i will manage networks devices like routers,switches etc. So can you help me to this coding part of java. I will very thankful to you.

  14. HI Jitendra,
    Could you plz guide how we can load/read/compile our own mibs. i mean how to proceed with our own mibs

  15. HI Jitendra,

    The above program work well, thanks for this.
    Now I want to list all the devices details which are connected in my network, How can I do this??

  16. Hello Jitendra,
    Thanks for the example and it has been very helpful in understanding the snmp4j framework. But i wanted to ask you if this would work for an ipv6 address? if so,then what is the format for the ipv6 address scheme.?
    i tried “udp:[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]/161” but that doesn’t seem to be working. Can you shed some light on this?. Thanks in advance.

  17. Hi Jitendra,
    I am currently working on SNMP monitoring and for now i’m working with localhost

    I’m trying to get CPU and memory usage with SNMP. I have a Java code which takes the oid and runs the “get” command. I can reach the values with MIB-II. However when i import HOST-RESOURCES-MIB in the code i can’t get CPU information it returns Null. But some oids work properly in HOST-RESOURCES-MIB.

    For example:

    hrSystemUpTime(.1.3.6.1.2.1.25.1.1.0) gives me the value 3:51:15.07
    hrProcessorLoad(.1.3.6.1.2.1.25.3.3.1.2.0) gives me the value Null

    What is the problem?

    1. You need to change “SNMPManager” as your class name.
      For e.g
      Public class abc{}
      abc client = new abc(” “);

  18. Windows 10
    Eclipse Helios Service Release 1
    SNMP4J 2.5.11

    Worked like a charm since first run. All I did was changing the ip to my ethernet connected DSE 892 gateway.

    SNMPManager client = new SNMPManager(“udp:127.0.0.1/161”);
    ==>
    SNMPManager client = new SNMPManager(“udp:192.168.1.100/161”);

    Thanks for this great piece of code. Way better than a hundred tutorials.

  19. Hello
    can you help me please
    My project is about Design of an SNMP interface for remote UPS supervision with java

  20. It’s working now…can someone guide me here that how can I get a list of active interfaces from a cisco switch using this program, Is there any oid for retrieving this data from switch..Please help if someone can.. 🙂

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.